diff --git a/modules/brk-client/docs/classes/BrkClient.md b/modules/brk-client/docs/classes/BrkClient.md index fc9ce07c0..bd1f91742 100644 --- a/modules/brk-client/docs/classes/BrkClient.md +++ b/modules/brk-client/docs/classes/BrkClient.md @@ -6,9 +6,9 @@ # Class: BrkClient -Defined in: [Developer/brk/modules/brk-client/index.js:5007](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L5007) +Defined in: [Developer/brk/modules/brk-client/index.js:6359](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6359) -Main BRK client with metrics tree and API methods +Main BRK client with series tree and API methods ## Extends @@ -20,13 +20,13 @@ Main BRK client with metrics tree and API methods > **new BrkClient**(`options`): `BrkClient` -Defined in: [Developer/brk/modules/brk-client/index.js:5924](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L5924) +Defined in: [Developer/brk/modules/brk-client/index.js:7536](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L7536) #### Parameters ##### options -`string` | [`BrkClientOptions`](../interfaces/BrkClientOptions.md) +`string` \| [`BrkClientOptions`](../interfaces/BrkClientOptions.md) #### Returns @@ -42,7 +42,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:5924](https://github.com/ > **\_cache**: `Cache` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:1167](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1167) +Defined in: [Developer/brk/modules/brk-client/index.js:1347](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1347) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1167](https://github.com/ > **\_cachePromise**: `Promise`\<`Cache` \| `null`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1165](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1165) +Defined in: [Developer/brk/modules/brk-client/index.js:1345](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1345) #### Inherited from @@ -62,21 +62,21 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1165](https://github.com/ *** -### metrics +### series -> **metrics**: [`MetricsTree`](../interfaces/MetricsTree.md) +> **series**: [`SeriesTree`](../interfaces/SeriesTree.md) -Defined in: [Developer/brk/modules/brk-client/index.js:5927](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L5927) +Defined in: [Developer/brk/modules/brk-client/index.js:7539](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L7539) ## Methods -### \_fetchMetricData() +### \_fetchSeriesData() -> **\_fetchMetricData**\<`T`\>(`path`, `onUpdate?`): `Promise`\<[`MetricData`](../interfaces/MetricData.md)\<`T`\>\> +> **\_fetchSeriesData**\<`T`\>(`path`, `onUpdate?`): `Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\> -Defined in: [Developer/brk/modules/brk-client/index.js:1257](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1257) +Defined in: [Developer/brk/modules/brk-client/index.js:1435](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1435) -Fetch metric data and wrap with helper methods (internal) +Fetch series data and wrap with helper methods (internal) #### Type Parameters @@ -96,11 +96,39 @@ Fetch metric data and wrap with helper methods (internal) #### Returns -`Promise`\<[`MetricData`](../interfaces/MetricData.md)\<`T`\>\> +`Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\> #### Inherited from -`BrkClientBase._fetchMetricData` +`BrkClientBase._fetchSeriesData` + +*** + +### dateToIndex() + +> **dateToIndex**(`index`, `d`): `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:7528](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L7528) + +Convert a Date to an index value for date-based indexes. + +#### Parameters + +##### index + +[`Index`](../type-aliases/Index.md) + +The index type + +##### d + +`Date` + +The date to convert + +#### Returns + +`number` *** @@ -108,7 +136,7 @@ Fetch metric data and wrap with helper methods (internal) > **get**(`path`): `Promise`\<`Response`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1175](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1175) +Defined in: [Developer/brk/modules/brk-client/index.js:1355](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1355) #### Parameters @@ -128,9 +156,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1175](https://github.com/ ### getAddress() -> **getAddress**(`address`): `Promise`\<[`AddressStats`](../interfaces/AddressStats.md)\> +> **getAddress**(`address`): `Promise`\<[`AddrStats`](../interfaces/AddrStats.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7125](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7125) +Defined in: [Developer/brk/modules/brk-client/index.js:9224](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9224) Address information @@ -148,19 +176,19 @@ Endpoint: `GET /api/address/{address}` #### Returns -`Promise`\<[`AddressStats`](../interfaces/AddressStats.md)\> +`Promise`\<[`AddrStats`](../interfaces/AddrStats.md)\> *** ### getAddressConfirmedTxs() -> **getAddressConfirmedTxs**(`address`, `after_txid?`, `limit?`): `Promise`\<`string`[]\> +> **getAddressConfirmedTxs**(`address`, `after_txid?`): `Promise`\<[`Transaction`](../interfaces/Transaction.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7166](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7166) +Defined in: [Developer/brk/modules/brk-client/index.js:9262](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9262) Address confirmed transactions -Get confirmed transaction IDs for an address, 25 per page. Use ?after_txid= for pagination. +Get confirmed transactions for an address, 25 per page. Use ?after_txid= for pagination. *[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions-chain)* @@ -178,15 +206,9 @@ Endpoint: `GET /api/address/{address}/txs/chain` Txid to paginate from (return transactions before this one) -##### limit? - -`number` - -Maximum number of results to return. Defaults to 25 if not specified. - #### Returns -`Promise`\<`string`[]\> +`Promise`\<[`Transaction`](../interfaces/Transaction.md)[]\> *** @@ -194,7 +216,7 @@ Maximum number of results to return. Defaults to 25 if not specified. > **getAddressMempoolTxs**(`address`): `Promise`\<`string`[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7187](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7187) +Defined in: [Developer/brk/modules/brk-client/index.js:9282](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9282) Address mempool transactions @@ -218,13 +240,13 @@ Endpoint: `GET /api/address/{address}/txs/mempool` ### getAddressTxs() -> **getAddressTxs**(`address`, `after_txid?`, `limit?`): `Promise`\<`string`[]\> +> **getAddressTxs**(`address`, `after_txid?`): `Promise`\<[`Transaction`](../interfaces/Transaction.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7143](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7143) +Defined in: [Developer/brk/modules/brk-client/index.js:9241](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9241) -Address transaction IDs +Address transactions -Get transaction IDs for an address, newest first. Use after_txid for pagination. +Get transaction history for an address, sorted with newest first. Returns up to 50 mempool transactions plus the first 25 confirmed transactions. Use ?after_txid= for pagination. *[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions)* @@ -242,15 +264,9 @@ Endpoint: `GET /api/address/{address}/txs` Txid to paginate from (return transactions before this one) -##### limit? - -`number` - -Maximum number of results to return. Defaults to 25 if not specified. - #### Returns -`Promise`\<`string`[]\> +`Promise`\<[`Transaction`](../interfaces/Transaction.md)[]\> *** @@ -258,7 +274,7 @@ Maximum number of results to return. Defaults to 25 if not specified. > **getAddressUtxos**(`address`): `Promise`\<[`Utxo`](../interfaces/Utxo.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7203](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7203) +Defined in: [Developer/brk/modules/brk-client/index.js:9298](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9298) Address UTXOs @@ -284,7 +300,7 @@ Endpoint: `GET /api/address/{address}/utxo` > **getApi**(): `Promise`\<`any`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7109](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7109) +Defined in: [Developer/brk/modules/brk-client/index.js:9208](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9208) Compact OpenAPI specification @@ -302,7 +318,7 @@ Endpoint: `GET /api.json` > **getBlock**(`hash`): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7235](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7235) +Defined in: [Developer/brk/modules/brk-client/index.js:9330](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9330) Block information @@ -328,7 +344,7 @@ Endpoint: `GET /api/block/{hash}` > **getBlockByHeight**(`height`): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7219](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7219) +Defined in: [Developer/brk/modules/brk-client/index.js:9314](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9314) Block by height @@ -354,7 +370,7 @@ Endpoint: `GET /api/block-height/{height}` > **getBlockByTimestamp**(`timestamp`): `Promise`\<[`BlockTimestamp`](../interfaces/BlockTimestamp.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7813](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7813) +Defined in: [Developer/brk/modules/brk-client/index.js:9985](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9985) Block by timestamp @@ -380,7 +396,7 @@ Endpoint: `GET /api/v1/mining/blocks/timestamp/{timestamp}` > **getBlockFeeRates**(`time_period`): `Promise`\<`any`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7749](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7749) +Defined in: [Developer/brk/modules/brk-client/index.js:9921](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9921) Block fee rates (WIP) @@ -406,7 +422,7 @@ Endpoint: `GET /api/v1/mining/blocks/fee-rates/{time_period}` > **getBlockFees**(`time_period`): `Promise`\<[`BlockFeesEntry`](../interfaces/BlockFeesEntry.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7765](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7765) +Defined in: [Developer/brk/modules/brk-client/index.js:9937](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9937) Block fees @@ -432,7 +448,7 @@ Endpoint: `GET /api/v1/mining/blocks/fees/{time_period}` > **getBlockRaw**(`hash`): `Promise`\<`number`[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7251](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7251) +Defined in: [Developer/brk/modules/brk-client/index.js:9346](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9346) Raw block @@ -458,7 +474,7 @@ Endpoint: `GET /api/block/{hash}/raw` > **getBlockRewards**(`time_period`): `Promise`\<[`BlockRewardsEntry`](../interfaces/BlockRewardsEntry.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7781](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7781) +Defined in: [Developer/brk/modules/brk-client/index.js:9953](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9953) Block rewards @@ -484,7 +500,7 @@ Endpoint: `GET /api/v1/mining/blocks/rewards/{time_period}` > **getBlocks**(): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7331](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7331) +Defined in: [Developer/brk/modules/brk-client/index.js:9426](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9426) Recent blocks @@ -504,7 +520,7 @@ Endpoint: `GET /api/blocks` > **getBlocksFromHeight**(`height`): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7347](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7347) +Defined in: [Developer/brk/modules/brk-client/index.js:9442](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9442) Blocks from height @@ -530,7 +546,7 @@ Endpoint: `GET /api/blocks/{height}` > **getBlockSizesWeights**(`time_period`): `Promise`\<[`BlockSizesWeights`](../interfaces/BlockSizesWeights.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7797](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7797) +Defined in: [Developer/brk/modules/brk-client/index.js:9969](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9969) Block sizes and weights @@ -556,7 +572,7 @@ Endpoint: `GET /api/v1/mining/blocks/sizes-weights/{time_period}` > **getBlockStatus**(`hash`): `Promise`\<[`BlockStatus`](../interfaces/BlockStatus.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7267](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7267) +Defined in: [Developer/brk/modules/brk-client/index.js:9362](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9362) Block status @@ -582,7 +598,7 @@ Endpoint: `GET /api/block/{hash}/status` > **getBlockTxid**(`hash`, `index`): `Promise`\<`string`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7284](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7284) +Defined in: [Developer/brk/modules/brk-client/index.js:9379](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9379) Transaction ID at index @@ -616,7 +632,7 @@ Transaction index within the block (0-based) > **getBlockTxids**(`hash`): `Promise`\<`string`[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7300](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7300) +Defined in: [Developer/brk/modules/brk-client/index.js:9395](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9395) Block transaction IDs @@ -642,7 +658,7 @@ Endpoint: `GET /api/block/{hash}/txids` > **getBlockTxs**(`hash`, `start_index`): `Promise`\<[`Transaction`](../interfaces/Transaction.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7317](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7317) +Defined in: [Developer/brk/modules/brk-client/index.js:9412](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9412) Block transactions (paginated) @@ -676,7 +692,7 @@ Starting transaction index within the block (0-based) > **getCostBasis**(`cohort`, `date`, `bucket?`, `value?`): `Promise`\<`Object`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7520](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7520) +Defined in: [Developer/brk/modules/brk-client/index.js:9572](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9572) Cost basis distribution @@ -686,7 +702,7 @@ Query params: - `bucket`: raw (default), lin200, lin500, lin1000, log10, log50, log100 - `value`: supply (default, in BTC), realized (USD), unrealized (USD) -Endpoint: `GET /api/metrics/cost-basis/{cohort}/{date}` +Endpoint: `GET /api/series/cost-basis/{cohort}/{date}` #### Parameters @@ -720,13 +736,13 @@ Value type to return. Default: supply. > **getCostBasisCohorts**(): `Promise`\<`string`[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7485](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7485) +Defined in: [Developer/brk/modules/brk-client/index.js:9537](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9537) Available cost basis cohorts List available cohorts for cost basis distribution. -Endpoint: `GET /api/metrics/cost-basis` +Endpoint: `GET /api/series/cost-basis` #### Returns @@ -738,13 +754,13 @@ Endpoint: `GET /api/metrics/cost-basis` > **getCostBasisDates**(`cohort`): `Promise`\<`number`[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7499](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7499) +Defined in: [Developer/brk/modules/brk-client/index.js:9551](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9551) Available cost basis dates List available dates for a cohort's cost basis distribution. -Endpoint: `GET /api/metrics/cost-basis/{cohort}/dates` +Endpoint: `GET /api/series/cost-basis/{cohort}/dates` #### Parameters @@ -762,7 +778,7 @@ Endpoint: `GET /api/metrics/cost-basis/{cohort}/dates` > **getDifficultyAdjustment**(): `Promise`\<[`DifficultyAdjustment`](../interfaces/DifficultyAdjustment.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7705](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7705) +Defined in: [Developer/brk/modules/brk-client/index.js:9877](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9877) Difficulty adjustment @@ -782,7 +798,7 @@ Endpoint: `GET /api/v1/difficulty-adjustment` > **getDifficultyAdjustments**(): `Promise`\<[`DifficultyAdjustmentEntry`](../interfaces/DifficultyAdjustmentEntry.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7827](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7827) +Defined in: [Developer/brk/modules/brk-client/index.js:9999](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9999) Difficulty adjustments (all time) @@ -802,7 +818,7 @@ Endpoint: `GET /api/v1/mining/difficulty-adjustments` > **getDifficultyAdjustmentsByPeriod**(`time_period`): `Promise`\<[`DifficultyAdjustmentEntry`](../interfaces/DifficultyAdjustmentEntry.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7843](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7843) +Defined in: [Developer/brk/modules/brk-client/index.js:10015](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10015) Difficulty adjustments @@ -828,7 +844,7 @@ Endpoint: `GET /api/v1/mining/difficulty-adjustments/{time_period}` > **getDiskUsage**(): `Promise`\<[`DiskUsage`](../interfaces/DiskUsage.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7598](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7598) +Defined in: [Developer/brk/modules/brk-client/index.js:9770](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9770) Disk usage @@ -846,7 +862,7 @@ Endpoint: `GET /api/server/disk` > **getHashrate**(): `Promise`\<[`HashrateSummary`](../interfaces/HashrateSummary.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7857](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7857) +Defined in: [Developer/brk/modules/brk-client/index.js:10029](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10029) Network hashrate (all time) @@ -866,7 +882,7 @@ Endpoint: `GET /api/v1/mining/hashrate` > **getHashrateByPeriod**(`time_period`): `Promise`\<[`HashrateSummary`](../interfaces/HashrateSummary.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7873](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7873) +Defined in: [Developer/brk/modules/brk-client/index.js:10045](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10045) Network hashrate @@ -892,7 +908,7 @@ Endpoint: `GET /api/v1/mining/hashrate/{time_period}` > **getHealth**(): `Promise`\<[`Health`](../interfaces/Health.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7963](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7963) +Defined in: [Developer/brk/modules/brk-client/index.js:10135](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10135) Health check @@ -910,13 +926,13 @@ Endpoint: `GET /health` > **getIndexes**(): `Promise`\<[`IndexInfo`](../interfaces/IndexInfo.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7549](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7549) +Defined in: [Developer/brk/modules/brk-client/index.js:9601](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9601) List available indexes -Returns all available indexes with their accepted query aliases. Use any alias when querying metrics. +Returns all available indexes with their accepted query aliases. Use any alias when querying series. -Endpoint: `GET /api/metrics/indexes` +Endpoint: `GET /api/series/indexes` #### Returns @@ -928,7 +944,7 @@ Endpoint: `GET /api/metrics/indexes` > **getJson**\<`T`\>(`path`, `onUpdate?`): `Promise`\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1190](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1190) +Defined in: [Developer/brk/modules/brk-client/index.js:1369](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1369) Make a GET request - races cache vs network, first to resolve calls onUpdate @@ -964,7 +980,7 @@ Called when data is available (may be called twice: cache then network) > **getLivePrice**(): `Promise`\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7373](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7373) +Defined in: [Developer/brk/modules/brk-client/index.js:9468](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9468) Live BTC/USD price @@ -982,7 +998,7 @@ Endpoint: `GET /api/mempool/price` > **getMempool**(): `Promise`\<[`MempoolInfo`](../interfaces/MempoolInfo.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7361](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7361) +Defined in: [Developer/brk/modules/brk-client/index.js:9456](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9456) Mempool statistics @@ -1002,7 +1018,7 @@ Endpoint: `GET /api/mempool/info` > **getMempoolBlocks**(): `Promise`\<[`MempoolBlock`](../interfaces/MempoolBlock.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7719](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7719) +Defined in: [Developer/brk/modules/brk-client/index.js:9891](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9891) Projected mempool blocks @@ -1022,7 +1038,7 @@ Endpoint: `GET /api/v1/fees/mempool-blocks` > **getMempoolTxids**(): `Promise`\<`string`[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7387](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7387) +Defined in: [Developer/brk/modules/brk-client/index.js:9482](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9482) Mempool transaction IDs @@ -1038,183 +1054,11 @@ Endpoint: `GET /api/mempool/txids` *** -### getMetric() - -> **getMetric**(`metric`, `index`, `start?`, `end?`, `limit?`, `format?`): `Promise`\<`string` \| [`AnyMetricData`](../type-aliases/AnyMetricData.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7420](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7420) - -Get metric data - -Fetch data for a specific metric at the given index. Use query parameters to filter by date range and format (json/csv). - -Endpoint: `GET /api/metric/{metric}/{index}` - -#### Parameters - -##### metric - -`string` - -Metric name - -##### index - -[`Index`](../type-aliases/Index.md) - -Aggregation index - -##### start? - -`number` - -Inclusive starting index, if negative counts from end - -##### end? - -`number` - -Exclusive ending index, if negative counts from end - -##### limit? - -`string` - -Maximum number of values to return (ignored if `end` is set) - -##### format? - -[`Format`](../type-aliases/Format.md) - -Format of the output - -#### Returns - -`Promise`\<`string` \| [`AnyMetricData`](../type-aliases/AnyMetricData.md)\> - -*** - -### getMetricInfo() - -> **getMetricInfo**(`metric`): `Promise`\<[`Index`](../type-aliases/Index.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7401](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7401) - -Get supported indexes for a metric - -Returns the list of indexes supported by the specified metric. For example, `realized_price` might be available on dateindex, weekindex, and monthindex. - -Endpoint: `GET /api/metric/{metric}` - -#### Parameters - -##### metric - -`string` - -#### Returns - -`Promise`\<[`Index`](../type-aliases/Index.md)[]\> - -*** - -### getMetrics() - -> **getMetrics**(`metrics?`, `index?`, `start?`, `end?`, `limit?`, `format?`): `Promise`\<`string` \| [`AnyMetricData`](../type-aliases/AnyMetricData.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7461](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7461) - -Bulk metric data - -Fetch multiple metrics in a single request. Supports filtering by index and date range. Returns an array of MetricData objects. For a single metric, use `get_metric` instead. - -Endpoint: `GET /api/metrics/bulk` - -#### Parameters - -##### metrics? - -`string` - -Requested metrics - -##### index? - -[`Index`](../type-aliases/Index.md) - -Index to query - -##### start? - -`number` - -Inclusive starting index, if negative counts from end - -##### end? - -`number` - -Exclusive ending index, if negative counts from end - -##### limit? - -`string` - -Maximum number of values to return (ignored if `end` is set) - -##### format? - -[`Format`](../type-aliases/Format.md) - -Format of the output - -#### Returns - -`Promise`\<`string` \| [`AnyMetricData`](../type-aliases/AnyMetricData.md)[]\> - -*** - -### getMetricsCount() - -> **getMetricsCount**(): `Promise`\<[`MetricCount`](../interfaces/MetricCount.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7537](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7537) - -Metric count - -Returns the number of metrics available per index type. - -Endpoint: `GET /api/metrics/count` - -#### Returns - -`Promise`\<[`MetricCount`](../interfaces/MetricCount.md)[]\> - -*** - -### getMetricsTree() - -> **getMetricsTree**(): `Promise`\<[`TreeNode`](../type-aliases/TreeNode.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7442](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7442) - -Metrics catalog - -Returns the complete hierarchical catalog of available metrics organized as a tree structure. Metrics are grouped by categories and subcategories. - -Endpoint: `GET /api/metrics` - -#### Returns - -`Promise`\<[`TreeNode`](../type-aliases/TreeNode.md)\> - -*** - ### getOpenapi() > **getOpenapi**(): `Promise`\<`any`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7975](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7975) +Defined in: [Developer/brk/modules/brk-client/index.js:10147](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10147) OpenAPI specification @@ -1232,7 +1076,7 @@ Endpoint: `GET /openapi.json` > **getPool**(`slug`): `Promise`\<[`PoolDetail`](../interfaces/PoolDetail.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7889](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7889) +Defined in: [Developer/brk/modules/brk-client/index.js:10061](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10061) Mining pool details @@ -1258,7 +1102,7 @@ Endpoint: `GET /api/v1/mining/pool/{slug}` > **getPools**(): `Promise`\<[`PoolInfo`](../interfaces/PoolInfo.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7903](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7903) +Defined in: [Developer/brk/modules/brk-client/index.js:10075](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10075) List all mining pools @@ -1278,7 +1122,7 @@ Endpoint: `GET /api/v1/mining/pools` > **getPoolStats**(`time_period`): `Promise`\<[`PoolsSummary`](../interfaces/PoolsSummary.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7919](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7919) +Defined in: [Developer/brk/modules/brk-client/index.js:10091](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10091) Mining pool statistics @@ -1304,7 +1148,7 @@ Endpoint: `GET /api/v1/mining/pools/{time_period}` > **getRecommendedFees**(): `Promise`\<[`RecommendedFees`](../interfaces/RecommendedFees.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7733](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7733) +Defined in: [Developer/brk/modules/brk-client/index.js:9905](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9905) Recommended fees @@ -1324,7 +1168,7 @@ Endpoint: `GET /api/v1/fees/recommended` > **getRewardStats**(`block_count`): `Promise`\<[`RewardStats`](../interfaces/RewardStats.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7935](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7935) +Defined in: [Developer/brk/modules/brk-client/index.js:10107](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10107) Mining reward statistics @@ -1348,11 +1192,335 @@ Number of recent blocks to include *** +### getSeries() + +> **getSeries**(`series`, `index`, `start?`, `end?`, `limit?`, `format?`): `Promise`\<`string` \| [`AnySeriesData`](../type-aliases/AnySeriesData.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:9674](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9674) + +Get series data + +Fetch data for a specific series at the given index. Use query parameters to filter by date range and format (json/csv). + +Endpoint: `GET /api/series/{series}/{index}` + +#### Parameters + +##### series + +`string` + +Series name + +##### index + +[`Index`](../type-aliases/Index.md) + +Aggregation index + +##### start? + +`number` + +Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s` + +##### end? + +`number` + +Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `to`, `t`, `e` + +##### limit? + +`number` + +Maximum number of values to return (ignored if `end` is set). Aliases: `count`, `c`, `l` + +##### format? + +[`Format`](../type-aliases/Format.md) + +Format of the output + +#### Returns + +`Promise`\<`string` \| [`AnySeriesData`](../type-aliases/AnySeriesData.md)\> + +*** + +### getSeriesBulk() + +> **getSeriesBulk**(`series?`, `index?`, `start?`, `end?`, `limit?`, `format?`): `Promise`\<`string` \| [`AnySeriesData`](../type-aliases/AnySeriesData.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:9513](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9513) + +Bulk series data + +Fetch multiple series in a single request. Supports filtering by index and date range. Returns an array of SeriesData objects. For a single series, use `get_series` instead. + +Endpoint: `GET /api/series/bulk` + +#### Parameters + +##### series? + +`string` + +Requested series + +##### index? + +[`Index`](../type-aliases/Index.md) + +Index to query + +##### start? + +`number` + +Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s` + +##### end? + +`number` + +Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `to`, `t`, `e` + +##### limit? + +`number` + +Maximum number of values to return (ignored if `end` is set). Aliases: `count`, `c`, `l` + +##### format? + +[`Format`](../type-aliases/Format.md) + +Format of the output + +#### Returns + +`Promise`\<`string` \| [`AnySeriesData`](../type-aliases/AnySeriesData.md)[]\> + +*** + +### getSeriesCount() + +> **getSeriesCount**(): `Promise`\<[`SeriesCount`](../interfaces/SeriesCount.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:9589](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9589) + +Series count + +Returns the number of series available per index type. + +Endpoint: `GET /api/series/count` + +#### Returns + +`Promise`\<[`SeriesCount`](../interfaces/SeriesCount.md)[]\> + +*** + +### getSeriesData() + +> **getSeriesData**(`series`, `index`, `start?`, `end?`, `limit?`, `format?`): `Promise`\<`string` \| `boolean`[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:9703](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9703) + +Get raw series data + +Returns just the data array without the SeriesData wrapper. Supports the same range and format parameters as the standard endpoint. + +Endpoint: `GET /api/series/{series}/{index}/data` + +#### Parameters + +##### series + +`string` + +Series name + +##### index + +[`Index`](../type-aliases/Index.md) + +Aggregation index + +##### start? + +`number` + +Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s` + +##### end? + +`number` + +Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `to`, `t`, `e` + +##### limit? + +`number` + +Maximum number of values to return (ignored if `end` is set). Aliases: `count`, `c`, `l` + +##### format? + +[`Format`](../type-aliases/Format.md) + +Format of the output + +#### Returns + +`Promise`\<`string` \| `boolean`[]\> + +*** + +### getSeriesInfo() + +> **getSeriesInfo**(`series`): `Promise`\<[`SeriesInfo`](../interfaces/SeriesInfo.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:9655](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9655) + +Get series info + +Returns the supported indexes and value type for the specified series. + +Endpoint: `GET /api/series/{series}` + +#### Parameters + +##### series + +`string` + +#### Returns + +`Promise`\<[`SeriesInfo`](../interfaces/SeriesInfo.md)\> + +*** + +### getSeriesLatest() + +> **getSeriesLatest**(`series`, `index`): `Promise`\<`any`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:9728](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9728) + +Get latest series value + +Returns the single most recent value for a series, unwrapped (not inside a SeriesData object). + +Endpoint: `GET /api/series/{series}/{index}/latest` + +#### Parameters + +##### series + +`string` + +Series name + +##### index + +[`Index`](../type-aliases/Index.md) + +Aggregation index + +#### Returns + +`Promise`\<`any`\> + +*** + +### getSeriesLen() + +> **getSeriesLen**(`series`, `index`): `Promise`\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:9743](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9743) + +Get series data length + +Returns the total number of data points for a series at the given index. + +Endpoint: `GET /api/series/{series}/{index}/len` + +#### Parameters + +##### series + +`string` + +Series name + +##### index + +[`Index`](../type-aliases/Index.md) + +Aggregation index + +#### Returns + +`Promise`\<`number`\> + +*** + +### getSeriesTree() + +> **getSeriesTree**(): `Promise`\<[`TreeNode`](../type-aliases/TreeNode.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:9494](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9494) + +Series catalog + +Returns the complete hierarchical catalog of available series organized as a tree structure. Series are grouped by categories and subcategories. + +Endpoint: `GET /api/series` + +#### Returns + +`Promise`\<[`TreeNode`](../type-aliases/TreeNode.md)\> + +*** + +### getSeriesVersion() + +> **getSeriesVersion**(`series`, `index`): `Promise`\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:9758](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9758) + +Get series version + +Returns the current version of a series. Changes when the series data is updated. + +Endpoint: `GET /api/series/{series}/{index}/version` + +#### Parameters + +##### series + +`string` + +Series name + +##### index + +[`Index`](../type-aliases/Index.md) + +Aggregation index + +#### Returns + +`Promise`\<`number`\> + +*** + ### getSyncStatus() > **getSyncStatus**(): `Promise`\<[`SyncStatus`](../interfaces/SyncStatus.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7610](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7610) +Defined in: [Developer/brk/modules/brk-client/index.js:9782](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9782) Sync status @@ -1370,7 +1538,7 @@ Endpoint: `GET /api/server/sync` > **getText**(`path`): `Promise`\<`string`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1245](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1245) +Defined in: [Developer/brk/modules/brk-client/index.js:1423](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1423) Make a GET request and return raw text (for CSV responses) @@ -1394,7 +1562,7 @@ Make a GET request and return raw text (for CSV responses) > **getTx**(`txid`): `Promise`\<[`Transaction`](../interfaces/Transaction.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7626](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7626) +Defined in: [Developer/brk/modules/brk-client/index.js:9798](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9798) Transaction information @@ -1420,7 +1588,7 @@ Endpoint: `GET /api/tx/{txid}` > **getTxHex**(`txid`): `Promise`\<`string`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7642](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7642) +Defined in: [Developer/brk/modules/brk-client/index.js:9814](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9814) Transaction hex @@ -1446,7 +1614,7 @@ Endpoint: `GET /api/tx/{txid}/hex` > **getTxOutspend**(`txid`, `vout`): `Promise`\<[`TxOutspend`](../interfaces/TxOutspend.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7659](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7659) +Defined in: [Developer/brk/modules/brk-client/index.js:9831](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9831) Output spend status @@ -1480,7 +1648,7 @@ Output index > **getTxOutspends**(`txid`): `Promise`\<[`TxOutspend`](../interfaces/TxOutspend.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7675](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7675) +Defined in: [Developer/brk/modules/brk-client/index.js:9847](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9847) All output spend statuses @@ -1506,7 +1674,7 @@ Endpoint: `GET /api/tx/{txid}/outspends` > **getTxStatus**(`txid`): `Promise`\<[`TxStatus`](../interfaces/TxStatus.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7691](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7691) +Defined in: [Developer/brk/modules/brk-client/index.js:9863](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9863) Transaction status @@ -1532,7 +1700,7 @@ Endpoint: `GET /api/tx/{txid}/status` > **getVersion**(): `Promise`\<`string`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7987](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7987) +Defined in: [Developer/brk/modules/brk-client/index.js:10159](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10159) API version @@ -1550,7 +1718,7 @@ Endpoint: `GET /version` > **indexToDate**(`index`, `i`): `Date` -Defined in: [Developer/brk/modules/brk-client/index.js:5908](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L5908) +Defined in: [Developer/brk/modules/brk-client/index.js:7518](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L7518) Convert an index value to a Date for date-based indexes. @@ -1574,37 +1742,17 @@ The index value *** -### isDateIndex() +### listSeries() -> **isDateIndex**(`index`): `boolean` +> **listSeries**(`page?`, `per_page?`): `Promise`\<[`PaginatedSeries`](../interfaces/PaginatedSeries.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:5917](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L5917) +Defined in: [Developer/brk/modules/brk-client/index.js:9616](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9616) -Check if an index type is date-based. +Series list -#### Parameters +Paginated flat list of all available series names. Use `page` query param for pagination. -##### index - -[`Index`](../type-aliases/Index.md) - -#### Returns - -`boolean` - -*** - -### listMetrics() - -> **listMetrics**(`page?`): `Promise`\<[`PaginatedMetrics`](../interfaces/PaginatedMetrics.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7563](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7563) - -Metrics list - -Paginated flat list of all available metric names. Use `page` query param for pagination. - -Endpoint: `GET /api/metrics/list` +Endpoint: `GET /api/series/list` #### Parameters @@ -1614,30 +1762,68 @@ Endpoint: `GET /api/metrics/list` Pagination index +##### per\_page? + +`number` + +Results per page (default: 1000, max: 1000) + #### Returns -`Promise`\<[`PaginatedMetrics`](../interfaces/PaginatedMetrics.md)\> +`Promise`\<[`PaginatedSeries`](../interfaces/PaginatedSeries.md)\> *** -### metric() +### searchSeries() -> **metric**(`metric`, `index`): [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`unknown`\> +> **searchSeries**(`q?`, `limit?`): `Promise`\<`string`[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7097](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7097) +Defined in: [Developer/brk/modules/brk-client/index.js:9636](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9636) -Create a dynamic metric endpoint builder for any metric/index combination. +Search series -Use this for programmatic access when the metric name is determined at runtime. -For type-safe access, use the `metrics` tree instead. +Fuzzy search for series by name. Supports partial matches and typos. + +Endpoint: `GET /api/series/search` #### Parameters -##### metric +##### q? `string` -The metric name +Search query string + +##### limit? + +`number` + +Maximum number of results + +#### Returns + +`Promise`\<`string`[]\> + +*** + +### seriesEndpoint() + +> **seriesEndpoint**(`series`, `index`): [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`unknown`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:9196](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9196) + +Create a dynamic series endpoint builder for any series/index combination. + +Use this for programmatic access when the series name is determined at runtime. +For type-safe access, use the `series` tree instead. + +#### Parameters + +##### series + +`string` + +The series name ##### index @@ -1647,43 +1833,15 @@ The index name #### Returns -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`unknown`\> - -*** - -### searchMetrics() - -> **searchMetrics**(`metric`, `limit?`): `Promise`\<`string`[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7582](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7582) - -Search metrics - -Fuzzy search for metrics by name. Supports partial matches and typos. - -Endpoint: `GET /api/metrics/search/{metric}` - -#### Parameters - -##### metric - -`string` - -##### limit? - -`number` - -#### Returns - -`Promise`\<`string`[]\> +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`unknown`\> *** ### validateAddress() -> **validateAddress**(`address`): `Promise`\<[`AddressValidation`](../interfaces/AddressValidation.md)\> +> **validateAddress**(`address`): `Promise`\<[`AddrValidation`](../interfaces/AddrValidation.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7951](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L7951) +Defined in: [Developer/brk/modules/brk-client/index.js:10123](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L10123) Validate address @@ -1703,4 +1861,4 @@ Bitcoin address to validate (can be any string) #### Returns -`Promise`\<[`AddressValidation`](../interfaces/AddressValidation.md)\> +`Promise`\<[`AddrValidation`](../interfaces/AddrValidation.md)\> diff --git a/modules/brk-client/docs/classes/BrkError.md b/modules/brk-client/docs/classes/BrkError.md index c893737b6..8f7da0f15 100644 --- a/modules/brk-client/docs/classes/BrkError.md +++ b/modules/brk-client/docs/classes/BrkError.md @@ -6,7 +6,7 @@ # Class: BrkError -Defined in: [Developer/brk/modules/brk-client/index.js:892](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L892) +Defined in: [Developer/brk/modules/brk-client/index.js:999](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L999) Custom error class for BRK client errors @@ -20,7 +20,7 @@ Custom error class for BRK client errors > **new BrkError**(`message`, `status?`): `BrkError` -Defined in: [Developer/brk/modules/brk-client/index.js:897](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L897) +Defined in: [Developer/brk/modules/brk-client/index.js:1004](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1004) #### Parameters diff --git a/modules/brk-client/docs/globals.md b/modules/brk-client/docs/globals.md index b52856cf3..a2247702b 100644 --- a/modules/brk-client/docs/globals.md +++ b/modules/brk-client/docs/globals.md @@ -11,223 +11,156 @@ ## Interfaces -- [\_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern](interfaces/0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md) +- [\_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern](interfaces/0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern.md) - [\_10y1m1w1y2y3m3y4y5y6m6y8yPattern2](interfaces/10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md) - [\_10y1m1w1y2y3m3y4y5y6m6y8yPattern3](interfaces/10y1m1w1y2y3m3y4y5y6m6y8yPattern3.md) - [\_10y2y3y4y5y6y8yPattern](interfaces/10y2y3y4y5y6y8yPattern.md) -- [\_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern](interfaces/1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) -- [\_201520162017201820192020202120222023202420252026Pattern2](interfaces/201520162017201820192020202120222023202420252026Pattern2.md) -- [\_30dCountPattern](interfaces/30dCountPattern.md) -- [\_30dHalvedTotalPattern](interfaces/30dHalvedTotalPattern.md) -- [ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern](interfaces/ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) -- [ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern](interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) -- [ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3](interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) -- [ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4](interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) -- [ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5](interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) -- [ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6](interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) -- [ActivityCostOutputsRealizedSupplyUnrealizedPattern](interfaces/ActivityCostOutputsRealizedSupplyUnrealizedPattern.md) -- [AddressChainStats](interfaces/AddressChainStats.md) -- [AddressMempoolStats](interfaces/AddressMempoolStats.md) -- [AddressParam](interfaces/AddressParam.md) -- [AddressStats](interfaces/AddressStats.md) -- [AddressTxidsParam](interfaces/AddressTxidsParam.md) -- [AddressValidation](interfaces/AddressValidation.md) -- [AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern](interfaces/AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md) -- [AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2](interfaces/AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md) -- [AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern](interfaces/AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern.md) +- [\_1m1w1y24hBlockPattern](interfaces/1m1w1y24hBlockPattern.md) +- [\_1m1w1y24hBpsPercentRatioPattern](interfaces/1m1w1y24hBpsPercentRatioPattern.md) +- [\_1m1w1y24hPattern](interfaces/1m1w1y24hPattern.md) +- [\_1m1w1y24hPattern2](interfaces/1m1w1y24hPattern2.md) +- [\_1m1w1y24hPattern3](interfaces/1m1w1y24hPattern3.md) +- [\_1m1w1y24hPattern4](interfaces/1m1w1y24hPattern4.md) +- [\_1m1w1y24hPattern5](interfaces/1m1w1y24hPattern5.md) +- [\_1m1w1y24hPattern6](interfaces/1m1w1y24hPattern6.md) +- [\_1m1w1y24hPattern7](interfaces/1m1w1y24hPattern7.md) +- [\_1m1w1y2wPattern](interfaces/1m1w1y2wPattern.md) +- [\_1m1w1y2y4yAllPattern](interfaces/1m1w1y2y4yAllPattern.md) +- [\_1y2y4yAllPattern](interfaces/1y2y4yAllPattern.md) +- [\_24hPattern](interfaces/24hPattern.md) +- [\_6bBlockTxPattern](interfaces/6bBlockTxPattern.md) +- [AbsoluteRatePattern](interfaces/AbsoluteRatePattern.md) +- [AbsoluteRatePattern2](interfaces/AbsoluteRatePattern2.md) +- [ActivityAddrOutputsRealizedSupplyUnrealizedPattern](interfaces/ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) +- [ActivityOutputsRealizedSupplyUnrealizedPattern](interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern.md) +- [ActivityOutputsRealizedSupplyUnrealizedPattern2](interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern2.md) +- [ActivityOutputsRealizedSupplyUnrealizedPattern3](interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern3.md) +- [AddrChainStats](interfaces/AddrChainStats.md) +- [AddrMempoolStats](interfaces/AddrMempoolStats.md) +- [AddrParam](interfaces/AddrParam.md) +- [AddrStats](interfaces/AddrStats.md) +- [AddrTxidsParam](interfaces/AddrTxidsParam.md) +- [AddrValidation](interfaces/AddrValidation.md) +- [AdjustedRatioValuePattern](interfaces/AdjustedRatioValuePattern.md) +- [AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3](interfaces/AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3.md) +- [AllSthPattern](interfaces/AllSthPattern.md) +- [AllSthPattern2](interfaces/AllSthPattern2.md) - [AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern](interfaces/AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md) -- [AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2](interfaces/AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md) -- [AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern](interfaces/AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md) -- [AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2](interfaces/AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md) -- [AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern](interfaces/AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern.md) -- [BalanceBothReactivatedReceivingSendingPattern](interfaces/BalanceBothReactivatedReceivingSendingPattern.md) -- [BaseCumulativeSumPattern](interfaces/BaseCumulativeSumPattern.md) -- [BitcoinDollarsSatsPattern2](interfaces/BitcoinDollarsSatsPattern2.md) -- [BitcoinDollarsSatsPattern3](interfaces/BitcoinDollarsSatsPattern3.md) -- [BitcoinDollarsSatsPattern4](interfaces/BitcoinDollarsSatsPattern4.md) -- [BitcoinDollarsSatsPattern5](interfaces/BitcoinDollarsSatsPattern5.md) -- [BitcoinDollarsSatsPattern6](interfaces/BitcoinDollarsSatsPattern6.md) +- [AverageBlockCumulativeInSumPattern](interfaces/AverageBlockCumulativeInSumPattern.md) +- [AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern](interfaces/AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md) +- [AverageBlockCumulativeSumPattern](interfaces/AverageBlockCumulativeSumPattern.md) +- [AverageBlockCumulativeSumPattern2](interfaces/AverageBlockCumulativeSumPattern2.md) +- [AverageBlockCumulativeSumPattern3](interfaces/AverageBlockCumulativeSumPattern3.md) +- [AverageMaxMedianMinPct10Pct25Pct75Pct90SumPattern](interfaces/AverageMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md) +- [BaseDeltaPattern](interfaces/BaseDeltaPattern.md) +- [BaseSumPattern](interfaces/BaseSumPattern.md) +- [BlockChangeCumulativeDeltaSumPattern](interfaces/BlockChangeCumulativeDeltaSumPattern.md) - [BlockCountParam](interfaces/BlockCountParam.md) +- [BlockCumulativeDeltaSumPattern](interfaces/BlockCumulativeDeltaSumPattern.md) +- [BlockCumulativeNegativeSumPattern](interfaces/BlockCumulativeNegativeSumPattern.md) +- [BlockCumulativePattern](interfaces/BlockCumulativePattern.md) +- [BlockCumulativeSumPattern](interfaces/BlockCumulativeSumPattern.md) - [BlockFeesEntry](interfaces/BlockFeesEntry.md) - [BlockHashParam](interfaces/BlockHashParam.md) - [BlockHashStartIndex](interfaces/BlockHashStartIndex.md) - [BlockHashTxIndex](interfaces/BlockHashTxIndex.md) - [BlockInfo](interfaces/BlockInfo.md) - [BlockRewardsEntry](interfaces/BlockRewardsEntry.md) +- [BlocksDominancePattern](interfaces/BlocksDominancePattern.md) +- [BlocksDominanceRewardsPattern](interfaces/BlocksDominanceRewardsPattern.md) - [BlockSizeEntry](interfaces/BlockSizeEntry.md) - [BlockSizesWeights](interfaces/BlockSizesWeights.md) - [BlockStatus](interfaces/BlockStatus.md) - [BlockTimestamp](interfaces/BlockTimestamp.md) - [BlockWeightEntry](interfaces/BlockWeightEntry.md) +- [BothReactivatedReceivingSendingPattern](interfaces/BothReactivatedReceivingSendingPattern.md) +- [BpsCentsPercentilesRatioSatsSmaStdUsdPattern](interfaces/BpsCentsPercentilesRatioSatsSmaStdUsdPattern.md) +- [BpsCentsPercentilesRatioSatsUsdPattern](interfaces/BpsCentsPercentilesRatioSatsUsdPattern.md) +- [BpsCentsRatioSatsUsdPattern](interfaces/BpsCentsRatioSatsUsdPattern.md) +- [BpsPercentRatioPattern](interfaces/BpsPercentRatioPattern.md) +- [BpsPercentRatioPattern3](interfaces/BpsPercentRatioPattern3.md) +- [BpsPercentRatioPattern4](interfaces/BpsPercentRatioPattern4.md) +- [BpsPercentRatioPattern5](interfaces/BpsPercentRatioPattern5.md) +- [BpsPriceRatioPattern](interfaces/BpsPriceRatioPattern.md) +- [BpsRatioPattern](interfaces/BpsRatioPattern.md) +- [BpsRatioPattern2](interfaces/BpsRatioPattern2.md) - [BrkClientOptions](interfaces/BrkClientOptions.md) -- [CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern](interfaces/CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md) -- [CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2](interfaces/CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md) -- [CloseHighLowOpenPattern2](interfaces/CloseHighLowOpenPattern2.md) -- [CoinblocksCoindaysSatblocksSatdaysSentPattern](interfaces/CoinblocksCoindaysSatblocksSatdaysSentPattern.md) +- [BtcCentsDeltaSatsUsdPattern](interfaces/BtcCentsDeltaSatsUsdPattern.md) +- [BtcCentsSatsToUsdPattern](interfaces/BtcCentsSatsToUsdPattern.md) +- [BtcCentsSatsToUsdPattern2](interfaces/BtcCentsSatsToUsdPattern2.md) +- [BtcCentsSatsToUsdPattern3](interfaces/BtcCentsSatsToUsdPattern3.md) +- [BtcCentsSatsUsdPattern](interfaces/BtcCentsSatsUsdPattern.md) +- [BtcCentsSatsUsdPattern2](interfaces/BtcCentsSatsUsdPattern2.md) +- [BtcCentsSatsUsdPattern3](interfaces/BtcCentsSatsUsdPattern3.md) +- [CapGrossInvestorLossMvrvNetPeakPriceProfitSellSoprPattern](interfaces/CapGrossInvestorLossMvrvNetPeakPriceProfitSellSoprPattern.md) +- [CapLossMvrvNetPriceProfitSoprPattern](interfaces/CapLossMvrvNetPriceProfitSoprPattern.md) +- [CapLossMvrvPriceProfitPattern](interfaces/CapLossMvrvPriceProfitPattern.md) +- [CentsDeltaToUsdPattern](interfaces/CentsDeltaToUsdPattern.md) +- [CentsDeltaUsdPattern](interfaces/CentsDeltaUsdPattern.md) +- [CentsNegativeToUsdPattern2](interfaces/CentsNegativeToUsdPattern2.md) +- [CentsNegativeUsdPattern](interfaces/CentsNegativeUsdPattern.md) +- [CentsSatsUsdPattern](interfaces/CentsSatsUsdPattern.md) +- [CentsSatsUsdPattern3](interfaces/CentsSatsUsdPattern3.md) +- [CentsToUsdPattern3](interfaces/CentsToUsdPattern3.md) +- [CentsToUsdPattern4](interfaces/CentsToUsdPattern4.md) +- [CentsUsdPattern](interfaces/CentsUsdPattern.md) +- [CentsUsdPattern2](interfaces/CentsUsdPattern2.md) +- [CentsUsdPattern3](interfaces/CentsUsdPattern3.md) +- [CentsUsdPattern4](interfaces/CentsUsdPattern4.md) +- [CoindaysCoinyearsDormancyTransferPattern](interfaces/CoindaysCoinyearsDormancyTransferPattern.md) +- [CoindaysTransferPattern](interfaces/CoindaysTransferPattern.md) - [CostBasisCohortParam](interfaces/CostBasisCohortParam.md) - [CostBasisParams](interfaces/CostBasisParams.md) - [CostBasisQuery](interfaces/CostBasisQuery.md) -- [CumulativeSumPattern](interfaces/CumulativeSumPattern.md) -- [CumulativeSumPattern2](interfaces/CumulativeSumPattern2.md) +- [CumulativeRollingSumPattern](interfaces/CumulativeRollingSumPattern.md) - [DataRangeFormat](interfaces/DataRangeFormat.md) +- [DateRangeBuilder](interfaces/DateRangeBuilder.md) +- [DateSeriesDataExtras](interfaces/DateSeriesDataExtras.md) +- [DateSeriesEndpoint](interfaces/DateSeriesEndpoint.md) +- [DateSingleItemBuilder](interfaces/DateSingleItemBuilder.md) +- [DateSkippedBuilder](interfaces/DateSkippedBuilder.md) +- [DeltaHalfInTotalPattern2](interfaces/DeltaHalfInTotalPattern2.md) +- [DeltaHalfInToTotalPattern](interfaces/DeltaHalfInToTotalPattern.md) +- [DeltaHalfInToTotalPattern2](interfaces/DeltaHalfInToTotalPattern2.md) +- [DeltaTotalPattern](interfaces/DeltaTotalPattern.md) +- [DetailedSeriesCount](interfaces/DetailedSeriesCount.md) - [DifficultyAdjustment](interfaces/DifficultyAdjustment.md) - [DifficultyAdjustmentEntry](interfaces/DifficultyAdjustmentEntry.md) - [DifficultyEntry](interfaces/DifficultyEntry.md) - [DiskUsage](interfaces/DiskUsage.md) -- [DollarsSatsPattern](interfaces/DollarsSatsPattern.md) -- [DollarsSatsPattern2](interfaces/DollarsSatsPattern2.md) -- [EmptyAddressData](interfaces/EmptyAddressData.md) -- [FundedAddressData](interfaces/FundedAddressData.md) -- [GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern](interfaces/GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern.md) -- [GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern](interfaces/GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern.md) +- [EmaHistogramLineSignalPattern](interfaces/EmaHistogramLineSignalPattern.md) +- [EmptyAddrData](interfaces/EmptyAddrData.md) +- [ErrorBody](interfaces/ErrorBody.md) +- [ErrorDetail](interfaces/ErrorDetail.md) +- [FundedAddrData](interfaces/FundedAddrData.md) +- [GreedNetPainPattern](interfaces/GreedNetPainPattern.md) +- [GrossInvestedInvestorLossNetNuplProfitSentimentPattern2](interfaces/GrossInvestedInvestorLossNetNuplProfitSentimentPattern2.md) - [HashrateEntry](interfaces/HashrateEntry.md) - [HashrateSummary](interfaces/HashrateSummary.md) - [Health](interfaces/Health.md) - [HeightParam](interfaces/HeightParam.md) - [IndexInfo](interfaces/IndexInfo.md) -- [InvestedMaxMinPercentilesSpotPattern](interfaces/InvestedMaxMinPercentilesSpotPattern.md) -- [InvestedNegNetNuplSupplyUnrealizedPattern](interfaces/InvestedNegNetNuplSupplyUnrealizedPattern.md) -- [InvestedNegNetNuplSupplyUnrealizedPattern3](interfaces/InvestedNegNetNuplSupplyUnrealizedPattern3.md) -- [InvestedNegNetNuplSupplyUnrealizedPattern4](interfaces/InvestedNegNetNuplSupplyUnrealizedPattern4.md) -- [InvestedNegNetSupplyUnrealizedPattern](interfaces/InvestedNegNetSupplyUnrealizedPattern.md) -- [InvestedSupplyPattern](interfaces/InvestedSupplyPattern.md) -- [LimitParam](interfaces/LimitParam.md) -- [MaxMinPattern](interfaces/MaxMinPattern.md) +- [InMaxMinPerSupplyPattern](interfaces/InMaxMinPerSupplyPattern.md) +- [InPattern](interfaces/InPattern.md) +- [LegacySeriesParam](interfaces/LegacySeriesParam.md) +- [LegacySeriesWithIndex](interfaces/LegacySeriesWithIndex.md) +- [LossNetNuplProfitPattern](interfaces/LossNetNuplProfitPattern.md) +- [LossNuplProfitPattern](interfaces/LossNuplProfitPattern.md) +- [MaxMedianMinPct10Pct25Pct75Pct90Pattern](interfaces/MaxMedianMinPct10Pct25Pct75Pct90Pattern.md) +- [MaxMedianMinPct10Pct25Pct75Pct90Pattern2](interfaces/MaxMedianMinPct10Pct25Pct75Pct90Pattern2.md) - [MempoolBlock](interfaces/MempoolBlock.md) - [MempoolInfo](interfaces/MempoolInfo.md) -- [MetricCount](interfaces/MetricCount.md) -- [MetricData](interfaces/MetricData.md) -- [MetricEndpointBuilder](interfaces/MetricEndpointBuilder.md) -- [MetricLeafWithSchema](interfaces/MetricLeafWithSchema.md) -- [MetricParam](interfaces/MetricParam.md) -- [MetricPattern](interfaces/MetricPattern.md) -- [MetricSelection](interfaces/MetricSelection.md) -- [MetricSelectionLegacy](interfaces/MetricSelectionLegacy.md) -- [MetricsTree](interfaces/MetricsTree.md) -- [MetricsTree\_Addresses](interfaces/MetricsTree_Addresses.md) -- [MetricsTree\_Blocks](interfaces/MetricsTree_Blocks.md) -- [MetricsTree\_Blocks\_Count](interfaces/MetricsTree_Blocks_Count.md) -- [MetricsTree\_Blocks\_Difficulty](interfaces/MetricsTree_Blocks_Difficulty.md) -- [MetricsTree\_Blocks\_Halving](interfaces/MetricsTree_Blocks_Halving.md) -- [MetricsTree\_Blocks\_Mining](interfaces/MetricsTree_Blocks_Mining.md) -- [MetricsTree\_Blocks\_Rewards](interfaces/MetricsTree_Blocks_Rewards.md) -- [MetricsTree\_Blocks\_Rewards\_24hCoinbaseSum](interfaces/MetricsTree_Blocks_Rewards_24hCoinbaseSum.md) -- [MetricsTree\_Blocks\_Size](interfaces/MetricsTree_Blocks_Size.md) -- [MetricsTree\_Blocks\_Time](interfaces/MetricsTree_Blocks_Time.md) -- [MetricsTree\_Cointime](interfaces/MetricsTree_Cointime.md) -- [MetricsTree\_Cointime\_Activity](interfaces/MetricsTree_Cointime_Activity.md) -- [MetricsTree\_Cointime\_Adjusted](interfaces/MetricsTree_Cointime_Adjusted.md) -- [MetricsTree\_Cointime\_Cap](interfaces/MetricsTree_Cointime_Cap.md) -- [MetricsTree\_Cointime\_Pricing](interfaces/MetricsTree_Cointime_Pricing.md) -- [MetricsTree\_Cointime\_ReserveRisk](interfaces/MetricsTree_Cointime_ReserveRisk.md) -- [MetricsTree\_Cointime\_Supply](interfaces/MetricsTree_Cointime_Supply.md) -- [MetricsTree\_Cointime\_Value](interfaces/MetricsTree_Cointime_Value.md) -- [MetricsTree\_Constants](interfaces/MetricsTree_Constants.md) -- [MetricsTree\_Distribution](interfaces/MetricsTree_Distribution.md) -- [MetricsTree\_Distribution\_AddressActivity](interfaces/MetricsTree_Distribution_AddressActivity.md) -- [MetricsTree\_Distribution\_AddressCohorts](interfaces/MetricsTree_Distribution_AddressCohorts.md) -- [MetricsTree\_Distribution\_AddressCohorts\_AmountRange](interfaces/MetricsTree_Distribution_AddressCohorts_AmountRange.md) -- [MetricsTree\_Distribution\_AddressCohorts\_GeAmount](interfaces/MetricsTree_Distribution_AddressCohorts_GeAmount.md) -- [MetricsTree\_Distribution\_AddressCohorts\_LtAmount](interfaces/MetricsTree_Distribution_AddressCohorts_LtAmount.md) -- [MetricsTree\_Distribution\_AddressesData](interfaces/MetricsTree_Distribution_AddressesData.md) -- [MetricsTree\_Distribution\_AnyAddressIndexes](interfaces/MetricsTree_Distribution_AnyAddressIndexes.md) -- [MetricsTree\_Distribution\_GrowthRate](interfaces/MetricsTree_Distribution_GrowthRate.md) -- [MetricsTree\_Distribution\_NewAddrCount](interfaces/MetricsTree_Distribution_NewAddrCount.md) -- [MetricsTree\_Distribution\_TotalAddrCount](interfaces/MetricsTree_Distribution_TotalAddrCount.md) -- [MetricsTree\_Distribution\_UtxoCohorts](interfaces/MetricsTree_Distribution_UtxoCohorts.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_AgeRange](interfaces/MetricsTree_Distribution_UtxoCohorts_AgeRange.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_All](interfaces/MetricsTree_Distribution_UtxoCohorts_All.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_All\_Relative](interfaces/MetricsTree_Distribution_UtxoCohorts_All_Relative.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_AmountRange](interfaces/MetricsTree_Distribution_UtxoCohorts_AmountRange.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_Epoch](interfaces/MetricsTree_Distribution_UtxoCohorts_Epoch.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_GeAmount](interfaces/MetricsTree_Distribution_UtxoCohorts_GeAmount.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_LtAmount](interfaces/MetricsTree_Distribution_UtxoCohorts_LtAmount.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_MaxAge](interfaces/MetricsTree_Distribution_UtxoCohorts_MaxAge.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_MinAge](interfaces/MetricsTree_Distribution_UtxoCohorts_MinAge.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_Term](interfaces/MetricsTree_Distribution_UtxoCohorts_Term.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_Term\_Long](interfaces/MetricsTree_Distribution_UtxoCohorts_Term_Long.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_Term\_Short](interfaces/MetricsTree_Distribution_UtxoCohorts_Term_Short.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_Type](interfaces/MetricsTree_Distribution_UtxoCohorts_Type.md) -- [MetricsTree\_Distribution\_UtxoCohorts\_Year](interfaces/MetricsTree_Distribution_UtxoCohorts_Year.md) -- [MetricsTree\_Indexes](interfaces/MetricsTree_Indexes.md) -- [MetricsTree\_Indexes\_Address](interfaces/MetricsTree_Indexes_Address.md) -- [MetricsTree\_Indexes\_Address\_Empty](interfaces/MetricsTree_Indexes_Address_Empty.md) -- [MetricsTree\_Indexes\_Address\_Opreturn](interfaces/MetricsTree_Indexes_Address_Opreturn.md) -- [MetricsTree\_Indexes\_Address\_P2a](interfaces/MetricsTree_Indexes_Address_P2a.md) -- [MetricsTree\_Indexes\_Address\_P2ms](interfaces/MetricsTree_Indexes_Address_P2ms.md) -- [MetricsTree\_Indexes\_Address\_P2pk33](interfaces/MetricsTree_Indexes_Address_P2pk33.md) -- [MetricsTree\_Indexes\_Address\_P2pk65](interfaces/MetricsTree_Indexes_Address_P2pk65.md) -- [MetricsTree\_Indexes\_Address\_P2pkh](interfaces/MetricsTree_Indexes_Address_P2pkh.md) -- [MetricsTree\_Indexes\_Address\_P2sh](interfaces/MetricsTree_Indexes_Address_P2sh.md) -- [MetricsTree\_Indexes\_Address\_P2tr](interfaces/MetricsTree_Indexes_Address_P2tr.md) -- [MetricsTree\_Indexes\_Address\_P2wpkh](interfaces/MetricsTree_Indexes_Address_P2wpkh.md) -- [MetricsTree\_Indexes\_Address\_P2wsh](interfaces/MetricsTree_Indexes_Address_P2wsh.md) -- [MetricsTree\_Indexes\_Address\_Unknown](interfaces/MetricsTree_Indexes_Address_Unknown.md) -- [MetricsTree\_Indexes\_Dateindex](interfaces/MetricsTree_Indexes_Dateindex.md) -- [MetricsTree\_Indexes\_Decadeindex](interfaces/MetricsTree_Indexes_Decadeindex.md) -- [MetricsTree\_Indexes\_Difficultyepoch](interfaces/MetricsTree_Indexes_Difficultyepoch.md) -- [MetricsTree\_Indexes\_Halvingepoch](interfaces/MetricsTree_Indexes_Halvingepoch.md) -- [MetricsTree\_Indexes\_Height](interfaces/MetricsTree_Indexes_Height.md) -- [MetricsTree\_Indexes\_Monthindex](interfaces/MetricsTree_Indexes_Monthindex.md) -- [MetricsTree\_Indexes\_Quarterindex](interfaces/MetricsTree_Indexes_Quarterindex.md) -- [MetricsTree\_Indexes\_Semesterindex](interfaces/MetricsTree_Indexes_Semesterindex.md) -- [MetricsTree\_Indexes\_Txindex](interfaces/MetricsTree_Indexes_Txindex.md) -- [MetricsTree\_Indexes\_Txinindex](interfaces/MetricsTree_Indexes_Txinindex.md) -- [MetricsTree\_Indexes\_Txoutindex](interfaces/MetricsTree_Indexes_Txoutindex.md) -- [MetricsTree\_Indexes\_Weekindex](interfaces/MetricsTree_Indexes_Weekindex.md) -- [MetricsTree\_Indexes\_Yearindex](interfaces/MetricsTree_Indexes_Yearindex.md) -- [MetricsTree\_Inputs](interfaces/MetricsTree_Inputs.md) -- [MetricsTree\_Inputs\_Spent](interfaces/MetricsTree_Inputs_Spent.md) -- [MetricsTree\_Market](interfaces/MetricsTree_Market.md) -- [MetricsTree\_Market\_Ath](interfaces/MetricsTree_Market_Ath.md) -- [MetricsTree\_Market\_Dca](interfaces/MetricsTree_Market_Dca.md) -- [MetricsTree\_Market\_Dca\_ClassAveragePrice](interfaces/MetricsTree_Market_Dca_ClassAveragePrice.md) -- [MetricsTree\_Market\_Dca\_ClassDaysInLoss](interfaces/MetricsTree_Market_Dca_ClassDaysInLoss.md) -- [MetricsTree\_Market\_Dca\_ClassDaysInProfit](interfaces/MetricsTree_Market_Dca_ClassDaysInProfit.md) -- [MetricsTree\_Market\_Dca\_ClassMaxReturn](interfaces/MetricsTree_Market_Dca_ClassMaxReturn.md) -- [MetricsTree\_Market\_Dca\_ClassMinReturn](interfaces/MetricsTree_Market_Dca_ClassMinReturn.md) -- [MetricsTree\_Market\_Dca\_ClassStack](interfaces/MetricsTree_Market_Dca_ClassStack.md) -- [MetricsTree\_Market\_Dca\_PeriodAveragePrice](interfaces/MetricsTree_Market_Dca_PeriodAveragePrice.md) -- [MetricsTree\_Market\_Indicators](interfaces/MetricsTree_Market_Indicators.md) -- [MetricsTree\_Market\_Lookback](interfaces/MetricsTree_Market_Lookback.md) -- [MetricsTree\_Market\_MovingAverage](interfaces/MetricsTree_Market_MovingAverage.md) -- [MetricsTree\_Market\_Range](interfaces/MetricsTree_Market_Range.md) -- [MetricsTree\_Market\_Returns](interfaces/MetricsTree_Market_Returns.md) -- [MetricsTree\_Market\_Returns\_PriceReturns](interfaces/MetricsTree_Market_Returns_PriceReturns.md) -- [MetricsTree\_Market\_Volatility](interfaces/MetricsTree_Market_Volatility.md) -- [MetricsTree\_Outputs](interfaces/MetricsTree_Outputs.md) -- [MetricsTree\_Outputs\_Count](interfaces/MetricsTree_Outputs_Count.md) -- [MetricsTree\_Outputs\_Spent](interfaces/MetricsTree_Outputs_Spent.md) -- [MetricsTree\_Pools](interfaces/MetricsTree_Pools.md) -- [MetricsTree\_Pools\_Vecs](interfaces/MetricsTree_Pools_Vecs.md) -- [MetricsTree\_Positions](interfaces/MetricsTree_Positions.md) -- [MetricsTree\_Price](interfaces/MetricsTree_Price.md) -- [MetricsTree\_Price\_Cents](interfaces/MetricsTree_Price_Cents.md) -- [MetricsTree\_Price\_Cents\_Split](interfaces/MetricsTree_Price_Cents_Split.md) -- [MetricsTree\_Price\_Oracle](interfaces/MetricsTree_Price_Oracle.md) -- [MetricsTree\_Price\_Usd](interfaces/MetricsTree_Price_Usd.md) -- [MetricsTree\_Scripts](interfaces/MetricsTree_Scripts.md) -- [MetricsTree\_Scripts\_Count](interfaces/MetricsTree_Scripts_Count.md) -- [MetricsTree\_Scripts\_Value](interfaces/MetricsTree_Scripts_Value.md) -- [MetricsTree\_Supply](interfaces/MetricsTree_Supply.md) -- [MetricsTree\_Supply\_Burned](interfaces/MetricsTree_Supply_Burned.md) -- [MetricsTree\_Supply\_Circulating](interfaces/MetricsTree_Supply_Circulating.md) -- [MetricsTree\_Supply\_Velocity](interfaces/MetricsTree_Supply_Velocity.md) -- [MetricsTree\_Transactions](interfaces/MetricsTree_Transactions.md) -- [MetricsTree\_Transactions\_Count](interfaces/MetricsTree_Transactions_Count.md) -- [MetricsTree\_Transactions\_Fees](interfaces/MetricsTree_Transactions_Fees.md) -- [MetricsTree\_Transactions\_Fees\_Fee](interfaces/MetricsTree_Transactions_Fees_Fee.md) -- [MetricsTree\_Transactions\_Size](interfaces/MetricsTree_Transactions_Size.md) -- [MetricsTree\_Transactions\_Versions](interfaces/MetricsTree_Transactions_Versions.md) -- [MetricsTree\_Transactions\_Volume](interfaces/MetricsTree_Transactions_Volume.md) -- [MetricWithIndex](interfaces/MetricWithIndex.md) -- [OHLCCentsUnsigned](interfaces/OHLCCentsUnsigned.md) +- [NuplPattern](interfaces/NuplPattern.md) +- [NuplRealizedSupplyUnrealizedPattern](interfaces/NuplRealizedSupplyUnrealizedPattern.md) +- [OHLCCents](interfaces/OHLCCents.md) - [OHLCDollars](interfaces/OHLCDollars.md) - [OHLCSats](interfaces/OHLCSats.md) -- [OhlcSplitPattern2](interfaces/OhlcSplitPattern2.md) -- [PaginatedMetrics](interfaces/PaginatedMetrics.md) +- [PaginatedSeries](interfaces/PaginatedSeries.md) - [Pagination](interfaces/Pagination.md) - [Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern](interfaces/Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md) +- [Pct1Pct2Pct5Pct95Pct98Pct99Pattern](interfaces/Pct1Pct2Pct5Pct95Pct98Pct99Pattern.md) +- [PerPattern](interfaces/PerPattern.md) +- [PhsReboundThsPattern](interfaces/PhsReboundThsPattern.md) - [PoolBlockCounts](interfaces/PoolBlockCounts.md) - [PoolBlockShares](interfaces/PoolBlockShares.md) - [PoolDetail](interfaces/PoolDetail.md) @@ -236,20 +169,230 @@ - [PoolSlugParam](interfaces/PoolSlugParam.md) - [PoolsSummary](interfaces/PoolsSummary.md) - [PoolStats](interfaces/PoolStats.md) +- [PricePattern](interfaces/PricePattern.md) - [PriceRatioPattern](interfaces/PriceRatioPattern.md) - [RangeBuilder](interfaces/RangeBuilder.md) -- [RatioPattern](interfaces/RatioPattern.md) -- [RatioPattern2](interfaces/RatioPattern2.md) +- [RatioTransferValuePattern](interfaces/RatioTransferValuePattern.md) +- [RatioValuePattern](interfaces/RatioValuePattern.md) - [RecommendedFees](interfaces/RecommendedFees.md) - [RewardStats](interfaces/RewardStats.md) +- [RsiStochPattern](interfaces/RsiStochPattern.md) - [SdSmaPattern](interfaces/SdSmaPattern.md) +- [SearchQuery](interfaces/SearchQuery.md) +- [SeriesCount](interfaces/SeriesCount.md) +- [SeriesDataBase](interfaces/SeriesDataBase.md) +- [SeriesEndpoint](interfaces/SeriesEndpoint.md) +- [SeriesInfo](interfaces/SeriesInfo.md) +- [SeriesLeafWithSchema](interfaces/SeriesLeafWithSchema.md) +- [SeriesNameWithIndex](interfaces/SeriesNameWithIndex.md) +- [SeriesParam](interfaces/SeriesParam.md) +- [SeriesPattern](interfaces/SeriesPattern.md) +- [SeriesSelection](interfaces/SeriesSelection.md) +- [SeriesSelectionLegacy](interfaces/SeriesSelectionLegacy.md) +- [SeriesTree](interfaces/SeriesTree.md) +- [SeriesTree\_Addrs](interfaces/SeriesTree_Addrs.md) +- [SeriesTree\_Addrs\_Activity](interfaces/SeriesTree_Addrs_Activity.md) +- [SeriesTree\_Addrs\_Data](interfaces/SeriesTree_Addrs_Data.md) +- [SeriesTree\_Addrs\_Delta](interfaces/SeriesTree_Addrs_Delta.md) +- [SeriesTree\_Addrs\_Indexes](interfaces/SeriesTree_Addrs_Indexes.md) +- [SeriesTree\_Addrs\_New](interfaces/SeriesTree_Addrs_New.md) +- [SeriesTree\_Addrs\_Raw](interfaces/SeriesTree_Addrs_Raw.md) +- [SeriesTree\_Addrs\_Raw\_P2a](interfaces/SeriesTree_Addrs_Raw_P2a.md) +- [SeriesTree\_Addrs\_Raw\_P2pk33](interfaces/SeriesTree_Addrs_Raw_P2pk33.md) +- [SeriesTree\_Addrs\_Raw\_P2pk65](interfaces/SeriesTree_Addrs_Raw_P2pk65.md) +- [SeriesTree\_Addrs\_Raw\_P2pkh](interfaces/SeriesTree_Addrs_Raw_P2pkh.md) +- [SeriesTree\_Addrs\_Raw\_P2sh](interfaces/SeriesTree_Addrs_Raw_P2sh.md) +- [SeriesTree\_Addrs\_Raw\_P2tr](interfaces/SeriesTree_Addrs_Raw_P2tr.md) +- [SeriesTree\_Addrs\_Raw\_P2wpkh](interfaces/SeriesTree_Addrs_Raw_P2wpkh.md) +- [SeriesTree\_Addrs\_Raw\_P2wsh](interfaces/SeriesTree_Addrs_Raw_P2wsh.md) +- [SeriesTree\_Blocks](interfaces/SeriesTree_Blocks.md) +- [SeriesTree\_Blocks\_Count](interfaces/SeriesTree_Blocks_Count.md) +- [SeriesTree\_Blocks\_Difficulty](interfaces/SeriesTree_Blocks_Difficulty.md) +- [SeriesTree\_Blocks\_Fullness](interfaces/SeriesTree_Blocks_Fullness.md) +- [SeriesTree\_Blocks\_Halving](interfaces/SeriesTree_Blocks_Halving.md) +- [SeriesTree\_Blocks\_Interval](interfaces/SeriesTree_Blocks_Interval.md) +- [SeriesTree\_Blocks\_Lookback](interfaces/SeriesTree_Blocks_Lookback.md) +- [SeriesTree\_Blocks\_Size](interfaces/SeriesTree_Blocks_Size.md) +- [SeriesTree\_Blocks\_Time](interfaces/SeriesTree_Blocks_Time.md) +- [SeriesTree\_Cohorts](interfaces/SeriesTree_Cohorts.md) +- [SeriesTree\_Cohorts\_Addr](interfaces/SeriesTree_Cohorts_Addr.md) +- [SeriesTree\_Cohorts\_Addr\_AmountRange](interfaces/SeriesTree_Cohorts_Addr_AmountRange.md) +- [SeriesTree\_Cohorts\_Addr\_OverAmount](interfaces/SeriesTree_Cohorts_Addr_OverAmount.md) +- [SeriesTree\_Cohorts\_Addr\_UnderAmount](interfaces/SeriesTree_Cohorts_Addr_UnderAmount.md) +- [SeriesTree\_Cohorts\_Utxo](interfaces/SeriesTree_Cohorts_Utxo.md) +- [SeriesTree\_Cohorts\_Utxo\_AgeRange](interfaces/SeriesTree_Cohorts_Utxo_AgeRange.md) +- [SeriesTree\_Cohorts\_Utxo\_All](interfaces/SeriesTree_Cohorts_Utxo_All.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Activity](interfaces/SeriesTree_Cohorts_Utxo_All_Activity.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_CostBasis](interfaces/SeriesTree_Cohorts_Utxo_All_CostBasis.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Outputs](interfaces/SeriesTree_Cohorts_Utxo_All_Outputs.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Realized](interfaces/SeriesTree_Cohorts_Utxo_All_Realized.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price](interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev](interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_1y](interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_1y.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_2y](interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_2y.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_4y](interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_4y.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_All](interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_All.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Sopr](interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Sopr.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Sopr\_Adjusted](interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Sopr_Adjusted.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Supply](interfaces/SeriesTree_Cohorts_Utxo_All_Supply.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Unrealized](interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_Loss](interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Loss.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_NetPnl](interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_NetPnl.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_Profit](interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Profit.md) +- [SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_Sentiment](interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Sentiment.md) +- [SeriesTree\_Cohorts\_Utxo\_AmountRange](interfaces/SeriesTree_Cohorts_Utxo_AmountRange.md) +- [SeriesTree\_Cohorts\_Utxo\_Class](interfaces/SeriesTree_Cohorts_Utxo_Class.md) +- [SeriesTree\_Cohorts\_Utxo\_Epoch](interfaces/SeriesTree_Cohorts_Utxo_Epoch.md) +- [SeriesTree\_Cohorts\_Utxo\_Lth](interfaces/SeriesTree_Cohorts_Utxo_Lth.md) +- [SeriesTree\_Cohorts\_Utxo\_Lth\_Realized](interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized.md) +- [SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price](interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price.md) +- [SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev](interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev.md) +- [SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_1y](interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_1y.md) +- [SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_2y](interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_2y.md) +- [SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_4y](interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_4y.md) +- [SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_All](interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_All.md) +- [SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Sopr](interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Sopr.md) +- [SeriesTree\_Cohorts\_Utxo\_Matured](interfaces/SeriesTree_Cohorts_Utxo_Matured.md) +- [SeriesTree\_Cohorts\_Utxo\_OverAge](interfaces/SeriesTree_Cohorts_Utxo_OverAge.md) +- [SeriesTree\_Cohorts\_Utxo\_OverAmount](interfaces/SeriesTree_Cohorts_Utxo_OverAmount.md) +- [SeriesTree\_Cohorts\_Utxo\_Profitability](interfaces/SeriesTree_Cohorts_Utxo_Profitability.md) +- [SeriesTree\_Cohorts\_Utxo\_Profitability\_Loss](interfaces/SeriesTree_Cohorts_Utxo_Profitability_Loss.md) +- [SeriesTree\_Cohorts\_Utxo\_Profitability\_Profit](interfaces/SeriesTree_Cohorts_Utxo_Profitability_Profit.md) +- [SeriesTree\_Cohorts\_Utxo\_Profitability\_Range](interfaces/SeriesTree_Cohorts_Utxo_Profitability_Range.md) +- [SeriesTree\_Cohorts\_Utxo\_Sth](interfaces/SeriesTree_Cohorts_Utxo_Sth.md) +- [SeriesTree\_Cohorts\_Utxo\_Sth\_Realized](interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized.md) +- [SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price](interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price.md) +- [SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev](interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev.md) +- [SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_1y](interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_1y.md) +- [SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_2y](interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_2y.md) +- [SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_4y](interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_4y.md) +- [SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_All](interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_All.md) +- [SeriesTree\_Cohorts\_Utxo\_Type](interfaces/SeriesTree_Cohorts_Utxo_Type.md) +- [SeriesTree\_Cohorts\_Utxo\_UnderAge](interfaces/SeriesTree_Cohorts_Utxo_UnderAge.md) +- [SeriesTree\_Cohorts\_Utxo\_UnderAmount](interfaces/SeriesTree_Cohorts_Utxo_UnderAmount.md) +- [SeriesTree\_Cointime](interfaces/SeriesTree_Cointime.md) +- [SeriesTree\_Cointime\_Activity](interfaces/SeriesTree_Cointime_Activity.md) +- [SeriesTree\_Cointime\_Adjusted](interfaces/SeriesTree_Cointime_Adjusted.md) +- [SeriesTree\_Cointime\_Cap](interfaces/SeriesTree_Cointime_Cap.md) +- [SeriesTree\_Cointime\_Prices](interfaces/SeriesTree_Cointime_Prices.md) +- [SeriesTree\_Cointime\_ReserveRisk](interfaces/SeriesTree_Cointime_ReserveRisk.md) +- [SeriesTree\_Cointime\_Supply](interfaces/SeriesTree_Cointime_Supply.md) +- [SeriesTree\_Cointime\_Value](interfaces/SeriesTree_Cointime_Value.md) +- [SeriesTree\_Constants](interfaces/SeriesTree_Constants.md) +- [SeriesTree\_Indexes](interfaces/SeriesTree_Indexes.md) +- [SeriesTree\_Indexes\_Addr](interfaces/SeriesTree_Indexes_Addr.md) +- [SeriesTree\_Indexes\_Addr\_Empty](interfaces/SeriesTree_Indexes_Addr_Empty.md) +- [SeriesTree\_Indexes\_Addr\_OpReturn](interfaces/SeriesTree_Indexes_Addr_OpReturn.md) +- [SeriesTree\_Indexes\_Addr\_P2a](interfaces/SeriesTree_Indexes_Addr_P2a.md) +- [SeriesTree\_Indexes\_Addr\_P2ms](interfaces/SeriesTree_Indexes_Addr_P2ms.md) +- [SeriesTree\_Indexes\_Addr\_P2pk33](interfaces/SeriesTree_Indexes_Addr_P2pk33.md) +- [SeriesTree\_Indexes\_Addr\_P2pk65](interfaces/SeriesTree_Indexes_Addr_P2pk65.md) +- [SeriesTree\_Indexes\_Addr\_P2pkh](interfaces/SeriesTree_Indexes_Addr_P2pkh.md) +- [SeriesTree\_Indexes\_Addr\_P2sh](interfaces/SeriesTree_Indexes_Addr_P2sh.md) +- [SeriesTree\_Indexes\_Addr\_P2tr](interfaces/SeriesTree_Indexes_Addr_P2tr.md) +- [SeriesTree\_Indexes\_Addr\_P2wpkh](interfaces/SeriesTree_Indexes_Addr_P2wpkh.md) +- [SeriesTree\_Indexes\_Addr\_P2wsh](interfaces/SeriesTree_Indexes_Addr_P2wsh.md) +- [SeriesTree\_Indexes\_Addr\_Unknown](interfaces/SeriesTree_Indexes_Addr_Unknown.md) +- [SeriesTree\_Indexes\_Day1](interfaces/SeriesTree_Indexes_Day1.md) +- [SeriesTree\_Indexes\_Day3](interfaces/SeriesTree_Indexes_Day3.md) +- [SeriesTree\_Indexes\_Epoch](interfaces/SeriesTree_Indexes_Epoch.md) +- [SeriesTree\_Indexes\_Halving](interfaces/SeriesTree_Indexes_Halving.md) +- [SeriesTree\_Indexes\_Height](interfaces/SeriesTree_Indexes_Height.md) +- [SeriesTree\_Indexes\_Hour1](interfaces/SeriesTree_Indexes_Hour1.md) +- [SeriesTree\_Indexes\_Hour12](interfaces/SeriesTree_Indexes_Hour12.md) +- [SeriesTree\_Indexes\_Hour4](interfaces/SeriesTree_Indexes_Hour4.md) +- [SeriesTree\_Indexes\_Minute10](interfaces/SeriesTree_Indexes_Minute10.md) +- [SeriesTree\_Indexes\_Minute30](interfaces/SeriesTree_Indexes_Minute30.md) +- [SeriesTree\_Indexes\_Month1](interfaces/SeriesTree_Indexes_Month1.md) +- [SeriesTree\_Indexes\_Month3](interfaces/SeriesTree_Indexes_Month3.md) +- [SeriesTree\_Indexes\_Month6](interfaces/SeriesTree_Indexes_Month6.md) +- [SeriesTree\_Indexes\_TxIndex](interfaces/SeriesTree_Indexes_TxIndex.md) +- [SeriesTree\_Indexes\_TxinIndex](interfaces/SeriesTree_Indexes_TxinIndex.md) +- [SeriesTree\_Indexes\_TxoutIndex](interfaces/SeriesTree_Indexes_TxoutIndex.md) +- [SeriesTree\_Indexes\_Week1](interfaces/SeriesTree_Indexes_Week1.md) +- [SeriesTree\_Indexes\_Year1](interfaces/SeriesTree_Indexes_Year1.md) +- [SeriesTree\_Indexes\_Year10](interfaces/SeriesTree_Indexes_Year10.md) +- [SeriesTree\_Indicators](interfaces/SeriesTree_Indicators.md) +- [SeriesTree\_Indicators\_Dormancy](interfaces/SeriesTree_Indicators_Dormancy.md) +- [SeriesTree\_Inputs](interfaces/SeriesTree_Inputs.md) +- [SeriesTree\_Inputs\_Raw](interfaces/SeriesTree_Inputs_Raw.md) +- [SeriesTree\_Inputs\_Spent](interfaces/SeriesTree_Inputs_Spent.md) +- [SeriesTree\_Market](interfaces/SeriesTree_Market.md) +- [SeriesTree\_Market\_Ath](interfaces/SeriesTree_Market_Ath.md) +- [SeriesTree\_Market\_Dca](interfaces/SeriesTree_Market_Dca.md) +- [SeriesTree\_Market\_Dca\_Class](interfaces/SeriesTree_Market_Dca_Class.md) +- [SeriesTree\_Market\_Dca\_Class\_CostBasis](interfaces/SeriesTree_Market_Dca_Class_CostBasis.md) +- [SeriesTree\_Market\_Dca\_Class\_Return](interfaces/SeriesTree_Market_Dca_Class_Return.md) +- [SeriesTree\_Market\_Dca\_Class\_Stack](interfaces/SeriesTree_Market_Dca_Class_Stack.md) +- [SeriesTree\_Market\_Dca\_Period](interfaces/SeriesTree_Market_Dca_Period.md) +- [SeriesTree\_Market\_Dca\_Period\_CostBasis](interfaces/SeriesTree_Market_Dca_Period_CostBasis.md) +- [SeriesTree\_Market\_Lookback](interfaces/SeriesTree_Market_Lookback.md) +- [SeriesTree\_Market\_MovingAverage](interfaces/SeriesTree_Market_MovingAverage.md) +- [SeriesTree\_Market\_MovingAverage\_Ema](interfaces/SeriesTree_Market_MovingAverage_Ema.md) +- [SeriesTree\_Market\_MovingAverage\_Sma](interfaces/SeriesTree_Market_MovingAverage_Sma.md) +- [SeriesTree\_Market\_MovingAverage\_Sma\_200d](interfaces/SeriesTree_Market_MovingAverage_Sma_200d.md) +- [SeriesTree\_Market\_MovingAverage\_Sma\_350d](interfaces/SeriesTree_Market_MovingAverage_Sma_350d.md) +- [SeriesTree\_Market\_Range](interfaces/SeriesTree_Market_Range.md) +- [SeriesTree\_Market\_Returns](interfaces/SeriesTree_Market_Returns.md) +- [SeriesTree\_Market\_Returns\_Periods](interfaces/SeriesTree_Market_Returns_Periods.md) +- [SeriesTree\_Market\_Returns\_Sd24h](interfaces/SeriesTree_Market_Returns_Sd24h.md) +- [SeriesTree\_Market\_Returns\_Sd24h\_1m](interfaces/SeriesTree_Market_Returns_Sd24h_1m.md) +- [SeriesTree\_Market\_Returns\_Sd24h\_1w](interfaces/SeriesTree_Market_Returns_Sd24h_1w.md) +- [SeriesTree\_Market\_Returns\_Sd24h\_1y](interfaces/SeriesTree_Market_Returns_Sd24h_1y.md) +- [SeriesTree\_Market\_Returns\_Sd24h\_24h](interfaces/SeriesTree_Market_Returns_Sd24h_24h.md) +- [SeriesTree\_Market\_Technical](interfaces/SeriesTree_Market_Technical.md) +- [SeriesTree\_Market\_Technical\_Macd](interfaces/SeriesTree_Market_Technical_Macd.md) +- [SeriesTree\_Market\_Technical\_Macd\_1m](interfaces/SeriesTree_Market_Technical_Macd_1m.md) +- [SeriesTree\_Market\_Technical\_Macd\_1w](interfaces/SeriesTree_Market_Technical_Macd_1w.md) +- [SeriesTree\_Market\_Technical\_Macd\_24h](interfaces/SeriesTree_Market_Technical_Macd_24h.md) +- [SeriesTree\_Market\_Technical\_Rsi](interfaces/SeriesTree_Market_Technical_Rsi.md) +- [SeriesTree\_Mining](interfaces/SeriesTree_Mining.md) +- [SeriesTree\_Mining\_Hashrate](interfaces/SeriesTree_Mining_Hashrate.md) +- [SeriesTree\_Mining\_Hashrate\_Rate](interfaces/SeriesTree_Mining_Hashrate_Rate.md) +- [SeriesTree\_Mining\_Hashrate\_Rate\_Sma](interfaces/SeriesTree_Mining_Hashrate_Rate_Sma.md) +- [SeriesTree\_Mining\_Rewards](interfaces/SeriesTree_Mining_Rewards.md) +- [SeriesTree\_Mining\_Rewards\_Fees](interfaces/SeriesTree_Mining_Rewards_Fees.md) +- [SeriesTree\_Mining\_Rewards\_Fees\_ToSubsidyRatio](interfaces/SeriesTree_Mining_Rewards_Fees_ToSubsidyRatio.md) +- [SeriesTree\_Mining\_Rewards\_Subsidy](interfaces/SeriesTree_Mining_Rewards_Subsidy.md) +- [SeriesTree\_Outputs](interfaces/SeriesTree_Outputs.md) +- [SeriesTree\_Outputs\_Count](interfaces/SeriesTree_Outputs_Count.md) +- [SeriesTree\_Outputs\_Raw](interfaces/SeriesTree_Outputs_Raw.md) +- [SeriesTree\_Outputs\_Spent](interfaces/SeriesTree_Outputs_Spent.md) +- [SeriesTree\_Pools](interfaces/SeriesTree_Pools.md) +- [SeriesTree\_Pools\_Major](interfaces/SeriesTree_Pools_Major.md) +- [SeriesTree\_Pools\_Minor](interfaces/SeriesTree_Pools_Minor.md) +- [SeriesTree\_Prices](interfaces/SeriesTree_Prices.md) +- [SeriesTree\_Prices\_Ohlc](interfaces/SeriesTree_Prices_Ohlc.md) +- [SeriesTree\_Prices\_Split](interfaces/SeriesTree_Prices_Split.md) +- [SeriesTree\_Prices\_Spot](interfaces/SeriesTree_Prices_Spot.md) +- [SeriesTree\_Scripts](interfaces/SeriesTree_Scripts.md) +- [SeriesTree\_Scripts\_Count](interfaces/SeriesTree_Scripts_Count.md) +- [SeriesTree\_Scripts\_Raw](interfaces/SeriesTree_Scripts_Raw.md) +- [SeriesTree\_Scripts\_Raw\_Empty](interfaces/SeriesTree_Scripts_Raw_Empty.md) +- [SeriesTree\_Scripts\_Raw\_OpReturn](interfaces/SeriesTree_Scripts_Raw_OpReturn.md) +- [SeriesTree\_Scripts\_Raw\_P2ms](interfaces/SeriesTree_Scripts_Raw_P2ms.md) +- [SeriesTree\_Scripts\_Raw\_Unknown](interfaces/SeriesTree_Scripts_Raw_Unknown.md) +- [SeriesTree\_Scripts\_Value](interfaces/SeriesTree_Scripts_Value.md) +- [SeriesTree\_Supply](interfaces/SeriesTree_Supply.md) +- [SeriesTree\_Supply\_Velocity](interfaces/SeriesTree_Supply_Velocity.md) +- [SeriesTree\_Transactions](interfaces/SeriesTree_Transactions.md) +- [SeriesTree\_Transactions\_Count](interfaces/SeriesTree_Transactions_Count.md) +- [SeriesTree\_Transactions\_Fees](interfaces/SeriesTree_Transactions_Fees.md) +- [SeriesTree\_Transactions\_Raw](interfaces/SeriesTree_Transactions_Raw.md) +- [SeriesTree\_Transactions\_Size](interfaces/SeriesTree_Transactions_Size.md) +- [SeriesTree\_Transactions\_Size\_Weight](interfaces/SeriesTree_Transactions_Size_Weight.md) +- [SeriesTree\_Transactions\_Versions](interfaces/SeriesTree_Transactions_Versions.md) +- [SeriesTree\_Transactions\_Volume](interfaces/SeriesTree_Transactions_Volume.md) - [SingleItemBuilder](interfaces/SingleItemBuilder.md) - [SkippedBuilder](interfaces/SkippedBuilder.md) +- [SpendingSpentUnspentPattern](interfaces/SpendingSpentUnspentPattern.md) - [SupplyState](interfaces/SupplyState.md) - [SyncStatus](interfaces/SyncStatus.md) - [TimePeriodParam](interfaces/TimePeriodParam.md) - [TimestampParam](interfaces/TimestampParam.md) +- [ToPattern](interfaces/ToPattern.md) - [Transaction](interfaces/Transaction.md) +- [TransferPattern](interfaces/TransferPattern.md) - [TxidParam](interfaces/TxidParam.md) - [TxidVout](interfaces/TxidVout.md) - [TxIn](interfaces/TxIn.md) @@ -257,109 +400,126 @@ - [TxOutspend](interfaces/TxOutspend.md) - [TxStatus](interfaces/TxStatus.md) - [Utxo](interfaces/Utxo.md) -- [UtxoPattern](interfaces/UtxoPattern.md) -- [ValidateAddressParam](interfaces/ValidateAddressParam.md) +- [ValidateAddrParam](interfaces/ValidateAddrParam.md) ## Type Aliases -- [Address](type-aliases/Address.md) -- [AnyAddressIndex](type-aliases/AnyAddressIndex.md) -- [AnyMetricData](type-aliases/AnyMetricData.md) -- [AnyMetricEndpointBuilder](type-aliases/AnyMetricEndpointBuilder.md) -- [AnyMetricPattern](type-aliases/AnyMetricPattern.md) +- [Addr](type-aliases/Addr.md) +- [AnyAddrIndex](type-aliases/AnyAddrIndex.md) +- [AnySeriesData](type-aliases/AnySeriesData.md) +- [AnySeriesEndpoint](type-aliases/AnySeriesEndpoint.md) +- [AnySeriesPattern](type-aliases/AnySeriesPattern.md) +- [BasisPoints16](type-aliases/BasisPoints16.md) +- [BasisPoints32](type-aliases/BasisPoints32.md) +- [BasisPointsSigned16](type-aliases/BasisPointsSigned16.md) +- [BasisPointsSigned32](type-aliases/BasisPointsSigned32.md) - [Bitcoin](type-aliases/Bitcoin.md) -- [BlkPosition](type-aliases/BlkPosition.md) - [BlockHash](type-aliases/BlockHash.md) +- [Cents](type-aliases/Cents.md) - [CentsSats](type-aliases/CentsSats.md) +- [CentsSigned](type-aliases/CentsSigned.md) - [CentsSquaredSats](type-aliases/CentsSquaredSats.md) -- [CentsUnsigned](type-aliases/CentsUnsigned.md) - [Close](type-aliases/Close.md) - [Cohort](type-aliases/Cohort.md) - [CostBasisBucket](type-aliases/CostBasisBucket.md) - [CostBasisValue](type-aliases/CostBasisValue.md) - [Date](type-aliases/Date.md) -- [DateIndex](type-aliases/DateIndex.md) -- [DecadeIndex](type-aliases/DecadeIndex.md) -- [Epoch](type-aliases/Epoch.md) +- [DateSeriesData](type-aliases/DateSeriesData.md) +- [DateThenable](type-aliases/DateThenable.md) +- [Day1](type-aliases/Day1.md) +- [Day3](type-aliases/Day3.md) - [Dollars](type-aliases/Dollars.md) -- [EmptyAddressIndex](type-aliases/EmptyAddressIndex.md) +- [EmptyAddrIndex](type-aliases/EmptyAddrIndex.md) - [EmptyOutputIndex](type-aliases/EmptyOutputIndex.md) +- [Epoch](type-aliases/Epoch.md) - [FeeRate](type-aliases/FeeRate.md) - [Format](type-aliases/Format.md) -- [FundedAddressIndex](type-aliases/FundedAddressIndex.md) +- [FundedAddrIndex](type-aliases/FundedAddrIndex.md) - [Halving](type-aliases/Halving.md) - [Height](type-aliases/Height.md) - [Hex](type-aliases/Hex.md) - [High](type-aliases/High.md) +- [Hour1](type-aliases/Hour1.md) +- [Hour12](type-aliases/Hour12.md) +- [Hour4](type-aliases/Hour4.md) - [Index](type-aliases/Index.md) - [Limit](type-aliases/Limit.md) - [Low](type-aliases/Low.md) -- [Metric](type-aliases/Metric.md) -- [MetricPattern1](type-aliases/MetricPattern1.md) -- [MetricPattern10](type-aliases/MetricPattern10.md) -- [MetricPattern11](type-aliases/MetricPattern11.md) -- [MetricPattern12](type-aliases/MetricPattern12.md) -- [MetricPattern13](type-aliases/MetricPattern13.md) -- [MetricPattern14](type-aliases/MetricPattern14.md) -- [MetricPattern15](type-aliases/MetricPattern15.md) -- [MetricPattern16](type-aliases/MetricPattern16.md) -- [MetricPattern17](type-aliases/MetricPattern17.md) -- [MetricPattern18](type-aliases/MetricPattern18.md) -- [MetricPattern19](type-aliases/MetricPattern19.md) -- [MetricPattern2](type-aliases/MetricPattern2.md) -- [MetricPattern20](type-aliases/MetricPattern20.md) -- [MetricPattern21](type-aliases/MetricPattern21.md) -- [MetricPattern22](type-aliases/MetricPattern22.md) -- [MetricPattern23](type-aliases/MetricPattern23.md) -- [MetricPattern24](type-aliases/MetricPattern24.md) -- [MetricPattern25](type-aliases/MetricPattern25.md) -- [MetricPattern26](type-aliases/MetricPattern26.md) -- [MetricPattern27](type-aliases/MetricPattern27.md) -- [MetricPattern28](type-aliases/MetricPattern28.md) -- [MetricPattern29](type-aliases/MetricPattern29.md) -- [MetricPattern3](type-aliases/MetricPattern3.md) -- [MetricPattern30](type-aliases/MetricPattern30.md) -- [MetricPattern31](type-aliases/MetricPattern31.md) -- [MetricPattern32](type-aliases/MetricPattern32.md) -- [MetricPattern4](type-aliases/MetricPattern4.md) -- [MetricPattern5](type-aliases/MetricPattern5.md) -- [MetricPattern6](type-aliases/MetricPattern6.md) -- [MetricPattern7](type-aliases/MetricPattern7.md) -- [MetricPattern8](type-aliases/MetricPattern8.md) -- [MetricPattern9](type-aliases/MetricPattern9.md) -- [Metrics](type-aliases/Metrics.md) -- [MonthIndex](type-aliases/MonthIndex.md) +- [Minute10](type-aliases/Minute10.md) +- [Minute30](type-aliases/Minute30.md) +- [Month1](type-aliases/Month1.md) +- [Month3](type-aliases/Month3.md) +- [Month6](type-aliases/Month6.md) - [Open](type-aliases/Open.md) - [OpReturnIndex](type-aliases/OpReturnIndex.md) - [OutPoint](type-aliases/OutPoint.md) - [OutputType](type-aliases/OutputType.md) -- [P2AAddressIndex](type-aliases/P2AAddressIndex.md) +- [P2AAddrIndex](type-aliases/P2AAddrIndex.md) - [P2ABytes](type-aliases/P2ABytes.md) - [P2MSOutputIndex](type-aliases/P2MSOutputIndex.md) -- [P2PK33AddressIndex](type-aliases/P2PK33AddressIndex.md) +- [P2PK33AddrIndex](type-aliases/P2PK33AddrIndex.md) - [P2PK33Bytes](type-aliases/P2PK33Bytes.md) -- [P2PK65AddressIndex](type-aliases/P2PK65AddressIndex.md) +- [P2PK65AddrIndex](type-aliases/P2PK65AddrIndex.md) - [P2PK65Bytes](type-aliases/P2PK65Bytes.md) -- [P2PKHAddressIndex](type-aliases/P2PKHAddressIndex.md) +- [P2PKHAddrIndex](type-aliases/P2PKHAddrIndex.md) - [P2PKHBytes](type-aliases/P2PKHBytes.md) -- [P2SHAddressIndex](type-aliases/P2SHAddressIndex.md) +- [P2SHAddrIndex](type-aliases/P2SHAddrIndex.md) - [P2SHBytes](type-aliases/P2SHBytes.md) -- [P2TRAddressIndex](type-aliases/P2TRAddressIndex.md) +- [P2TRAddrIndex](type-aliases/P2TRAddrIndex.md) - [P2TRBytes](type-aliases/P2TRBytes.md) -- [P2WPKHAddressIndex](type-aliases/P2WPKHAddressIndex.md) +- [P2WPKHAddrIndex](type-aliases/P2WPKHAddrIndex.md) - [P2WPKHBytes](type-aliases/P2WPKHBytes.md) -- [P2WSHAddressIndex](type-aliases/P2WSHAddressIndex.md) +- [P2WSHAddrIndex](type-aliases/P2WSHAddrIndex.md) - [P2WSHBytes](type-aliases/P2WSHBytes.md) - [PoolSlug](type-aliases/PoolSlug.md) -- [QuarterIndex](type-aliases/QuarterIndex.md) +- [RangeIndex](type-aliases/RangeIndex.md) - [RawLockTime](type-aliases/RawLockTime.md) - [Sats](type-aliases/Sats.md) - [SatsFract](type-aliases/SatsFract.md) - [SatsSigned](type-aliases/SatsSigned.md) -- [SemesterIndex](type-aliases/SemesterIndex.md) +- [SeriesData](type-aliases/SeriesData.md) +- [SeriesList](type-aliases/SeriesList.md) +- [SeriesName](type-aliases/SeriesName.md) +- [SeriesPattern1](type-aliases/SeriesPattern1.md) +- [SeriesPattern10](type-aliases/SeriesPattern10.md) +- [SeriesPattern11](type-aliases/SeriesPattern11.md) +- [SeriesPattern12](type-aliases/SeriesPattern12.md) +- [SeriesPattern13](type-aliases/SeriesPattern13.md) +- [SeriesPattern14](type-aliases/SeriesPattern14.md) +- [SeriesPattern15](type-aliases/SeriesPattern15.md) +- [SeriesPattern16](type-aliases/SeriesPattern16.md) +- [SeriesPattern17](type-aliases/SeriesPattern17.md) +- [SeriesPattern18](type-aliases/SeriesPattern18.md) +- [SeriesPattern19](type-aliases/SeriesPattern19.md) +- [SeriesPattern2](type-aliases/SeriesPattern2.md) +- [SeriesPattern20](type-aliases/SeriesPattern20.md) +- [SeriesPattern21](type-aliases/SeriesPattern21.md) +- [SeriesPattern22](type-aliases/SeriesPattern22.md) +- [SeriesPattern23](type-aliases/SeriesPattern23.md) +- [SeriesPattern24](type-aliases/SeriesPattern24.md) +- [SeriesPattern25](type-aliases/SeriesPattern25.md) +- [SeriesPattern26](type-aliases/SeriesPattern26.md) +- [SeriesPattern27](type-aliases/SeriesPattern27.md) +- [SeriesPattern28](type-aliases/SeriesPattern28.md) +- [SeriesPattern29](type-aliases/SeriesPattern29.md) +- [SeriesPattern3](type-aliases/SeriesPattern3.md) +- [SeriesPattern30](type-aliases/SeriesPattern30.md) +- [SeriesPattern31](type-aliases/SeriesPattern31.md) +- [SeriesPattern32](type-aliases/SeriesPattern32.md) +- [SeriesPattern33](type-aliases/SeriesPattern33.md) +- [SeriesPattern34](type-aliases/SeriesPattern34.md) +- [SeriesPattern35](type-aliases/SeriesPattern35.md) +- [SeriesPattern4](type-aliases/SeriesPattern4.md) +- [SeriesPattern5](type-aliases/SeriesPattern5.md) +- [SeriesPattern6](type-aliases/SeriesPattern6.md) +- [SeriesPattern7](type-aliases/SeriesPattern7.md) +- [SeriesPattern8](type-aliases/SeriesPattern8.md) +- [SeriesPattern9](type-aliases/SeriesPattern9.md) +- [SeriesTree\_Positions](type-aliases/SeriesTree_Positions.md) - [StoredBool](type-aliases/StoredBool.md) - [StoredF32](type-aliases/StoredF32.md) - [StoredF64](type-aliases/StoredF64.md) +- [StoredI64](type-aliases/StoredI64.md) - [StoredI8](type-aliases/StoredI8.md) - [StoredU16](type-aliases/StoredU16.md) - [StoredU32](type-aliases/StoredU32.md) @@ -380,9 +540,11 @@ - [U8x33](type-aliases/U8x33.md) - [U8x65](type-aliases/U8x65.md) - [UnknownOutputIndex](type-aliases/UnknownOutputIndex.md) +- [Version](type-aliases/Version.md) - [Vin](type-aliases/Vin.md) - [Vout](type-aliases/Vout.md) - [VSize](type-aliases/VSize.md) -- [WeekIndex](type-aliases/WeekIndex.md) +- [Week1](type-aliases/Week1.md) - [Weight](type-aliases/Weight.md) -- [YearIndex](type-aliases/YearIndex.md) +- [Year1](type-aliases/Year1.md) +- [Year10](type-aliases/Year10.md) diff --git a/modules/brk-client/docs/interfaces/0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md b/modules/brk-client/docs/interfaces/0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md deleted file mode 100644 index 40a8c5e31..000000000 --- a/modules/brk-client/docs/interfaces/0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md +++ /dev/null @@ -1,233 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / \_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern - -# Interface: \_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern - -Defined in: [Developer/brk/modules/brk-client/index.js:1913](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1913) - -## Properties - -### \_0sdUsd - -> **\_0sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1914](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1914) - -*** - -### m05sd - -> **m05sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1915](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1915) - -*** - -### m05sdUsd - -> **m05sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1916](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1916) - -*** - -### m15sd - -> **m15sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1917](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1917) - -*** - -### m15sdUsd - -> **m15sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1918](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1918) - -*** - -### m1sd - -> **m1sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1919](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1919) - -*** - -### m1sdUsd - -> **m1sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1920](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1920) - -*** - -### m25sd - -> **m25sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1921](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1921) - -*** - -### m25sdUsd - -> **m25sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1922](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1922) - -*** - -### m2sd - -> **m2sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1923](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1923) - -*** - -### m2sdUsd - -> **m2sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1924](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1924) - -*** - -### m3sd - -> **m3sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1925](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1925) - -*** - -### m3sdUsd - -> **m3sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1926](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1926) - -*** - -### p05sd - -> **p05sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1927](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1927) - -*** - -### p05sdUsd - -> **p05sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1928](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1928) - -*** - -### p15sd - -> **p15sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1929](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1929) - -*** - -### p15sdUsd - -> **p15sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1930](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1930) - -*** - -### p1sd - -> **p1sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1931](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1931) - -*** - -### p1sdUsd - -> **p1sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1932](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1932) - -*** - -### p25sd - -> **p25sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1933](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1933) - -*** - -### p25sdUsd - -> **p25sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1934](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1934) - -*** - -### p2sd - -> **p2sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1935](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1935) - -*** - -### p2sdUsd - -> **p2sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1936](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1936) - -*** - -### p3sd - -> **p3sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1937](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1937) - -*** - -### p3sdUsd - -> **p3sdUsd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1938](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1938) - -*** - -### sd - -> **sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1939](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1939) - -*** - -### sma - -> **sma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1940](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1940) - -*** - -### zscore - -> **zscore**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1941](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1941) diff --git a/modules/brk-client/docs/interfaces/0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern.md b/modules/brk-client/docs/interfaces/0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern.md new file mode 100644 index 000000000..b0c6ae936 --- /dev/null +++ b/modules/brk-client/docs/interfaces/0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern + +# Interface: \_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern + +Defined in: [Developer/brk/modules/brk-client/index.js:1685](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1685) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1686](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1686) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1687](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1687) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1688](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1688) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1689](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1689) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1690](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1690) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1691](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1691) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1692](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1692) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1693](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1693) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1694](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1694) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1695](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1695) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1696](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1696) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1697](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1697) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1698](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1698) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1699](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1699) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1700](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1700) diff --git a/modules/brk-client/docs/interfaces/10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md b/modules/brk-client/docs/interfaces/10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md index cb5bc00cc..6a4667600 100644 --- a/modules/brk-client/docs/interfaces/10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md +++ b/modules/brk-client/docs/interfaces/10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md @@ -4,108 +4,102 @@ [brk-client](../globals.md) / \_10y1m1w1y2y3m3y4y5y6m6y8yPattern2 -# Interface: \_10y1m1w1y2y3m3y4y5y6m6y8yPattern2\ +# Interface: \_10y1m1w1y2y3m3y4y5y6m6y8yPattern2 -Defined in: [Developer/brk/modules/brk-client/index.js:2502](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2502) - -## Type Parameters - -### T - -`T` +Defined in: [Developer/brk/modules/brk-client/index.js:1704](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1704) ## Properties ### \_10y -> **\_10y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_10y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2503](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2503) +Defined in: [Developer/brk/modules/brk-client/index.js:1705](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1705) *** ### \_1m -> **\_1m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_1m**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2504](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2504) +Defined in: [Developer/brk/modules/brk-client/index.js:1706](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1706) *** ### \_1w -> **\_1w**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_1w**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2505](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2505) +Defined in: [Developer/brk/modules/brk-client/index.js:1707](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1707) *** ### \_1y -> **\_1y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_1y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2506](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2506) +Defined in: [Developer/brk/modules/brk-client/index.js:1708](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1708) *** ### \_2y -> **\_2y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_2y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2507](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2507) +Defined in: [Developer/brk/modules/brk-client/index.js:1709](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1709) *** ### \_3m -> **\_3m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_3m**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2508](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2508) +Defined in: [Developer/brk/modules/brk-client/index.js:1710](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1710) *** ### \_3y -> **\_3y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_3y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2509](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2509) +Defined in: [Developer/brk/modules/brk-client/index.js:1711](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1711) *** ### \_4y -> **\_4y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_4y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2510](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2510) +Defined in: [Developer/brk/modules/brk-client/index.js:1712](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1712) *** ### \_5y -> **\_5y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_5y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2511](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2511) +Defined in: [Developer/brk/modules/brk-client/index.js:1713](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1713) *** ### \_6m -> **\_6m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_6m**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2512](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2512) +Defined in: [Developer/brk/modules/brk-client/index.js:1714](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1714) *** ### \_6y -> **\_6y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_6y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2513](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2513) +Defined in: [Developer/brk/modules/brk-client/index.js:1715](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1715) *** ### \_8y -> **\_8y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> +> **\_8y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2514](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2514) +Defined in: [Developer/brk/modules/brk-client/index.js:1716](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1716) diff --git a/modules/brk-client/docs/interfaces/10y1m1w1y2y3m3y4y5y6m6y8yPattern3.md b/modules/brk-client/docs/interfaces/10y1m1w1y2y3m3y4y5y6m6y8yPattern3.md index b7ccf52db..fc96c5970 100644 --- a/modules/brk-client/docs/interfaces/10y1m1w1y2y3m3y4y5y6m6y8yPattern3.md +++ b/modules/brk-client/docs/interfaces/10y1m1w1y2y3m3y4y5y6m6y8yPattern3.md @@ -6,100 +6,100 @@ # Interface: \_10y1m1w1y2y3m3y4y5y6m6y8yPattern3 -Defined in: [Developer/brk/modules/brk-client/index.js:2384](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2384) +Defined in: [Developer/brk/modules/brk-client/index.js:1743](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1743) ## Properties ### \_10y -> **\_10y**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_10y**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2385](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2385) +Defined in: [Developer/brk/modules/brk-client/index.js:1744](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1744) *** ### \_1m -> **\_1m**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_1m**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2386](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2386) +Defined in: [Developer/brk/modules/brk-client/index.js:1745](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1745) *** ### \_1w -> **\_1w**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_1w**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2387](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2387) +Defined in: [Developer/brk/modules/brk-client/index.js:1746](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1746) *** ### \_1y -> **\_1y**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_1y**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2388](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2388) +Defined in: [Developer/brk/modules/brk-client/index.js:1747](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1747) *** ### \_2y -> **\_2y**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_2y**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2389](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2389) +Defined in: [Developer/brk/modules/brk-client/index.js:1748](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1748) *** ### \_3m -> **\_3m**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_3m**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2390](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2390) +Defined in: [Developer/brk/modules/brk-client/index.js:1749](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1749) *** ### \_3y -> **\_3y**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_3y**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2391](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2391) +Defined in: [Developer/brk/modules/brk-client/index.js:1750](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1750) *** ### \_4y -> **\_4y**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_4y**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2392](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2392) +Defined in: [Developer/brk/modules/brk-client/index.js:1751](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1751) *** ### \_5y -> **\_5y**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_5y**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2393](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2393) +Defined in: [Developer/brk/modules/brk-client/index.js:1752](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1752) *** ### \_6m -> **\_6m**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_6m**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2394](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2394) +Defined in: [Developer/brk/modules/brk-client/index.js:1753](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1753) *** ### \_6y -> **\_6y**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_6y**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2395](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2395) +Defined in: [Developer/brk/modules/brk-client/index.js:1754](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1754) *** ### \_8y -> **\_8y**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) +> **\_8y**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2396](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2396) +Defined in: [Developer/brk/modules/brk-client/index.js:1755](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1755) diff --git a/modules/brk-client/docs/interfaces/10y2y3y4y5y6y8yPattern.md b/modules/brk-client/docs/interfaces/10y2y3y4y5y6y8yPattern.md index 7ac4c7eb6..4801aa34b 100644 --- a/modules/brk-client/docs/interfaces/10y2y3y4y5y6y8yPattern.md +++ b/modules/brk-client/docs/interfaces/10y2y3y4y5y6y8yPattern.md @@ -6,60 +6,60 @@ # Interface: \_10y2y3y4y5y6y8yPattern -Defined in: [Developer/brk/modules/brk-client/index.js:2832](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2832) +Defined in: [Developer/brk/modules/brk-client/index.js:1985](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1985) ## Properties ### \_10y -> **\_10y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **\_10y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2833](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2833) +Defined in: [Developer/brk/modules/brk-client/index.js:1986](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1986) *** ### \_2y -> **\_2y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **\_2y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2834](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2834) +Defined in: [Developer/brk/modules/brk-client/index.js:1987](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1987) *** ### \_3y -> **\_3y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **\_3y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2835](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2835) +Defined in: [Developer/brk/modules/brk-client/index.js:1988](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1988) *** ### \_4y -> **\_4y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **\_4y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2836](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2836) +Defined in: [Developer/brk/modules/brk-client/index.js:1989](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1989) *** ### \_5y -> **\_5y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **\_5y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2837](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2837) +Defined in: [Developer/brk/modules/brk-client/index.js:1990](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1990) *** ### \_6y -> **\_6y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **\_6y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2838](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2838) +Defined in: [Developer/brk/modules/brk-client/index.js:1991](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1991) *** ### \_8y -> **\_8y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **\_8y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2839](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2839) +Defined in: [Developer/brk/modules/brk-client/index.js:1992](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1992) diff --git a/modules/brk-client/docs/interfaces/1m1w1y24hBlockPattern.md b/modules/brk-client/docs/interfaces/1m1w1y24hBlockPattern.md new file mode 100644 index 000000000..298b98959 --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y24hBlockPattern.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y24hBlockPattern + +# Interface: \_1m1w1y24hBlockPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2404](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2404) + +## Properties + +### \_1m + +> **\_1m**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2405](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2405) + +*** + +### \_1w + +> **\_1w**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2406](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2406) + +*** + +### \_1y + +> **\_1y**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2407](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2407) + +*** + +### \_24h + +> **\_24h**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2408](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2408) + +*** + +### block + +> **block**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2409](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2409) diff --git a/modules/brk-client/docs/interfaces/1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md b/modules/brk-client/docs/interfaces/1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md deleted file mode 100644 index 8b2a27003..000000000 --- a/modules/brk-client/docs/interfaces/1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / \_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern - -# Interface: \_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:2298](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2298) - -## Properties - -### \_1mBlocksMined - -> **\_1mBlocksMined**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2299](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2299) - -*** - -### \_1mDominance - -> **\_1mDominance**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2300](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2300) - -*** - -### \_1wBlocksMined - -> **\_1wBlocksMined**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2301](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2301) - -*** - -### \_1wDominance - -> **\_1wDominance**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2302](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2302) - -*** - -### \_1yBlocksMined - -> **\_1yBlocksMined**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2303](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2303) - -*** - -### \_1yDominance - -> **\_1yDominance**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2304](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2304) - -*** - -### \_24hBlocksMined - -> **\_24hBlocksMined**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2305](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2305) - -*** - -### \_24hDominance - -> **\_24hDominance**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2306](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2306) - -*** - -### blocksMined - -> **blocksMined**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2307](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2307) - -*** - -### blocksSinceBlock - -> **blocksSinceBlock**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2308](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2308) - -*** - -### coinbase - -> **coinbase**: [`BitcoinDollarsSatsPattern6`](BitcoinDollarsSatsPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2309](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2309) - -*** - -### daysSinceBlock - -> **daysSinceBlock**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2310](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2310) - -*** - -### dominance - -> **dominance**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2311](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2311) - -*** - -### fee - -> **fee**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2312](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2312) - -*** - -### subsidy - -> **subsidy**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2313](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2313) diff --git a/modules/brk-client/docs/interfaces/1m1w1y24hBpsPercentRatioPattern.md b/modules/brk-client/docs/interfaces/1m1w1y24hBpsPercentRatioPattern.md new file mode 100644 index 000000000..6886a640e --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y24hBpsPercentRatioPattern.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y24hBpsPercentRatioPattern + +# Interface: \_1m1w1y24hBpsPercentRatioPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2014](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2014) + +## Properties + +### \_1m + +> **\_1m**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2015](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2015) + +*** + +### \_1w + +> **\_1w**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2016](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2016) + +*** + +### \_1y + +> **\_1y**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2017](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2017) + +*** + +### \_24h + +> **\_24h**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2018](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2018) + +*** + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2019](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2019) + +*** + +### percent + +> **percent**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2020](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2020) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2021](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2021) diff --git a/modules/brk-client/docs/interfaces/1m1w1y24hPattern.md b/modules/brk-client/docs/interfaces/1m1w1y24hPattern.md new file mode 100644 index 000000000..09c3470a0 --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y24hPattern.md @@ -0,0 +1,47 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y24hPattern + +# Interface: \_1m1w1y24hPattern\ + +Defined in: [Developer/brk/modules/brk-client/index.js:3207](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3207) + +## Type Parameters + +### T + +`T` + +## Properties + +### \_1m + +> **\_1m**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3208](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3208) + +*** + +### \_1w + +> **\_1w**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3209](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3209) + +*** + +### \_1y + +> **\_1y**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3210](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3210) + +*** + +### \_24h + +> **\_24h**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3211](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3211) diff --git a/modules/brk-client/docs/interfaces/1m1w1y24hPattern2.md b/modules/brk-client/docs/interfaces/1m1w1y24hPattern2.md new file mode 100644 index 000000000..e419e21e8 --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y24hPattern2.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y24hPattern2 + +# Interface: \_1m1w1y24hPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:2738](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2738) + +## Properties + +### \_1m + +> **\_1m**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2739](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2739) + +*** + +### \_1w + +> **\_1w**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2740](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2740) + +*** + +### \_1y + +> **\_1y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2741](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2741) + +*** + +### \_24h + +> **\_24h**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2742](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2742) diff --git a/modules/brk-client/docs/interfaces/1m1w1y24hPattern3.md b/modules/brk-client/docs/interfaces/1m1w1y24hPattern3.md new file mode 100644 index 000000000..9e00b6f96 --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y24hPattern3.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y24hPattern3 + +# Interface: \_1m1w1y24hPattern3 + +Defined in: [Developer/brk/modules/brk-client/index.js:2784](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2784) + +## Properties + +### \_1m + +> **\_1m**: [`BtcCentsSatsUsdPattern`](BtcCentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2785](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2785) + +*** + +### \_1w + +> **\_1w**: [`BtcCentsSatsUsdPattern`](BtcCentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2786](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2786) + +*** + +### \_1y + +> **\_1y**: [`BtcCentsSatsUsdPattern`](BtcCentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2787](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2787) + +*** + +### \_24h + +> **\_24h**: [`BtcCentsSatsUsdPattern`](BtcCentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2788](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2788) diff --git a/modules/brk-client/docs/interfaces/1m1w1y24hPattern4.md b/modules/brk-client/docs/interfaces/1m1w1y24hPattern4.md new file mode 100644 index 000000000..f5e6634b2 --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y24hPattern4.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y24hPattern4 + +# Interface: \_1m1w1y24hPattern4 + +Defined in: [Developer/brk/modules/brk-client/index.js:2807](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2807) + +## Properties + +### \_1m + +> **\_1m**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2808](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2808) + +*** + +### \_1w + +> **\_1w**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2809](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2809) + +*** + +### \_1y + +> **\_1y**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2810](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2810) + +*** + +### \_24h + +> **\_24h**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2811](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2811) diff --git a/modules/brk-client/docs/interfaces/1m1w1y24hPattern5.md b/modules/brk-client/docs/interfaces/1m1w1y24hPattern5.md new file mode 100644 index 000000000..0f45689ca --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y24hPattern5.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y24hPattern5 + +# Interface: \_1m1w1y24hPattern5 + +Defined in: [Developer/brk/modules/brk-client/index.js:2853](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2853) + +## Properties + +### \_1m + +> **\_1m**: [`CentsUsdPattern`](CentsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2854](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2854) + +*** + +### \_1w + +> **\_1w**: [`CentsUsdPattern`](CentsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2855](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2855) + +*** + +### \_1y + +> **\_1y**: [`CentsUsdPattern`](CentsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2856](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2856) + +*** + +### \_24h + +> **\_24h**: [`CentsUsdPattern`](CentsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2857](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2857) diff --git a/modules/brk-client/docs/interfaces/1m1w1y24hPattern6.md b/modules/brk-client/docs/interfaces/1m1w1y24hPattern6.md new file mode 100644 index 000000000..5197fcfe4 --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y24hPattern6.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y24hPattern6 + +# Interface: \_1m1w1y24hPattern6 + +Defined in: [Developer/brk/modules/brk-client/index.js:2876](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2876) + +## Properties + +### \_1m + +> **\_1m**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2877](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2877) + +*** + +### \_1w + +> **\_1w**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2878](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2878) + +*** + +### \_1y + +> **\_1y**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2879](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2879) + +*** + +### \_24h + +> **\_24h**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2880](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2880) diff --git a/modules/brk-client/docs/interfaces/1m1w1y24hPattern7.md b/modules/brk-client/docs/interfaces/1m1w1y24hPattern7.md new file mode 100644 index 000000000..ad934fc1b --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y24hPattern7.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y24hPattern7 + +# Interface: \_1m1w1y24hPattern7 + +Defined in: [Developer/brk/modules/brk-client/index.js:2761](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2761) + +## Properties + +### \_1m + +> **\_1m**: [`BpsPercentRatioPattern4`](BpsPercentRatioPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2762](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2762) + +*** + +### \_1w + +> **\_1w**: [`BpsPercentRatioPattern4`](BpsPercentRatioPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2763](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2763) + +*** + +### \_1y + +> **\_1y**: [`BpsPercentRatioPattern4`](BpsPercentRatioPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2764](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2764) + +*** + +### \_24h + +> **\_24h**: [`BpsPercentRatioPattern4`](BpsPercentRatioPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2765](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2765) diff --git a/modules/brk-client/docs/interfaces/1m1w1y2wPattern.md b/modules/brk-client/docs/interfaces/1m1w1y2wPattern.md new file mode 100644 index 000000000..50a6c5eab --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y2wPattern.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y2wPattern + +# Interface: \_1m1w1y2wPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2830](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2830) + +## Properties + +### \_1m + +> **\_1m**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2831](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2831) + +*** + +### \_1w + +> **\_1w**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2832](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2832) + +*** + +### \_1y + +> **\_1y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2833](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2833) + +*** + +### \_2w + +> **\_2w**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2834](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2834) diff --git a/modules/brk-client/docs/interfaces/1m1w1y2y4yAllPattern.md b/modules/brk-client/docs/interfaces/1m1w1y2y4yAllPattern.md new file mode 100644 index 000000000..bb5b30add --- /dev/null +++ b/modules/brk-client/docs/interfaces/1m1w1y2y4yAllPattern.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1m1w1y2y4yAllPattern + +# Interface: \_1m1w1y2y4yAllPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2161](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2161) + +## Properties + +### \_1m + +> **\_1m**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2162](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2162) + +*** + +### \_1w + +> **\_1w**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2163](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2163) + +*** + +### \_1y + +> **\_1y**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2164](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2164) + +*** + +### \_2y + +> **\_2y**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2165](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2165) + +*** + +### \_4y + +> **\_4y**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2166](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2166) + +*** + +### all + +> **all**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2167](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2167) diff --git a/modules/brk-client/docs/interfaces/1y2y4yAllPattern.md b/modules/brk-client/docs/interfaces/1y2y4yAllPattern.md new file mode 100644 index 000000000..778547b6b --- /dev/null +++ b/modules/brk-client/docs/interfaces/1y2y4yAllPattern.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_1y2y4yAllPattern + +# Interface: \_1y2y4yAllPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2899](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2899) + +## Properties + +### \_1y + +> **\_1y**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2900](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2900) + +*** + +### \_2y + +> **\_2y**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2901](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2901) + +*** + +### \_4y + +> **\_4y**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2902](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2902) + +*** + +### all + +> **all**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdZscorePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2903](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2903) diff --git a/modules/brk-client/docs/interfaces/201520162017201820192020202120222023202420252026Pattern2.md b/modules/brk-client/docs/interfaces/201520162017201820192020202120222023202420252026Pattern2.md deleted file mode 100644 index 0fb116864..000000000 --- a/modules/brk-client/docs/interfaces/201520162017201820192020202120222023202420252026Pattern2.md +++ /dev/null @@ -1,111 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / \_201520162017201820192020202120222023202420252026Pattern2 - -# Interface: \_201520162017201820192020202120222023202420252026Pattern2\ - -Defined in: [Developer/brk/modules/brk-client/index.js:2543](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2543) - -## Type Parameters - -### T - -`T` - -## Properties - -### \_2015 - -> **\_2015**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2544](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2544) - -*** - -### \_2016 - -> **\_2016**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2545](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2545) - -*** - -### \_2017 - -> **\_2017**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2546](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2546) - -*** - -### \_2018 - -> **\_2018**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2547](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2547) - -*** - -### \_2019 - -> **\_2019**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2548](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2548) - -*** - -### \_2020 - -> **\_2020**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2549](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2549) - -*** - -### \_2021 - -> **\_2021**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2550](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2550) - -*** - -### \_2022 - -> **\_2022**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2551](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2551) - -*** - -### \_2023 - -> **\_2023**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2552](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2552) - -*** - -### \_2024 - -> **\_2024**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2553](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2553) - -*** - -### \_2025 - -> **\_2025**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2554](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2554) - -*** - -### \_2026 - -> **\_2026**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2555](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2555) diff --git a/modules/brk-client/docs/interfaces/24hPattern.md b/modules/brk-client/docs/interfaces/24hPattern.md new file mode 100644 index 000000000..8f1e1a492 --- /dev/null +++ b/modules/brk-client/docs/interfaces/24hPattern.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_24hPattern + +# Interface: \_24hPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:4066](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4066) + +## Properties + +### \_24h + +> **\_24h**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4067](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4067) diff --git a/modules/brk-client/docs/interfaces/30dCountPattern.md b/modules/brk-client/docs/interfaces/30dCountPattern.md deleted file mode 100644 index eb5822ce0..000000000 --- a/modules/brk-client/docs/interfaces/30dCountPattern.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / \_30dCountPattern - -# Interface: \_30dCountPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3309](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3309) - -## Properties - -### \_30dChange - -> **\_30dChange**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3310](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3310) - -*** - -### count - -> **count**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3311](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3311) diff --git a/modules/brk-client/docs/interfaces/30dHalvedTotalPattern.md b/modules/brk-client/docs/interfaces/30dHalvedTotalPattern.md deleted file mode 100644 index 54c92e347..000000000 --- a/modules/brk-client/docs/interfaces/30dHalvedTotalPattern.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / \_30dHalvedTotalPattern - -# Interface: \_30dHalvedTotalPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3162](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3162) - -## Properties - -### \_30dChange - -> **\_30dChange**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3163](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3163) - -*** - -### halved - -> **halved**: [`BitcoinDollarsSatsPattern4`](BitcoinDollarsSatsPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3164](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3164) - -*** - -### total - -> **total**: [`BitcoinDollarsSatsPattern4`](BitcoinDollarsSatsPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3165](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3165) diff --git a/modules/brk-client/docs/interfaces/6bBlockTxPattern.md b/modules/brk-client/docs/interfaces/6bBlockTxPattern.md new file mode 100644 index 000000000..f8502db91 --- /dev/null +++ b/modules/brk-client/docs/interfaces/6bBlockTxPattern.md @@ -0,0 +1,39 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / \_6bBlockTxPattern + +# Interface: \_6bBlockTxPattern\ + +Defined in: [Developer/brk/modules/brk-client/index.js:3637](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3637) + +## Type Parameters + +### T + +`T` + +## Properties + +### \_6b + +> **\_6b**: [`MaxMedianMinPct10Pct25Pct75Pct90Pattern`](MaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3638](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3638) + +*** + +### block + +> **block**: [`MaxMedianMinPct10Pct25Pct75Pct90Pattern`](MaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3639](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3639) + +*** + +### txIndex + +> **txIndex**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3640](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3640) diff --git a/modules/brk-client/docs/interfaces/AbsoluteRatePattern.md b/modules/brk-client/docs/interfaces/AbsoluteRatePattern.md new file mode 100644 index 000000000..931b63bcf --- /dev/null +++ b/modules/brk-client/docs/interfaces/AbsoluteRatePattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AbsoluteRatePattern + +# Interface: AbsoluteRatePattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3659](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3659) + +## Properties + +### absolute + +> **absolute**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3660](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3660) + +*** + +### rate + +> **rate**: [`_1m1w1y24hPattern2`](1m1w1y24hPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3661](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3661) diff --git a/modules/brk-client/docs/interfaces/AbsoluteRatePattern2.md b/modules/brk-client/docs/interfaces/AbsoluteRatePattern2.md new file mode 100644 index 000000000..c4f1b6adc --- /dev/null +++ b/modules/brk-client/docs/interfaces/AbsoluteRatePattern2.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AbsoluteRatePattern2 + +# Interface: AbsoluteRatePattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:3678](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3678) + +## Properties + +### absolute + +> **absolute**: [`_1m1w1y24hPattern5`](1m1w1y24hPattern5.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3679](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3679) + +*** + +### rate + +> **rate**: [`_1m1w1y24hPattern2`](1m1w1y24hPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3680](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3680) diff --git a/modules/brk-client/docs/interfaces/ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md b/modules/brk-client/docs/interfaces/ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md deleted file mode 100644 index f1e640cd9..000000000 --- a/modules/brk-client/docs/interfaces/ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern - -# Interface: ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:2696](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2696) - -## Properties - -### activity - -> **activity**: [`CoinblocksCoindaysSatblocksSatdaysSentPattern`](CoinblocksCoindaysSatblocksSatdaysSentPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2697](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2697) - -*** - -### addrCount - -> **addrCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2698](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2698) - -*** - -### addrCount30dChange - -> **addrCount30dChange**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2699](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2699) - -*** - -### costBasis - -> **costBasis**: [`MaxMinPattern`](MaxMinPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2700](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2700) - -*** - -### outputs - -> **outputs**: [`UtxoPattern`](UtxoPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2701](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2701) - -*** - -### realized - -> **realized**: [`CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern`](CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2702](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2702) - -*** - -### relative - -> **relative**: [`InvestedNegNetNuplSupplyUnrealizedPattern`](InvestedNegNetNuplSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2703](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2703) - -*** - -### supply - -> **supply**: [`_30dHalvedTotalPattern`](30dHalvedTotalPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2704](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2704) - -*** - -### unrealized - -> **unrealized**: [`GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern`](GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2705](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2705) diff --git a/modules/brk-client/docs/interfaces/ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md b/modules/brk-client/docs/interfaces/ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md new file mode 100644 index 000000000..4d4263f8f --- /dev/null +++ b/modules/brk-client/docs/interfaces/ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / ActivityAddrOutputsRealizedSupplyUnrealizedPattern + +# Interface: ActivityAddrOutputsRealizedSupplyUnrealizedPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2188](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2188) + +## Properties + +### activity + +> **activity**: [`TransferPattern`](TransferPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2189](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2189) + +*** + +### addrCount + +> **addrCount**: [`BaseDeltaPattern`](BaseDeltaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2190](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2190) + +*** + +### outputs + +> **outputs**: [`SpendingSpentUnspentPattern`](SpendingSpentUnspentPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2191](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2191) + +*** + +### realized + +> **realized**: [`CapLossMvrvPriceProfitPattern`](CapLossMvrvPriceProfitPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2192](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2192) + +*** + +### supply + +> **supply**: [`DeltaTotalPattern`](DeltaTotalPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2193](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2193) + +*** + +### unrealized + +> **unrealized**: [`NuplPattern`](NuplPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2194](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2194) diff --git a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md b/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md deleted file mode 100644 index ed5dfe5a7..000000000 --- a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern - -# Interface: ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:2861](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2861) - -## Properties - -### activity - -> **activity**: [`CoinblocksCoindaysSatblocksSatdaysSentPattern`](CoinblocksCoindaysSatblocksSatdaysSentPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2862](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2862) - -*** - -### costBasis - -> **costBasis**: [`InvestedMaxMinPercentilesSpotPattern`](InvestedMaxMinPercentilesSpotPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2863](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2863) - -*** - -### outputs - -> **outputs**: [`UtxoPattern`](UtxoPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2864](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2864) - -*** - -### realized - -> **realized**: [`CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2`](CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2865](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2865) - -*** - -### relative - -> **relative**: [`InvestedNegNetSupplyUnrealizedPattern`](InvestedNegNetSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2866](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2866) - -*** - -### supply - -> **supply**: [`_30dHalvedTotalPattern`](30dHalvedTotalPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2867](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2867) - -*** - -### unrealized - -> **unrealized**: [`GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern`](GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2868](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2868) diff --git a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md b/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md deleted file mode 100644 index 1153edcd5..000000000 --- a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3 - -# Interface: ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3 - -Defined in: [Developer/brk/modules/brk-client/index.js:2977](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2977) - -## Properties - -### activity - -> **activity**: [`CoinblocksCoindaysSatblocksSatdaysSentPattern`](CoinblocksCoindaysSatblocksSatdaysSentPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2978](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2978) - -*** - -### costBasis - -> **costBasis**: [`MaxMinPattern`](MaxMinPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2979](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2979) - -*** - -### outputs - -> **outputs**: [`UtxoPattern`](UtxoPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2980](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2980) - -*** - -### realized - -> **realized**: [`CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern`](CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2981](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2981) - -*** - -### relative - -> **relative**: [`InvestedSupplyPattern`](InvestedSupplyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2982](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2982) - -*** - -### supply - -> **supply**: [`_30dHalvedTotalPattern`](30dHalvedTotalPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2983](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2983) - -*** - -### unrealized - -> **unrealized**: [`GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern`](GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2984](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2984) diff --git a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md b/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md deleted file mode 100644 index d93dcdbb3..000000000 --- a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4 - -# Interface: ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4 - -Defined in: [Developer/brk/modules/brk-client/index.js:2919](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2919) - -## Properties - -### activity - -> **activity**: [`CoinblocksCoindaysSatblocksSatdaysSentPattern`](CoinblocksCoindaysSatblocksSatdaysSentPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2920](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2920) - -*** - -### costBasis - -> **costBasis**: [`MaxMinPattern`](MaxMinPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2921](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2921) - -*** - -### outputs - -> **outputs**: [`UtxoPattern`](UtxoPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2922](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2922) - -*** - -### realized - -> **realized**: [`CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern`](CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2923](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2923) - -*** - -### relative - -> **relative**: [`InvestedNegNetNuplSupplyUnrealizedPattern`](InvestedNegNetNuplSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2924](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2924) - -*** - -### supply - -> **supply**: [`_30dHalvedTotalPattern`](30dHalvedTotalPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2925](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2925) - -*** - -### unrealized - -> **unrealized**: [`GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern`](GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2926](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2926) diff --git a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md b/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md deleted file mode 100644 index b310cde5a..000000000 --- a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5 - -# Interface: ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5 - -Defined in: [Developer/brk/modules/brk-client/index.js:2890](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2890) - -## Properties - -### activity - -> **activity**: [`CoinblocksCoindaysSatblocksSatdaysSentPattern`](CoinblocksCoindaysSatblocksSatdaysSentPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2891](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2891) - -*** - -### costBasis - -> **costBasis**: [`MaxMinPattern`](MaxMinPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2892](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2892) - -*** - -### outputs - -> **outputs**: [`UtxoPattern`](UtxoPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2893](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2893) - -*** - -### realized - -> **realized**: [`AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2`](AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2894](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2894) - -*** - -### relative - -> **relative**: [`InvestedNegNetNuplSupplyUnrealizedPattern3`](InvestedNegNetNuplSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2895](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2895) - -*** - -### supply - -> **supply**: [`_30dHalvedTotalPattern`](30dHalvedTotalPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2896](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2896) - -*** - -### unrealized - -> **unrealized**: [`GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern`](GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2897](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2897) diff --git a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md b/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md deleted file mode 100644 index dd6d08d16..000000000 --- a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6 - -# Interface: ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6 - -Defined in: [Developer/brk/modules/brk-client/index.js:2948](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2948) - -## Properties - -### activity - -> **activity**: [`CoinblocksCoindaysSatblocksSatdaysSentPattern`](CoinblocksCoindaysSatblocksSatdaysSentPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2949](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2949) - -*** - -### costBasis - -> **costBasis**: [`MaxMinPattern`](MaxMinPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2950](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2950) - -*** - -### outputs - -> **outputs**: [`UtxoPattern`](UtxoPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2951](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2951) - -*** - -### realized - -> **realized**: [`CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern`](CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2952](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2952) - -*** - -### relative - -> **relative**: [`InvestedNegNetNuplSupplyUnrealizedPattern3`](InvestedNegNetNuplSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2953](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2953) - -*** - -### supply - -> **supply**: [`_30dHalvedTotalPattern`](30dHalvedTotalPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2954](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2954) - -*** - -### unrealized - -> **unrealized**: [`GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern`](GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2955](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2955) diff --git a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedSupplyUnrealizedPattern.md b/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedSupplyUnrealizedPattern.md deleted file mode 100644 index 60e65c856..000000000 --- a/modules/brk-client/docs/interfaces/ActivityCostOutputsRealizedSupplyUnrealizedPattern.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / ActivityCostOutputsRealizedSupplyUnrealizedPattern - -# Interface: ActivityCostOutputsRealizedSupplyUnrealizedPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3006](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3006) - -## Properties - -### activity - -> **activity**: [`CoinblocksCoindaysSatblocksSatdaysSentPattern`](CoinblocksCoindaysSatblocksSatdaysSentPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3007](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3007) - -*** - -### costBasis - -> **costBasis**: [`MaxMinPattern`](MaxMinPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3008](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3008) - -*** - -### outputs - -> **outputs**: [`UtxoPattern`](UtxoPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3009](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3009) - -*** - -### realized - -> **realized**: [`CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern`](CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3010](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3010) - -*** - -### supply - -> **supply**: [`_30dHalvedTotalPattern`](30dHalvedTotalPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3011](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3011) - -*** - -### unrealized - -> **unrealized**: [`GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern`](GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3012](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3012) diff --git a/modules/brk-client/docs/interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern.md b/modules/brk-client/docs/interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern.md new file mode 100644 index 000000000..3ee36b574 --- /dev/null +++ b/modules/brk-client/docs/interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / ActivityOutputsRealizedSupplyUnrealizedPattern + +# Interface: ActivityOutputsRealizedSupplyUnrealizedPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2429](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2429) + +## Properties + +### activity + +> **activity**: [`CoindaysTransferPattern`](CoindaysTransferPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2430](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2430) + +*** + +### outputs + +> **outputs**: [`SpendingSpentUnspentPattern`](SpendingSpentUnspentPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2431](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2431) + +*** + +### realized + +> **realized**: [`CapLossMvrvNetPriceProfitSoprPattern`](CapLossMvrvNetPriceProfitSoprPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2432](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2432) + +*** + +### supply + +> **supply**: [`DeltaHalfInToTotalPattern`](DeltaHalfInToTotalPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2433](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2433) + +*** + +### unrealized + +> **unrealized**: [`LossNetNuplProfitPattern`](LossNetNuplProfitPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2434](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2434) diff --git a/modules/brk-client/docs/interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern2.md b/modules/brk-client/docs/interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern2.md new file mode 100644 index 000000000..9c7a1aa70 --- /dev/null +++ b/modules/brk-client/docs/interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern2.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / ActivityOutputsRealizedSupplyUnrealizedPattern2 + +# Interface: ActivityOutputsRealizedSupplyUnrealizedPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:2479](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2479) + +## Properties + +### activity + +> **activity**: [`TransferPattern`](TransferPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2480](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2480) + +*** + +### outputs + +> **outputs**: [`SpendingSpentUnspentPattern`](SpendingSpentUnspentPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2481](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2481) + +*** + +### realized + +> **realized**: [`CapLossMvrvPriceProfitPattern`](CapLossMvrvPriceProfitPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2482](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2482) + +*** + +### supply + +> **supply**: [`DeltaTotalPattern`](DeltaTotalPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2483](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2483) + +*** + +### unrealized + +> **unrealized**: [`NuplPattern`](NuplPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2484](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2484) diff --git a/modules/brk-client/docs/interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern3.md b/modules/brk-client/docs/interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern3.md new file mode 100644 index 000000000..2557ee92c --- /dev/null +++ b/modules/brk-client/docs/interfaces/ActivityOutputsRealizedSupplyUnrealizedPattern3.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / ActivityOutputsRealizedSupplyUnrealizedPattern3 + +# Interface: ActivityOutputsRealizedSupplyUnrealizedPattern3 + +Defined in: [Developer/brk/modules/brk-client/index.js:2454](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2454) + +## Properties + +### activity + +> **activity**: [`TransferPattern`](TransferPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2455](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2455) + +*** + +### outputs + +> **outputs**: [`SpendingSpentUnspentPattern`](SpendingSpentUnspentPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2456](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2456) + +*** + +### realized + +> **realized**: [`CapLossMvrvPriceProfitPattern`](CapLossMvrvPriceProfitPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2457](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2457) + +*** + +### supply + +> **supply**: [`DeltaHalfInTotalPattern2`](DeltaHalfInTotalPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2458](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2458) + +*** + +### unrealized + +> **unrealized**: [`LossNuplProfitPattern`](LossNuplProfitPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2459](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2459) diff --git a/modules/brk-client/docs/interfaces/AddressChainStats.md b/modules/brk-client/docs/interfaces/AddrChainStats.md similarity index 56% rename from modules/brk-client/docs/interfaces/AddressChainStats.md rename to modules/brk-client/docs/interfaces/AddrChainStats.md index 35d70164b..cc057ce8d 100644 --- a/modules/brk-client/docs/interfaces/AddressChainStats.md +++ b/modules/brk-client/docs/interfaces/AddrChainStats.md @@ -2,11 +2,11 @@ *** -[brk-client](../globals.md) / AddressChainStats +[brk-client](../globals.md) / AddrChainStats -# Interface: AddressChainStats +# Interface: AddrChainStats -Defined in: [Developer/brk/modules/brk-client/index.js:16](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L16) +Defined in: [Developer/brk/modules/brk-client/index.js:16](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L16) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:16](https://github.com/bi > **fundedTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:17](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L17) +Defined in: [Developer/brk/modules/brk-client/index.js:17](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L17) Total number of transaction outputs that funded this address @@ -24,7 +24,7 @@ Total number of transaction outputs that funded this address > **fundedTxoSum**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:18](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L18) +Defined in: [Developer/brk/modules/brk-client/index.js:18](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L18) Total amount in satoshis received by this address across all funded outputs @@ -34,7 +34,7 @@ Total amount in satoshis received by this address across all funded outputs > **spentTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:19](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L19) +Defined in: [Developer/brk/modules/brk-client/index.js:19](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L19) Total number of transaction outputs spent from this address @@ -44,7 +44,7 @@ Total number of transaction outputs spent from this address > **spentTxoSum**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:20](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L20) +Defined in: [Developer/brk/modules/brk-client/index.js:20](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L20) Total amount in satoshis spent from this address @@ -54,7 +54,7 @@ Total amount in satoshis spent from this address > **txCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:21](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L21) +Defined in: [Developer/brk/modules/brk-client/index.js:21](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L21) Total number of confirmed transactions involving this address @@ -64,6 +64,6 @@ Total number of confirmed transactions involving this address > **typeIndex**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:22](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L22) +Defined in: [Developer/brk/modules/brk-client/index.js:22](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L22) Index of this address within its type on the blockchain diff --git a/modules/brk-client/docs/interfaces/AddressMempoolStats.md b/modules/brk-client/docs/interfaces/AddrMempoolStats.md similarity index 56% rename from modules/brk-client/docs/interfaces/AddressMempoolStats.md rename to modules/brk-client/docs/interfaces/AddrMempoolStats.md index 85391281d..fd856b135 100644 --- a/modules/brk-client/docs/interfaces/AddressMempoolStats.md +++ b/modules/brk-client/docs/interfaces/AddrMempoolStats.md @@ -2,11 +2,11 @@ *** -[brk-client](../globals.md) / AddressMempoolStats +[brk-client](../globals.md) / AddrMempoolStats -# Interface: AddressMempoolStats +# Interface: AddrMempoolStats -Defined in: [Developer/brk/modules/brk-client/index.js:29](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L29) +Defined in: [Developer/brk/modules/brk-client/index.js:29](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L29) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:29](https://github.com/bi > **fundedTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:30](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L30) +Defined in: [Developer/brk/modules/brk-client/index.js:30](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L30) Number of unconfirmed transaction outputs funding this address @@ -24,7 +24,7 @@ Number of unconfirmed transaction outputs funding this address > **fundedTxoSum**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:31](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L31) +Defined in: [Developer/brk/modules/brk-client/index.js:31](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L31) Total amount in satoshis being received in unconfirmed transactions @@ -34,7 +34,7 @@ Total amount in satoshis being received in unconfirmed transactions > **spentTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:32](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L32) +Defined in: [Developer/brk/modules/brk-client/index.js:32](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L32) Number of unconfirmed transaction inputs spending from this address @@ -44,7 +44,7 @@ Number of unconfirmed transaction inputs spending from this address > **spentTxoSum**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:33](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L33) +Defined in: [Developer/brk/modules/brk-client/index.js:33](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L33) Total amount in satoshis being spent in unconfirmed transactions @@ -54,6 +54,6 @@ Total amount in satoshis being spent in unconfirmed transactions > **txCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:34](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L34) +Defined in: [Developer/brk/modules/brk-client/index.js:34](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L34) Number of unconfirmed transactions involving this address diff --git a/modules/brk-client/docs/interfaces/AddrParam.md b/modules/brk-client/docs/interfaces/AddrParam.md new file mode 100644 index 000000000..41a3db18f --- /dev/null +++ b/modules/brk-client/docs/interfaces/AddrParam.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AddrParam + +# Interface: AddrParam + +Defined in: [Developer/brk/modules/brk-client/index.js:37](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L37) + +## Properties + +### address + +> **address**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:38](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L38) diff --git a/modules/brk-client/docs/interfaces/AddrStats.md b/modules/brk-client/docs/interfaces/AddrStats.md new file mode 100644 index 000000000..9f517e6e1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/AddrStats.md @@ -0,0 +1,39 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AddrStats + +# Interface: AddrStats + +Defined in: [Developer/brk/modules/brk-client/index.js:43](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L43) + +## Properties + +### address + +> **address**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:44](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L44) + +Bitcoin address string + +*** + +### chainStats + +> **chainStats**: [`AddrChainStats`](AddrChainStats.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:45](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L45) + +Statistics for confirmed transactions on the blockchain + +*** + +### mempoolStats? + +> `optional` **mempoolStats?**: [`AddrMempoolStats`](AddrMempoolStats.md) \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:46](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L46) + +Statistics for unconfirmed transactions in the mempool diff --git a/modules/brk-client/docs/interfaces/AddrTxidsParam.md b/modules/brk-client/docs/interfaces/AddrTxidsParam.md new file mode 100644 index 000000000..30b7a206e --- /dev/null +++ b/modules/brk-client/docs/interfaces/AddrTxidsParam.md @@ -0,0 +1,19 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AddrTxidsParam + +# Interface: AddrTxidsParam + +Defined in: [Developer/brk/modules/brk-client/index.js:49](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L49) + +## Properties + +### afterTxid? + +> `optional` **afterTxid?**: `string` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:50](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L50) + +Txid to paginate from (return transactions before this one) diff --git a/modules/brk-client/docs/interfaces/AddrValidation.md b/modules/brk-client/docs/interfaces/AddrValidation.md new file mode 100644 index 000000000..6e74bcb94 --- /dev/null +++ b/modules/brk-client/docs/interfaces/AddrValidation.md @@ -0,0 +1,79 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AddrValidation + +# Interface: AddrValidation + +Defined in: [Developer/brk/modules/brk-client/index.js:55](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L55) + +## Properties + +### address? + +> `optional` **address?**: `string` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:57](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L57) + +The validated address + +*** + +### isscript? + +> `optional` **isscript?**: `boolean` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:59](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L59) + +Whether this is a script address (P2SH) + +*** + +### isvalid + +> **isvalid**: `boolean` + +Defined in: [Developer/brk/modules/brk-client/index.js:56](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L56) + +Whether the address is valid + +*** + +### iswitness? + +> `optional` **iswitness?**: `boolean` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:60](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L60) + +Whether this is a witness address + +*** + +### scriptPubKey? + +> `optional` **scriptPubKey?**: `string` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:58](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L58) + +The scriptPubKey in hex + +*** + +### witnessProgram? + +> `optional` **witnessProgram?**: `string` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:62](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L62) + +Witness program in hex + +*** + +### witnessVersion? + +> `optional` **witnessVersion?**: `number` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:61](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L61) + +Witness version (0 for P2WPKH/P2WSH, 1 for P2TR) diff --git a/modules/brk-client/docs/interfaces/AddressParam.md b/modules/brk-client/docs/interfaces/AddressParam.md deleted file mode 100644 index 8f740ee6e..000000000 --- a/modules/brk-client/docs/interfaces/AddressParam.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AddressParam - -# Interface: AddressParam - -Defined in: [Developer/brk/modules/brk-client/index.js:37](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L37) - -## Properties - -### address - -> **address**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:38](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L38) diff --git a/modules/brk-client/docs/interfaces/AddressStats.md b/modules/brk-client/docs/interfaces/AddressStats.md deleted file mode 100644 index f64d6e31d..000000000 --- a/modules/brk-client/docs/interfaces/AddressStats.md +++ /dev/null @@ -1,39 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AddressStats - -# Interface: AddressStats - -Defined in: [Developer/brk/modules/brk-client/index.js:43](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L43) - -## Properties - -### address - -> **address**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:44](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L44) - -Bitcoin address string - -*** - -### chainStats - -> **chainStats**: [`AddressChainStats`](AddressChainStats.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:45](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L45) - -Statistics for confirmed transactions on the blockchain - -*** - -### mempoolStats? - -> `optional` **mempoolStats**: [`AddressMempoolStats`](AddressMempoolStats.md) \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:46](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L46) - -Statistics for unconfirmed transactions in the mempool diff --git a/modules/brk-client/docs/interfaces/AddressTxidsParam.md b/modules/brk-client/docs/interfaces/AddressTxidsParam.md deleted file mode 100644 index c58c27ea3..000000000 --- a/modules/brk-client/docs/interfaces/AddressTxidsParam.md +++ /dev/null @@ -1,29 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AddressTxidsParam - -# Interface: AddressTxidsParam - -Defined in: [Developer/brk/modules/brk-client/index.js:49](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L49) - -## Properties - -### afterTxid? - -> `optional` **afterTxid**: `string` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:50](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L50) - -Txid to paginate from (return transactions before this one) - -*** - -### limit? - -> `optional` **limit**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:51](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L51) - -Maximum number of results to return. Defaults to 25 if not specified. diff --git a/modules/brk-client/docs/interfaces/AddressValidation.md b/modules/brk-client/docs/interfaces/AddressValidation.md deleted file mode 100644 index b1a7e3692..000000000 --- a/modules/brk-client/docs/interfaces/AddressValidation.md +++ /dev/null @@ -1,79 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AddressValidation - -# Interface: AddressValidation - -Defined in: [Developer/brk/modules/brk-client/index.js:56](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L56) - -## Properties - -### address? - -> `optional` **address**: `string` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:58](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L58) - -The validated address - -*** - -### isscript? - -> `optional` **isscript**: `boolean` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:60](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L60) - -Whether this is a script address (P2SH) - -*** - -### isvalid - -> **isvalid**: `boolean` - -Defined in: [Developer/brk/modules/brk-client/index.js:57](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L57) - -Whether the address is valid - -*** - -### iswitness? - -> `optional` **iswitness**: `boolean` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:61](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L61) - -Whether this is a witness address - -*** - -### scriptPubKey? - -> `optional` **scriptPubKey**: `string` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:59](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L59) - -The scriptPubKey in hex - -*** - -### witnessProgram? - -> `optional` **witnessProgram**: `string` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:63](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L63) - -Witness program in hex - -*** - -### witnessVersion? - -> `optional` **witnessVersion**: `number` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:62](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L62) - -Witness version (0 for P2WPKH/P2WSH, 1 for P2TR) diff --git a/modules/brk-client/docs/interfaces/AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md b/modules/brk-client/docs/interfaces/AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md deleted file mode 100644 index 452db9856..000000000 --- a/modules/brk-client/docs/interfaces/AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md +++ /dev/null @@ -1,449 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern - -# Interface: AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern - -Defined in: [Developer/brk/modules/brk-client/index.js:1441](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1441) - -## Properties - -### adjustedSopr - -> **adjustedSopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1442](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1442) - -*** - -### adjustedSopr30dEma - -> **adjustedSopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1443](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1443) - -*** - -### adjustedSopr7dEma - -> **adjustedSopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1444](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1444) - -*** - -### adjustedValueCreated - -> **adjustedValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1445](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1445) - -*** - -### adjustedValueDestroyed - -> **adjustedValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1446](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1446) - -*** - -### capitulationFlow - -> **capitulationFlow**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1448](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1448) - -*** - -### capRaw - -> **capRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1447](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1447) - -*** - -### investorCapRaw - -> **investorCapRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1449](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1449) - -*** - -### investorPrice - -> **investorPrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1450](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1450) - -*** - -### investorPriceCents - -> **investorPriceCents**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1451](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1451) - -*** - -### investorPriceExtra - -> **investorPriceExtra**: [`RatioPattern`](RatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1452](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1452) - -*** - -### lossValueCreated - -> **lossValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1453](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1453) - -*** - -### lossValueDestroyed - -> **lossValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1454](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1454) - -*** - -### lowerPriceBand - -> **lowerPriceBand**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1455](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1455) - -*** - -### mvrv - -> **mvrv**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1456](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1456) - -*** - -### negRealizedLoss - -> **negRealizedLoss**: [`CumulativeSumPattern2`](CumulativeSumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1457](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1457) - -*** - -### netRealizedPnl - -> **netRealizedPnl**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1458](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1458) - -*** - -### netRealizedPnl7dEma - -> **netRealizedPnl7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1459](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1459) - -*** - -### netRealizedPnlCumulative30dDelta - -> **netRealizedPnlCumulative30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1460](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1460) - -*** - -### netRealizedPnlCumulative30dDeltaRelToMarketCap - -> **netRealizedPnlCumulative30dDeltaRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1461](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1461) - -*** - -### netRealizedPnlCumulative30dDeltaRelToRealizedCap - -> **netRealizedPnlCumulative30dDeltaRelToRealizedCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1462](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1462) - -*** - -### netRealizedPnlRelToRealizedCap - -> **netRealizedPnlRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1463](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1463) - -*** - -### peakRegret - -> **peakRegret**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1464](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1464) - -*** - -### peakRegretRelToRealizedCap - -> **peakRegretRelToRealizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1465](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1465) - -*** - -### profitFlow - -> **profitFlow**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1466](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1466) - -*** - -### profitValueCreated - -> **profitValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1467](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1467) - -*** - -### profitValueDestroyed - -> **profitValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1468](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1468) - -*** - -### realizedCap - -> **realizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1469](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1469) - -*** - -### realizedCap30dDelta - -> **realizedCap30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1470](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1470) - -*** - -### realizedCapCents - -> **realizedCapCents**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1471](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1471) - -*** - -### realizedCapRelToOwnMarketCap - -> **realizedCapRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1472](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1472) - -*** - -### realizedLoss - -> **realizedLoss**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1473](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1473) - -*** - -### realizedLoss7dEma - -> **realizedLoss7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1474](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1474) - -*** - -### realizedLossRelToRealizedCap - -> **realizedLossRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1475](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1475) - -*** - -### realizedPrice - -> **realizedPrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1476](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1476) - -*** - -### realizedPriceExtra - -> **realizedPriceExtra**: [`RatioPattern`](RatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1477](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1477) - -*** - -### realizedProfit - -> **realizedProfit**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1478](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1478) - -*** - -### realizedProfit7dEma - -> **realizedProfit7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1479](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1479) - -*** - -### realizedProfitRelToRealizedCap - -> **realizedProfitRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1480](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1480) - -*** - -### realizedProfitToLossRatio - -> **realizedProfitToLossRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1481](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1481) - -*** - -### realizedValue - -> **realizedValue**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1482](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1482) - -*** - -### sellSideRiskRatio - -> **sellSideRiskRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1483](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1483) - -*** - -### sellSideRiskRatio30dEma - -> **sellSideRiskRatio30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1484](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1484) - -*** - -### sellSideRiskRatio7dEma - -> **sellSideRiskRatio7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1485](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1485) - -*** - -### sentInLoss - -> **sentInLoss**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1486](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1486) - -*** - -### sentInLoss14dEma - -> **sentInLoss14dEma**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1487](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1487) - -*** - -### sentInProfit - -> **sentInProfit**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1488](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1488) - -*** - -### sentInProfit14dEma - -> **sentInProfit14dEma**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1489](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1489) - -*** - -### sopr - -> **sopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1490](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1490) - -*** - -### sopr30dEma - -> **sopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1491](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1491) - -*** - -### sopr7dEma - -> **sopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1492](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1492) - -*** - -### totalRealizedPnl - -> **totalRealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1493](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1493) - -*** - -### upperPriceBand - -> **upperPriceBand**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1494](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1494) - -*** - -### valueCreated - -> **valueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1495](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1495) - -*** - -### valueDestroyed - -> **valueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1496](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1496) diff --git a/modules/brk-client/docs/interfaces/AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md b/modules/brk-client/docs/interfaces/AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md deleted file mode 100644 index 04f3b8e54..000000000 --- a/modules/brk-client/docs/interfaces/AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md +++ /dev/null @@ -1,433 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2 - -# Interface: AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2 - -Defined in: [Developer/brk/modules/brk-client/index.js:1566](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1566) - -## Properties - -### adjustedSopr - -> **adjustedSopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1567](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1567) - -*** - -### adjustedSopr30dEma - -> **adjustedSopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1568](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1568) - -*** - -### adjustedSopr7dEma - -> **adjustedSopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1569](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1569) - -*** - -### adjustedValueCreated - -> **adjustedValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1570](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1570) - -*** - -### adjustedValueDestroyed - -> **adjustedValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1571](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1571) - -*** - -### capitulationFlow - -> **capitulationFlow**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1573](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1573) - -*** - -### capRaw - -> **capRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1572](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1572) - -*** - -### investorCapRaw - -> **investorCapRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1574](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1574) - -*** - -### investorPrice - -> **investorPrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1575](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1575) - -*** - -### investorPriceCents - -> **investorPriceCents**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1576](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1576) - -*** - -### investorPriceExtra - -> **investorPriceExtra**: [`RatioPattern2`](RatioPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1577](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1577) - -*** - -### lossValueCreated - -> **lossValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1578](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1578) - -*** - -### lossValueDestroyed - -> **lossValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1579](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1579) - -*** - -### lowerPriceBand - -> **lowerPriceBand**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1580](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1580) - -*** - -### mvrv - -> **mvrv**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1581](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1581) - -*** - -### negRealizedLoss - -> **negRealizedLoss**: [`CumulativeSumPattern2`](CumulativeSumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1582](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1582) - -*** - -### netRealizedPnl - -> **netRealizedPnl**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1583](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1583) - -*** - -### netRealizedPnl7dEma - -> **netRealizedPnl7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1584](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1584) - -*** - -### netRealizedPnlCumulative30dDelta - -> **netRealizedPnlCumulative30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1585](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1585) - -*** - -### netRealizedPnlCumulative30dDeltaRelToMarketCap - -> **netRealizedPnlCumulative30dDeltaRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1586](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1586) - -*** - -### netRealizedPnlCumulative30dDeltaRelToRealizedCap - -> **netRealizedPnlCumulative30dDeltaRelToRealizedCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1587](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1587) - -*** - -### netRealizedPnlRelToRealizedCap - -> **netRealizedPnlRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1588](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1588) - -*** - -### peakRegret - -> **peakRegret**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1589](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1589) - -*** - -### peakRegretRelToRealizedCap - -> **peakRegretRelToRealizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1590](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1590) - -*** - -### profitFlow - -> **profitFlow**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1591](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1591) - -*** - -### profitValueCreated - -> **profitValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1592](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1592) - -*** - -### profitValueDestroyed - -> **profitValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1593](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1593) - -*** - -### realizedCap - -> **realizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1594](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1594) - -*** - -### realizedCap30dDelta - -> **realizedCap30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1595](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1595) - -*** - -### realizedCapCents - -> **realizedCapCents**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1596](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1596) - -*** - -### realizedLoss - -> **realizedLoss**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1597](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1597) - -*** - -### realizedLoss7dEma - -> **realizedLoss7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1598](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1598) - -*** - -### realizedLossRelToRealizedCap - -> **realizedLossRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1599](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1599) - -*** - -### realizedPrice - -> **realizedPrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1600](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1600) - -*** - -### realizedPriceExtra - -> **realizedPriceExtra**: [`RatioPattern2`](RatioPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1601](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1601) - -*** - -### realizedProfit - -> **realizedProfit**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1602](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1602) - -*** - -### realizedProfit7dEma - -> **realizedProfit7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1603](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1603) - -*** - -### realizedProfitRelToRealizedCap - -> **realizedProfitRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1604](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1604) - -*** - -### realizedValue - -> **realizedValue**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1605](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1605) - -*** - -### sellSideRiskRatio - -> **sellSideRiskRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1606](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1606) - -*** - -### sellSideRiskRatio30dEma - -> **sellSideRiskRatio30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1607](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1607) - -*** - -### sellSideRiskRatio7dEma - -> **sellSideRiskRatio7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1608](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1608) - -*** - -### sentInLoss - -> **sentInLoss**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1609](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1609) - -*** - -### sentInLoss14dEma - -> **sentInLoss14dEma**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1610](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1610) - -*** - -### sentInProfit - -> **sentInProfit**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1611](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1611) - -*** - -### sentInProfit14dEma - -> **sentInProfit14dEma**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1612](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1612) - -*** - -### sopr - -> **sopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1613](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1613) - -*** - -### sopr30dEma - -> **sopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1614](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1614) - -*** - -### sopr7dEma - -> **sopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1615](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1615) - -*** - -### totalRealizedPnl - -> **totalRealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1616](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1616) - -*** - -### upperPriceBand - -> **upperPriceBand**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1617](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1617) - -*** - -### valueCreated - -> **valueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1618](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1618) - -*** - -### valueDestroyed - -> **valueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1619](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1619) diff --git a/modules/brk-client/docs/interfaces/AdjustedRatioValuePattern.md b/modules/brk-client/docs/interfaces/AdjustedRatioValuePattern.md new file mode 100644 index 000000000..ffca0919b --- /dev/null +++ b/modules/brk-client/docs/interfaces/AdjustedRatioValuePattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AdjustedRatioValuePattern + +# Interface: AdjustedRatioValuePattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3256](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3256) + +## Properties + +### adjusted + +> **adjusted**: [`RatioTransferValuePattern`](RatioTransferValuePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3257](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3257) + +*** + +### ratio + +> **ratio**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3258](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3258) + +*** + +### valueDestroyed + +> **valueDestroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3259](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3259) diff --git a/modules/brk-client/docs/interfaces/AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern.md b/modules/brk-client/docs/interfaces/AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern.md deleted file mode 100644 index 152596e5b..000000000 --- a/modules/brk-client/docs/interfaces/AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern - -# Interface: AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:2729](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2729) - -## Properties - -### all - -> **all**: [`_30dCountPattern`](30dCountPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2730](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2730) - -*** - -### p2a - -> **p2a**: [`_30dCountPattern`](30dCountPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2731](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2731) - -*** - -### p2pk33 - -> **p2pk33**: [`_30dCountPattern`](30dCountPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2732](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2732) - -*** - -### p2pk65 - -> **p2pk65**: [`_30dCountPattern`](30dCountPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2733](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2733) - -*** - -### p2pkh - -> **p2pkh**: [`_30dCountPattern`](30dCountPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2734](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2734) - -*** - -### p2sh - -> **p2sh**: [`_30dCountPattern`](30dCountPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2735](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2735) - -*** - -### p2tr - -> **p2tr**: [`_30dCountPattern`](30dCountPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2736](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2736) - -*** - -### p2wpkh - -> **p2wpkh**: [`_30dCountPattern`](30dCountPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2737](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2737) - -*** - -### p2wsh - -> **p2wsh**: [`_30dCountPattern`](30dCountPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2738](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2738) diff --git a/modules/brk-client/docs/interfaces/AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3.md b/modules/brk-client/docs/interfaces/AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3.md new file mode 100644 index 000000000..d187af6e7 --- /dev/null +++ b/modules/brk-client/docs/interfaces/AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3 + +# Interface: AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3 + +Defined in: [Developer/brk/modules/brk-client/index.js:1874](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1874) + +## Properties + +### all + +> **all**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1875](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1875) + +*** + +### p2a + +> **p2a**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1876](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1876) + +*** + +### p2pk33 + +> **p2pk33**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1877](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1877) + +*** + +### p2pk65 + +> **p2pk65**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1878](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1878) + +*** + +### p2pkh + +> **p2pkh**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1879](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1879) + +*** + +### p2sh + +> **p2sh**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1880](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1880) + +*** + +### p2tr + +> **p2tr**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1881](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1881) + +*** + +### p2wpkh + +> **p2wpkh**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1882](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1882) + +*** + +### p2wsh + +> **p2wsh**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1883](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1883) diff --git a/modules/brk-client/docs/interfaces/AllSthPattern.md b/modules/brk-client/docs/interfaces/AllSthPattern.md new file mode 100644 index 000000000..334bf7d11 --- /dev/null +++ b/modules/brk-client/docs/interfaces/AllSthPattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AllSthPattern + +# Interface: AllSthPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3716](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3716) + +## Properties + +### all + +> **all**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3717](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3717) + +*** + +### sth + +> **sth**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3718](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3718) diff --git a/modules/brk-client/docs/interfaces/AllSthPattern2.md b/modules/brk-client/docs/interfaces/AllSthPattern2.md new file mode 100644 index 000000000..df1533a74 --- /dev/null +++ b/modules/brk-client/docs/interfaces/AllSthPattern2.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AllSthPattern2 + +# Interface: AllSthPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:3697](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3697) + +## Properties + +### all + +> **all**: [`BtcCentsDeltaSatsUsdPattern`](BtcCentsDeltaSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3698](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3698) + +*** + +### sth + +> **sth**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3699](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3699) diff --git a/modules/brk-client/docs/interfaces/AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md b/modules/brk-client/docs/interfaces/AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md index b66569972..d30aa805c 100644 --- a/modules/brk-client/docs/interfaces/AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md +++ b/modules/brk-client/docs/interfaces/AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md @@ -4,94 +4,100 @@ [brk-client](../globals.md) / AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern -# Interface: AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern +# Interface: AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern\ -Defined in: [Developer/brk/modules/brk-client/index.js:2583](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2583) +Defined in: [Developer/brk/modules/brk-client/index.js:1836](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1836) + +## Type Parameters + +### T + +`T` ## Properties ### average -> **average**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> +> **average**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2584](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2584) +Defined in: [Developer/brk/modules/brk-client/index.js:1837](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1837) *** ### base -> **base**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> +> **base**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2585](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2585) +Defined in: [Developer/brk/modules/brk-client/index.js:1838](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1838) *** ### cumulative -> **cumulative**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> +> **cumulative**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2586](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2586) +Defined in: [Developer/brk/modules/brk-client/index.js:1839](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1839) *** ### max -> **max**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> +> **max**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2587](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2587) +Defined in: [Developer/brk/modules/brk-client/index.js:1840](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1840) *** ### median -> **median**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> +> **median**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2588](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2588) +Defined in: [Developer/brk/modules/brk-client/index.js:1841](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1841) *** ### min -> **min**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> +> **min**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2589](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2589) +Defined in: [Developer/brk/modules/brk-client/index.js:1842](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1842) *** ### pct10 -> **pct10**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> +> **pct10**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2590](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2590) +Defined in: [Developer/brk/modules/brk-client/index.js:1843](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1843) *** ### pct25 -> **pct25**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> +> **pct25**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2591](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2591) +Defined in: [Developer/brk/modules/brk-client/index.js:1844](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1844) *** ### pct75 -> **pct75**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> +> **pct75**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2592](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2592) +Defined in: [Developer/brk/modules/brk-client/index.js:1845](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1845) *** ### pct90 -> **pct90**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> +> **pct90**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2593](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2593) +Defined in: [Developer/brk/modules/brk-client/index.js:1846](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1846) *** ### sum -> **sum**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> +> **sum**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2594](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2594) +Defined in: [Developer/brk/modules/brk-client/index.js:1847](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1847) diff --git a/modules/brk-client/docs/interfaces/AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md b/modules/brk-client/docs/interfaces/AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md deleted file mode 100644 index 09e733c79..000000000 --- a/modules/brk-client/docs/interfaces/AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md +++ /dev/null @@ -1,103 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2 - -# Interface: AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2\ - -Defined in: [Developer/brk/modules/brk-client/index.js:2621](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2621) - -## Type Parameters - -### T - -`T` - -## Properties - -### average - -> **average**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2622](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2622) - -*** - -### base - -> **base**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2623](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2623) - -*** - -### cumulative - -> **cumulative**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2624](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2624) - -*** - -### max - -> **max**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2625](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2625) - -*** - -### median - -> **median**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2626](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2626) - -*** - -### min - -> **min**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2627](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2627) - -*** - -### pct10 - -> **pct10**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2628](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2628) - -*** - -### pct25 - -> **pct25**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2629](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2629) - -*** - -### pct75 - -> **pct75**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2630](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2630) - -*** - -### pct90 - -> **pct90**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2631](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2631) - -*** - -### sum - -> **sum**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2632](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2632) diff --git a/modules/brk-client/docs/interfaces/AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md b/modules/brk-client/docs/interfaces/AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md deleted file mode 100644 index 576b09965..000000000 --- a/modules/brk-client/docs/interfaces/AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md +++ /dev/null @@ -1,87 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern - -# Interface: AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern\ - -Defined in: [Developer/brk/modules/brk-client/index.js:2798](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2798) - -## Type Parameters - -### T - -`T` - -## Properties - -### average - -> **average**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2799](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2799) - -*** - -### base - -> **base**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2800](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2800) - -*** - -### max - -> **max**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2801](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2801) - -*** - -### median - -> **median**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2802](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2802) - -*** - -### min - -> **min**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2803](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2803) - -*** - -### pct10 - -> **pct10**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2804](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2804) - -*** - -### pct25 - -> **pct25**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2805](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2805) - -*** - -### pct75 - -> **pct75**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2806](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2806) - -*** - -### pct90 - -> **pct90**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2807](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2807) diff --git a/modules/brk-client/docs/interfaces/AverageBlockCumulativeInSumPattern.md b/modules/brk-client/docs/interfaces/AverageBlockCumulativeInSumPattern.md new file mode 100644 index 000000000..1c149d18d --- /dev/null +++ b/modules/brk-client/docs/interfaces/AverageBlockCumulativeInSumPattern.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AverageBlockCumulativeInSumPattern + +# Interface: AverageBlockCumulativeInSumPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2215](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2215) + +## Properties + +### average + +> **average**: [`_1m1w1y24hPattern3`](1m1w1y24hPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2216](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2216) + +*** + +### block + +> **block**: [`BtcCentsSatsUsdPattern2`](BtcCentsSatsUsdPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2217](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2217) + +*** + +### cumulative + +> **cumulative**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2218](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2218) + +*** + +### inLoss + +> **inLoss**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2219](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2219) + +*** + +### inProfit + +> **inProfit**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2220](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2220) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2221](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2221) diff --git a/modules/brk-client/docs/interfaces/AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md b/modules/brk-client/docs/interfaces/AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md new file mode 100644 index 000000000..efed9b2c6 --- /dev/null +++ b/modules/brk-client/docs/interfaces/AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md @@ -0,0 +1,97 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern + +# Interface: AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:1798](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1798) + +## Properties + +### average + +> **average**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1799](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1799) + +*** + +### block + +> **block**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1800](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1800) + +*** + +### cumulative + +> **cumulative**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1801](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1801) + +*** + +### max + +> **max**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1802](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1802) + +*** + +### median + +> **median**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1803](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1803) + +*** + +### min + +> **min**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1804](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1804) + +*** + +### pct10 + +> **pct10**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1805](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1805) + +*** + +### pct25 + +> **pct25**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1806](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1806) + +*** + +### pct75 + +> **pct75**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1807](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1807) + +*** + +### pct90 + +> **pct90**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1808](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1808) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1809](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1809) diff --git a/modules/brk-client/docs/interfaces/AverageBlockCumulativeSumPattern.md b/modules/brk-client/docs/interfaces/AverageBlockCumulativeSumPattern.md new file mode 100644 index 000000000..9fc7a5657 --- /dev/null +++ b/modules/brk-client/docs/interfaces/AverageBlockCumulativeSumPattern.md @@ -0,0 +1,47 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AverageBlockCumulativeSumPattern + +# Interface: AverageBlockCumulativeSumPattern\ + +Defined in: [Developer/brk/modules/brk-client/index.js:3232](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3232) + +## Type Parameters + +### T + +`T` + +## Properties + +### average + +> **average**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3233](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3233) + +*** + +### block + +> **block**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3234](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3234) + +*** + +### cumulative + +> **cumulative**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3235](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3235) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3236](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3236) diff --git a/modules/brk-client/docs/interfaces/AverageBlockCumulativeSumPattern2.md b/modules/brk-client/docs/interfaces/AverageBlockCumulativeSumPattern2.md new file mode 100644 index 000000000..3165d5445 --- /dev/null +++ b/modules/brk-client/docs/interfaces/AverageBlockCumulativeSumPattern2.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AverageBlockCumulativeSumPattern2 + +# Interface: AverageBlockCumulativeSumPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:2907](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2907) + +## Properties + +### average + +> **average**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2908](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2908) + +*** + +### block + +> **block**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2909](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2909) + +*** + +### cumulative + +> **cumulative**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2910](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2910) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2911](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2911) diff --git a/modules/brk-client/docs/interfaces/AverageBlockCumulativeSumPattern3.md b/modules/brk-client/docs/interfaces/AverageBlockCumulativeSumPattern3.md new file mode 100644 index 000000000..e7d3c0788 --- /dev/null +++ b/modules/brk-client/docs/interfaces/AverageBlockCumulativeSumPattern3.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AverageBlockCumulativeSumPattern3 + +# Interface: AverageBlockCumulativeSumPattern3 + +Defined in: [Developer/brk/modules/brk-client/index.js:2930](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2930) + +## Properties + +### average + +> **average**: [`_1m1w1y24hPattern3`](1m1w1y24hPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2931](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2931) + +*** + +### block + +> **block**: [`BtcCentsSatsUsdPattern2`](BtcCentsSatsUsdPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2932](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2932) + +*** + +### cumulative + +> **cumulative**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2933](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2933) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2934](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2934) diff --git a/modules/brk-client/docs/interfaces/AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md b/modules/brk-client/docs/interfaces/AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md deleted file mode 100644 index 473b0b3e6..000000000 --- a/modules/brk-client/docs/interfaces/AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md +++ /dev/null @@ -1,95 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2 - -# Interface: AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2\ - -Defined in: [Developer/brk/modules/brk-client/index.js:2660](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2660) - -## Type Parameters - -### T - -`T` - -## Properties - -### average - -> **average**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2661](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2661) - -*** - -### cumulative - -> **cumulative**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2662](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2662) - -*** - -### max - -> **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2663](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2663) - -*** - -### median - -> **median**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2664](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2664) - -*** - -### min - -> **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2665](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2665) - -*** - -### pct10 - -> **pct10**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2666](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2666) - -*** - -### pct25 - -> **pct25**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2667](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2667) - -*** - -### pct75 - -> **pct75**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2668](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2668) - -*** - -### pct90 - -> **pct90**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2669](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2669) - -*** - -### sum - -> **sum**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2670](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2670) diff --git a/modules/brk-client/docs/interfaces/AverageMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md b/modules/brk-client/docs/interfaces/AverageMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md new file mode 100644 index 000000000..402990a40 --- /dev/null +++ b/modules/brk-client/docs/interfaces/AverageMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AverageMaxMedianMinPct10Pct25Pct75Pct90SumPattern + +# Interface: AverageMaxMedianMinPct10Pct25Pct75Pct90SumPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:1907](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1907) + +## Properties + +### average + +> **average**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1908](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1908) + +*** + +### max + +> **max**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1909](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1909) + +*** + +### median + +> **median**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1910](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1910) + +*** + +### min + +> **min**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1911](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1911) + +*** + +### pct10 + +> **pct10**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1912](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1912) + +*** + +### pct25 + +> **pct25**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1913](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1913) + +*** + +### pct75 + +> **pct75**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1914](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1914) + +*** + +### pct90 + +> **pct90**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1915](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1915) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1916](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1916) diff --git a/modules/brk-client/docs/interfaces/AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern.md b/modules/brk-client/docs/interfaces/AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern.md deleted file mode 100644 index 77adb1a73..000000000 --- a/modules/brk-client/docs/interfaces/AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern.md +++ /dev/null @@ -1,87 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern - -# Interface: AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern\ - -Defined in: [Developer/brk/modules/brk-client/index.js:2763](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2763) - -## Type Parameters - -### T - -`T` - -## Properties - -### average - -> **average**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2764](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2764) - -*** - -### max - -> **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2765](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2765) - -*** - -### median - -> **median**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2766](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2766) - -*** - -### min - -> **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2767](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2767) - -*** - -### pct10 - -> **pct10**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2768](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2768) - -*** - -### pct25 - -> **pct25**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2769](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2769) - -*** - -### pct75 - -> **pct75**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2770](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2770) - -*** - -### pct90 - -> **pct90**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2771](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2771) - -*** - -### txindex - -> **txindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2772](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2772) diff --git a/modules/brk-client/docs/interfaces/BalanceBothReactivatedReceivingSendingPattern.md b/modules/brk-client/docs/interfaces/BalanceBothReactivatedReceivingSendingPattern.md deleted file mode 100644 index 668a9870c..000000000 --- a/modules/brk-client/docs/interfaces/BalanceBothReactivatedReceivingSendingPattern.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / BalanceBothReactivatedReceivingSendingPattern - -# Interface: BalanceBothReactivatedReceivingSendingPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3033](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3033) - -## Properties - -### balanceDecreased - -> **balanceDecreased**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3034](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3034) - -*** - -### balanceIncreased - -> **balanceIncreased**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3035](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3035) - -*** - -### both - -> **both**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3036](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3036) - -*** - -### reactivated - -> **reactivated**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3037](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3037) - -*** - -### receiving - -> **receiving**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3038](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3038) - -*** - -### sending - -> **sending**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3039](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3039) diff --git a/modules/brk-client/docs/interfaces/BaseCumulativeSumPattern.md b/modules/brk-client/docs/interfaces/BaseCumulativeSumPattern.md deleted file mode 100644 index 4f2aa107e..000000000 --- a/modules/brk-client/docs/interfaces/BaseCumulativeSumPattern.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / BaseCumulativeSumPattern - -# Interface: BaseCumulativeSumPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3183](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3183) - -## Properties - -### base - -> **base**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3184](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3184) - -*** - -### cumulative - -> **cumulative**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3185](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3185) - -*** - -### sum - -> **sum**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3186](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3186) diff --git a/modules/brk-client/docs/interfaces/BaseDeltaPattern.md b/modules/brk-client/docs/interfaces/BaseDeltaPattern.md new file mode 100644 index 000000000..e0212b722 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BaseDeltaPattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BaseDeltaPattern + +# Interface: BaseDeltaPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3755](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3755) + +## Properties + +### base + +> **base**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3756](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3756) + +*** + +### delta + +> **delta**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3757](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3757) diff --git a/modules/brk-client/docs/interfaces/BaseSumPattern.md b/modules/brk-client/docs/interfaces/BaseSumPattern.md new file mode 100644 index 000000000..e21477f8f --- /dev/null +++ b/modules/brk-client/docs/interfaces/BaseSumPattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BaseSumPattern + +# Interface: BaseSumPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3736](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3736) + +## Properties + +### base + +> **base**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3737](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3737) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3738](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3738) diff --git a/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern2.md b/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern2.md deleted file mode 100644 index fc2eb644b..000000000 --- a/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern2.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / BitcoinDollarsSatsPattern2 - -# Interface: BitcoinDollarsSatsPattern2 - -Defined in: [Developer/brk/modules/brk-client/index.js:3204](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3204) - -## Properties - -### bitcoin - -> **bitcoin**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3205](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3205) - -*** - -### dollars - -> **dollars**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3206](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3206) - -*** - -### sats - -> **sats**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3207](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3207) diff --git a/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern3.md b/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern3.md deleted file mode 100644 index 955f7028e..000000000 --- a/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern3.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / BitcoinDollarsSatsPattern3 - -# Interface: BitcoinDollarsSatsPattern3 - -Defined in: [Developer/brk/modules/brk-client/index.js:3288](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3288) - -## Properties - -### bitcoin - -> **bitcoin**: [`CumulativeSumPattern2`](CumulativeSumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3289](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3289) - -*** - -### dollars - -> **dollars**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3290](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3290) - -*** - -### sats - -> **sats**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3291](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3291) diff --git a/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern4.md b/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern4.md deleted file mode 100644 index 0ff2e7a1a..000000000 --- a/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern4.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / BitcoinDollarsSatsPattern4 - -# Interface: BitcoinDollarsSatsPattern4 - -Defined in: [Developer/brk/modules/brk-client/index.js:3225](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3225) - -## Properties - -### bitcoin - -> **bitcoin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3226](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3226) - -*** - -### dollars - -> **dollars**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3227](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3227) - -*** - -### sats - -> **sats**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3228](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3228) diff --git a/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern5.md b/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern5.md deleted file mode 100644 index 9e9f8d2d4..000000000 --- a/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern5.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / BitcoinDollarsSatsPattern5 - -# Interface: BitcoinDollarsSatsPattern5 - -Defined in: [Developer/brk/modules/brk-client/index.js:3246](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3246) - -## Properties - -### bitcoin - -> **bitcoin**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3247](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3247) - -*** - -### dollars - -> **dollars**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3248](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3248) - -*** - -### sats - -> **sats**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3249](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3249) diff --git a/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern6.md b/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern6.md deleted file mode 100644 index 4908e4224..000000000 --- a/modules/brk-client/docs/interfaces/BitcoinDollarsSatsPattern6.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / BitcoinDollarsSatsPattern6 - -# Interface: BitcoinDollarsSatsPattern6 - -Defined in: [Developer/brk/modules/brk-client/index.js:3267](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3267) - -## Properties - -### bitcoin - -> **bitcoin**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3268](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3268) - -*** - -### dollars - -> **dollars**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3269](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3269) - -*** - -### sats - -> **sats**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3270](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3270) diff --git a/modules/brk-client/docs/interfaces/BlockChangeCumulativeDeltaSumPattern.md b/modules/brk-client/docs/interfaces/BlockChangeCumulativeDeltaSumPattern.md new file mode 100644 index 000000000..29cacfc03 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BlockChangeCumulativeDeltaSumPattern.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BlockChangeCumulativeDeltaSumPattern + +# Interface: BlockChangeCumulativeDeltaSumPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2504](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2504) + +## Properties + +### block + +> **block**: [`CentsUsdPattern4`](CentsUsdPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2505](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2505) + +*** + +### change1m + +> **change1m**: [`ToPattern`](ToPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2506](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2506) + +*** + +### cumulative + +> **cumulative**: [`CentsUsdPattern`](CentsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2507](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2507) + +*** + +### delta + +> **delta**: [`AbsoluteRatePattern2`](AbsoluteRatePattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2508](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2508) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern5`](1m1w1y24hPattern5.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2509](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2509) diff --git a/modules/brk-client/docs/interfaces/BlockCountParam.md b/modules/brk-client/docs/interfaces/BlockCountParam.md index be06730b5..b2a9bf9e8 100644 --- a/modules/brk-client/docs/interfaces/BlockCountParam.md +++ b/modules/brk-client/docs/interfaces/BlockCountParam.md @@ -6,7 +6,7 @@ # Interface: BlockCountParam -Defined in: [Developer/brk/modules/brk-client/index.js:81](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L81) +Defined in: [Developer/brk/modules/brk-client/index.js:107](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L107) ## Properties @@ -14,6 +14,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:81](https://github.com/bi > **blockCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:82](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L82) +Defined in: [Developer/brk/modules/brk-client/index.js:108](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L108) Number of recent blocks to include diff --git a/modules/brk-client/docs/interfaces/BlockCumulativeDeltaSumPattern.md b/modules/brk-client/docs/interfaces/BlockCumulativeDeltaSumPattern.md new file mode 100644 index 000000000..b91a514a9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BlockCumulativeDeltaSumPattern.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BlockCumulativeDeltaSumPattern + +# Interface: BlockCumulativeDeltaSumPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2976](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2976) + +## Properties + +### block + +> **block**: [`CentsUsdPattern4`](CentsUsdPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2977](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2977) + +*** + +### cumulative + +> **cumulative**: [`CentsUsdPattern`](CentsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2978](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2978) + +*** + +### delta + +> **delta**: [`AbsoluteRatePattern2`](AbsoluteRatePattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2979](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2979) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern5`](1m1w1y24hPattern5.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2980](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2980) diff --git a/modules/brk-client/docs/interfaces/BlockCumulativeNegativeSumPattern.md b/modules/brk-client/docs/interfaces/BlockCumulativeNegativeSumPattern.md new file mode 100644 index 000000000..6518bbbe1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BlockCumulativeNegativeSumPattern.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BlockCumulativeNegativeSumPattern + +# Interface: BlockCumulativeNegativeSumPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2953](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2953) + +## Properties + +### block + +> **block**: [`CentsUsdPattern2`](CentsUsdPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2954](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2954) + +*** + +### cumulative + +> **cumulative**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2955](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2955) + +*** + +### negative + +> **negative**: [`BaseSumPattern`](BaseSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2956](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2956) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern6`](1m1w1y24hPattern6.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2957](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2957) diff --git a/modules/brk-client/docs/interfaces/BlockCumulativePattern.md b/modules/brk-client/docs/interfaces/BlockCumulativePattern.md new file mode 100644 index 000000000..7617ea811 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BlockCumulativePattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BlockCumulativePattern + +# Interface: BlockCumulativePattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3774](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3774) + +## Properties + +### block + +> **block**: [`BtcCentsSatsUsdPattern2`](BtcCentsSatsUsdPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3775](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3775) + +*** + +### cumulative + +> **cumulative**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3776](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3776) diff --git a/modules/brk-client/docs/interfaces/BlockCumulativeSumPattern.md b/modules/brk-client/docs/interfaces/BlockCumulativeSumPattern.md new file mode 100644 index 000000000..e796c19c6 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BlockCumulativeSumPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BlockCumulativeSumPattern + +# Interface: BlockCumulativeSumPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3277](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3277) + +## Properties + +### block + +> **block**: [`CentsUsdPattern2`](CentsUsdPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3278](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3278) + +*** + +### cumulative + +> **cumulative**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3279](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3279) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern6`](1m1w1y24hPattern6.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3280](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3280) diff --git a/modules/brk-client/docs/interfaces/BlockFeesEntry.md b/modules/brk-client/docs/interfaces/BlockFeesEntry.md index bfd80f7c1..c76edb532 100644 --- a/modules/brk-client/docs/interfaces/BlockFeesEntry.md +++ b/modules/brk-client/docs/interfaces/BlockFeesEntry.md @@ -6,7 +6,7 @@ # Interface: BlockFeesEntry -Defined in: [Developer/brk/modules/brk-client/index.js:87](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L87) +Defined in: [Developer/brk/modules/brk-client/index.js:113](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L113) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:87](https://github.com/bi > **avgFees**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:90](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L90) +Defined in: [Developer/brk/modules/brk-client/index.js:116](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L116) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:90](https://github.com/bi > **avgHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:88](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L88) +Defined in: [Developer/brk/modules/brk-client/index.js:114](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L114) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:88](https://github.com/bi > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:89](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L89) +Defined in: [Developer/brk/modules/brk-client/index.js:115](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L115) diff --git a/modules/brk-client/docs/interfaces/BlockHashParam.md b/modules/brk-client/docs/interfaces/BlockHashParam.md index cc58e9a99..02c3af6da 100644 --- a/modules/brk-client/docs/interfaces/BlockHashParam.md +++ b/modules/brk-client/docs/interfaces/BlockHashParam.md @@ -6,7 +6,7 @@ # Interface: BlockHashParam -Defined in: [Developer/brk/modules/brk-client/index.js:98](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L98) +Defined in: [Developer/brk/modules/brk-client/index.js:124](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L124) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:98](https://github.com/bi > **hash**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:99](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L99) +Defined in: [Developer/brk/modules/brk-client/index.js:125](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L125) diff --git a/modules/brk-client/docs/interfaces/BlockHashStartIndex.md b/modules/brk-client/docs/interfaces/BlockHashStartIndex.md index f730c8e87..80eaa204a 100644 --- a/modules/brk-client/docs/interfaces/BlockHashStartIndex.md +++ b/modules/brk-client/docs/interfaces/BlockHashStartIndex.md @@ -6,7 +6,7 @@ # Interface: BlockHashStartIndex -Defined in: [Developer/brk/modules/brk-client/index.js:102](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L102) +Defined in: [Developer/brk/modules/brk-client/index.js:128](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L128) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:102](https://github.com/b > **hash**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:103](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L103) +Defined in: [Developer/brk/modules/brk-client/index.js:129](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L129) Bitcoin block hash @@ -24,6 +24,6 @@ Bitcoin block hash > **startIndex**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:104](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L104) +Defined in: [Developer/brk/modules/brk-client/index.js:130](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L130) Starting transaction index within the block (0-based) diff --git a/modules/brk-client/docs/interfaces/BlockHashTxIndex.md b/modules/brk-client/docs/interfaces/BlockHashTxIndex.md index 7e214fcdb..53921e7b5 100644 --- a/modules/brk-client/docs/interfaces/BlockHashTxIndex.md +++ b/modules/brk-client/docs/interfaces/BlockHashTxIndex.md @@ -6,7 +6,7 @@ # Interface: BlockHashTxIndex -Defined in: [Developer/brk/modules/brk-client/index.js:107](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L107) +Defined in: [Developer/brk/modules/brk-client/index.js:133](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L133) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:107](https://github.com/b > **hash**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:108](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L108) +Defined in: [Developer/brk/modules/brk-client/index.js:134](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L134) Bitcoin block hash @@ -24,6 +24,6 @@ Bitcoin block hash > **index**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:109](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L109) +Defined in: [Developer/brk/modules/brk-client/index.js:135](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L135) Transaction index within the block (0-based) diff --git a/modules/brk-client/docs/interfaces/BlockInfo.md b/modules/brk-client/docs/interfaces/BlockInfo.md index 5255298ae..89760c527 100644 --- a/modules/brk-client/docs/interfaces/BlockInfo.md +++ b/modules/brk-client/docs/interfaces/BlockInfo.md @@ -6,7 +6,7 @@ # Interface: BlockInfo -Defined in: [Developer/brk/modules/brk-client/index.js:114](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L114) +Defined in: [Developer/brk/modules/brk-client/index.js:140](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L140) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:114](https://github.com/b > **difficulty**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:121](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L121) +Defined in: [Developer/brk/modules/brk-client/index.js:147](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L147) Block difficulty as a floating point number @@ -24,7 +24,7 @@ Block difficulty as a floating point number > **height**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:116](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L116) +Defined in: [Developer/brk/modules/brk-client/index.js:142](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L142) Block height @@ -34,7 +34,7 @@ Block height > **id**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:115](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L115) +Defined in: [Developer/brk/modules/brk-client/index.js:141](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L141) Block hash @@ -44,7 +44,7 @@ Block hash > **size**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:118](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L118) +Defined in: [Developer/brk/modules/brk-client/index.js:144](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L144) Block size in bytes @@ -54,7 +54,7 @@ Block size in bytes > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:120](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L120) +Defined in: [Developer/brk/modules/brk-client/index.js:146](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L146) Block timestamp (Unix time) @@ -64,7 +64,7 @@ Block timestamp (Unix time) > **txCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:117](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L117) +Defined in: [Developer/brk/modules/brk-client/index.js:143](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L143) Number of transactions in the block @@ -74,6 +74,6 @@ Number of transactions in the block > **weight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:119](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L119) +Defined in: [Developer/brk/modules/brk-client/index.js:145](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L145) Block weight in weight units diff --git a/modules/brk-client/docs/interfaces/BlockRewardsEntry.md b/modules/brk-client/docs/interfaces/BlockRewardsEntry.md index 42d641da8..5d0fa8592 100644 --- a/modules/brk-client/docs/interfaces/BlockRewardsEntry.md +++ b/modules/brk-client/docs/interfaces/BlockRewardsEntry.md @@ -6,7 +6,7 @@ # Interface: BlockRewardsEntry -Defined in: [Developer/brk/modules/brk-client/index.js:126](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L126) +Defined in: [Developer/brk/modules/brk-client/index.js:152](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L152) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:126](https://github.com/b > **avgHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:127](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L127) +Defined in: [Developer/brk/modules/brk-client/index.js:153](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L153) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:127](https://github.com/b > **avgRewards**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:129](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L129) +Defined in: [Developer/brk/modules/brk-client/index.js:155](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L155) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:129](https://github.com/b > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:128](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L128) +Defined in: [Developer/brk/modules/brk-client/index.js:154](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L154) diff --git a/modules/brk-client/docs/interfaces/BlockSizeEntry.md b/modules/brk-client/docs/interfaces/BlockSizeEntry.md index 608eb73a5..4722d3877 100644 --- a/modules/brk-client/docs/interfaces/BlockSizeEntry.md +++ b/modules/brk-client/docs/interfaces/BlockSizeEntry.md @@ -6,7 +6,7 @@ # Interface: BlockSizeEntry -Defined in: [Developer/brk/modules/brk-client/index.js:134](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L134) +Defined in: [Developer/brk/modules/brk-client/index.js:160](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L160) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:134](https://github.com/b > **avgHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:135](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L135) +Defined in: [Developer/brk/modules/brk-client/index.js:161](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L161) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:135](https://github.com/b > **avgSize**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:137](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L137) +Defined in: [Developer/brk/modules/brk-client/index.js:163](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L163) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:137](https://github.com/b > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:136](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L136) +Defined in: [Developer/brk/modules/brk-client/index.js:162](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L162) diff --git a/modules/brk-client/docs/interfaces/BlockSizesWeights.md b/modules/brk-client/docs/interfaces/BlockSizesWeights.md index f0906d1dd..08045250f 100644 --- a/modules/brk-client/docs/interfaces/BlockSizesWeights.md +++ b/modules/brk-client/docs/interfaces/BlockSizesWeights.md @@ -6,7 +6,7 @@ # Interface: BlockSizesWeights -Defined in: [Developer/brk/modules/brk-client/index.js:142](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L142) +Defined in: [Developer/brk/modules/brk-client/index.js:168](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L168) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:142](https://github.com/b > **sizes**: [`BlockSizeEntry`](BlockSizeEntry.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:143](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L143) +Defined in: [Developer/brk/modules/brk-client/index.js:169](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L169) *** @@ -22,4 +22,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:143](https://github.com/b > **weights**: [`BlockWeightEntry`](BlockWeightEntry.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:144](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L144) +Defined in: [Developer/brk/modules/brk-client/index.js:170](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L170) diff --git a/modules/brk-client/docs/interfaces/BlockStatus.md b/modules/brk-client/docs/interfaces/BlockStatus.md index c1ed58cc3..dc117c99b 100644 --- a/modules/brk-client/docs/interfaces/BlockStatus.md +++ b/modules/brk-client/docs/interfaces/BlockStatus.md @@ -6,15 +6,15 @@ # Interface: BlockStatus -Defined in: [Developer/brk/modules/brk-client/index.js:149](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L149) +Defined in: [Developer/brk/modules/brk-client/index.js:175](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L175) ## Properties ### height? -> `optional` **height**: `number` \| `null` +> `optional` **height?**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:151](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L151) +Defined in: [Developer/brk/modules/brk-client/index.js:177](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L177) Block height (only if in best chain) @@ -24,7 +24,7 @@ Block height (only if in best chain) > **inBestChain**: `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:150](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L150) +Defined in: [Developer/brk/modules/brk-client/index.js:176](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L176) Whether this block is in the best chain @@ -32,8 +32,8 @@ Whether this block is in the best chain ### nextBest? -> `optional` **nextBest**: `string` \| `null` +> `optional` **nextBest?**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:152](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L152) +Defined in: [Developer/brk/modules/brk-client/index.js:178](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L178) Hash of the next block in the best chain (only if in best chain and not tip) diff --git a/modules/brk-client/docs/interfaces/BlockTimestamp.md b/modules/brk-client/docs/interfaces/BlockTimestamp.md index 044571415..8a5529926 100644 --- a/modules/brk-client/docs/interfaces/BlockTimestamp.md +++ b/modules/brk-client/docs/interfaces/BlockTimestamp.md @@ -6,7 +6,7 @@ # Interface: BlockTimestamp -Defined in: [Developer/brk/modules/brk-client/index.js:157](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L157) +Defined in: [Developer/brk/modules/brk-client/index.js:183](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L183) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:157](https://github.com/b > **hash**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:159](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L159) +Defined in: [Developer/brk/modules/brk-client/index.js:185](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L185) Block hash @@ -24,7 +24,7 @@ Block hash > **height**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:158](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L158) +Defined in: [Developer/brk/modules/brk-client/index.js:184](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L184) Block height @@ -34,6 +34,6 @@ Block height > **timestamp**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:160](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L160) +Defined in: [Developer/brk/modules/brk-client/index.js:186](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L186) Block timestamp in ISO 8601 format diff --git a/modules/brk-client/docs/interfaces/BlockWeightEntry.md b/modules/brk-client/docs/interfaces/BlockWeightEntry.md index 7260a9973..ae8c13727 100644 --- a/modules/brk-client/docs/interfaces/BlockWeightEntry.md +++ b/modules/brk-client/docs/interfaces/BlockWeightEntry.md @@ -6,7 +6,7 @@ # Interface: BlockWeightEntry -Defined in: [Developer/brk/modules/brk-client/index.js:165](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L165) +Defined in: [Developer/brk/modules/brk-client/index.js:191](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L191) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:165](https://github.com/b > **avgHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:166](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L166) +Defined in: [Developer/brk/modules/brk-client/index.js:192](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L192) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:166](https://github.com/b > **avgWeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:168](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L168) +Defined in: [Developer/brk/modules/brk-client/index.js:194](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L194) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:168](https://github.com/b > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:167](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L167) +Defined in: [Developer/brk/modules/brk-client/index.js:193](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L193) diff --git a/modules/brk-client/docs/interfaces/BlocksDominancePattern.md b/modules/brk-client/docs/interfaces/BlocksDominancePattern.md new file mode 100644 index 000000000..38d10f12a --- /dev/null +++ b/modules/brk-client/docs/interfaces/BlocksDominancePattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BlocksDominancePattern + +# Interface: BlocksDominancePattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3793](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3793) + +## Properties + +### blocksMined + +> **blocksMined**: [`AverageBlockCumulativeSumPattern2`](AverageBlockCumulativeSumPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3794](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3794) + +*** + +### dominance + +> **dominance**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3795](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3795) diff --git a/modules/brk-client/docs/interfaces/BlocksDominanceRewardsPattern.md b/modules/brk-client/docs/interfaces/BlocksDominanceRewardsPattern.md new file mode 100644 index 000000000..48667f403 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BlocksDominanceRewardsPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BlocksDominanceRewardsPattern + +# Interface: BlocksDominanceRewardsPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3298](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3298) + +## Properties + +### blocksMined + +> **blocksMined**: [`AverageBlockCumulativeSumPattern2`](AverageBlockCumulativeSumPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3299](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3299) + +*** + +### dominance + +> **dominance**: [`_1m1w1y24hBpsPercentRatioPattern`](1m1w1y24hBpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3300](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3300) + +*** + +### rewards + +> **rewards**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3301](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3301) diff --git a/modules/brk-client/docs/interfaces/BothReactivatedReceivingSendingPattern.md b/modules/brk-client/docs/interfaces/BothReactivatedReceivingSendingPattern.md new file mode 100644 index 000000000..6ea1ddf98 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BothReactivatedReceivingSendingPattern.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BothReactivatedReceivingSendingPattern + +# Interface: BothReactivatedReceivingSendingPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2999](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2999) + +## Properties + +### both + +> **both**: [`_1m1w1y24hBlockPattern`](1m1w1y24hBlockPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3000](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3000) + +*** + +### reactivated + +> **reactivated**: [`_1m1w1y24hBlockPattern`](1m1w1y24hBlockPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3001](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3001) + +*** + +### receiving + +> **receiving**: [`_1m1w1y24hBlockPattern`](1m1w1y24hBlockPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3002](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3002) + +*** + +### sending + +> **sending**: [`_1m1w1y24hBlockPattern`](1m1w1y24hBlockPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3003](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3003) diff --git a/modules/brk-client/docs/interfaces/BpsCentsPercentilesRatioSatsSmaStdUsdPattern.md b/modules/brk-client/docs/interfaces/BpsCentsPercentilesRatioSatsSmaStdUsdPattern.md new file mode 100644 index 000000000..b2579c9fb --- /dev/null +++ b/modules/brk-client/docs/interfaces/BpsCentsPercentilesRatioSatsSmaStdUsdPattern.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BpsCentsPercentilesRatioSatsSmaStdUsdPattern + +# Interface: BpsCentsPercentilesRatioSatsSmaStdUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:1973](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1973) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1974](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1974) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1975](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1975) + +*** + +### percentiles + +> **percentiles**: [`Pct1Pct2Pct5Pct95Pct98Pct99Pattern`](Pct1Pct2Pct5Pct95Pct98Pct99Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1976](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1976) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1977](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1977) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1978](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1978) + +*** + +### sma + +> **sma**: [`_1m1w1y2y4yAllPattern`](1m1w1y2y4yAllPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1979](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1979) + +*** + +### stdDev + +> **stdDev**: [`_1y2y4yAllPattern`](1y2y4yAllPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1980](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1980) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1981](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1981) diff --git a/modules/brk-client/docs/interfaces/BpsCentsPercentilesRatioSatsUsdPattern.md b/modules/brk-client/docs/interfaces/BpsCentsPercentilesRatioSatsUsdPattern.md new file mode 100644 index 000000000..a1ea7685b --- /dev/null +++ b/modules/brk-client/docs/interfaces/BpsCentsPercentilesRatioSatsUsdPattern.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BpsCentsPercentilesRatioSatsUsdPattern + +# Interface: BpsCentsPercentilesRatioSatsUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2242](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2242) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2243](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2243) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2244](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2244) + +*** + +### percentiles + +> **percentiles**: [`Pct1Pct2Pct5Pct95Pct98Pct99Pattern`](Pct1Pct2Pct5Pct95Pct98Pct99Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2245](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2245) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2246](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2246) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2247](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2247) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2248](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2248) diff --git a/modules/brk-client/docs/interfaces/BpsCentsRatioSatsUsdPattern.md b/modules/brk-client/docs/interfaces/BpsCentsRatioSatsUsdPattern.md new file mode 100644 index 000000000..efb75fadd --- /dev/null +++ b/modules/brk-client/docs/interfaces/BpsCentsRatioSatsUsdPattern.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BpsCentsRatioSatsUsdPattern + +# Interface: BpsCentsRatioSatsUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2529](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2529) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2530](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2530) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2531](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2531) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2532](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2532) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2533](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2533) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2534](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2534) diff --git a/modules/brk-client/docs/interfaces/BpsPercentRatioPattern.md b/modules/brk-client/docs/interfaces/BpsPercentRatioPattern.md new file mode 100644 index 000000000..75f685c59 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BpsPercentRatioPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BpsPercentRatioPattern + +# Interface: BpsPercentRatioPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3404](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3404) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3405](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3405) + +*** + +### percent + +> **percent**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3406](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3406) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3407](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3407) diff --git a/modules/brk-client/docs/interfaces/BpsPercentRatioPattern3.md b/modules/brk-client/docs/interfaces/BpsPercentRatioPattern3.md new file mode 100644 index 000000000..a42590744 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BpsPercentRatioPattern3.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BpsPercentRatioPattern3 + +# Interface: BpsPercentRatioPattern3 + +Defined in: [Developer/brk/modules/brk-client/index.js:3319](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3319) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3320](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3320) + +*** + +### percent + +> **percent**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3321](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3321) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3322](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3322) diff --git a/modules/brk-client/docs/interfaces/BpsPercentRatioPattern4.md b/modules/brk-client/docs/interfaces/BpsPercentRatioPattern4.md new file mode 100644 index 000000000..4a3222534 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BpsPercentRatioPattern4.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BpsPercentRatioPattern4 + +# Interface: BpsPercentRatioPattern4 + +Defined in: [Developer/brk/modules/brk-client/index.js:3340](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3340) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3341](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3341) + +*** + +### percent + +> **percent**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3342](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3342) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3343](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3343) diff --git a/modules/brk-client/docs/interfaces/BpsPercentRatioPattern5.md b/modules/brk-client/docs/interfaces/BpsPercentRatioPattern5.md new file mode 100644 index 000000000..f8978a253 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BpsPercentRatioPattern5.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BpsPercentRatioPattern5 + +# Interface: BpsPercentRatioPattern5 + +Defined in: [Developer/brk/modules/brk-client/index.js:3383](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3383) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3384](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3384) + +*** + +### percent + +> **percent**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3385](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3385) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3386](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3386) diff --git a/modules/brk-client/docs/interfaces/BpsPriceRatioPattern.md b/modules/brk-client/docs/interfaces/BpsPriceRatioPattern.md new file mode 100644 index 000000000..c4bf7c644 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BpsPriceRatioPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BpsPriceRatioPattern + +# Interface: BpsPriceRatioPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3361](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3361) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3362](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3362) + +*** + +### price + +> **price**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3363](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3363) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3364](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3364) diff --git a/modules/brk-client/docs/interfaces/BpsRatioPattern.md b/modules/brk-client/docs/interfaces/BpsRatioPattern.md new file mode 100644 index 000000000..e67301994 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BpsRatioPattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BpsRatioPattern + +# Interface: BpsRatioPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3831](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3831) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3832](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3832) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3833](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3833) diff --git a/modules/brk-client/docs/interfaces/BpsRatioPattern2.md b/modules/brk-client/docs/interfaces/BpsRatioPattern2.md new file mode 100644 index 000000000..1a9103481 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BpsRatioPattern2.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BpsRatioPattern2 + +# Interface: BpsRatioPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:3812](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3812) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3813](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3813) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3814](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3814) diff --git a/modules/brk-client/docs/interfaces/BrkClientOptions.md b/modules/brk-client/docs/interfaces/BrkClientOptions.md index b5a6aefbb..2d7ee2132 100644 --- a/modules/brk-client/docs/interfaces/BrkClientOptions.md +++ b/modules/brk-client/docs/interfaces/BrkClientOptions.md @@ -6,7 +6,7 @@ # Interface: BrkClientOptions -Defined in: [Developer/brk/modules/brk-client/index.js:869](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L869) +Defined in: [Developer/brk/modules/brk-client/index.js:976](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L976) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:869](https://github.com/b > **baseUrl**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:870](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L870) +Defined in: [Developer/brk/modules/brk-client/index.js:977](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L977) Base URL for the API @@ -22,9 +22,9 @@ Base URL for the API ### cache? -> `optional` **cache**: `string` \| `boolean` +> `optional` **cache?**: `string` \| `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:872](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L872) +Defined in: [Developer/brk/modules/brk-client/index.js:979](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L979) Enable browser cache with default name (true), custom name (string), or disable (false). No effect in Node.js. Default: true @@ -32,8 +32,8 @@ Enable browser cache with default name (true), custom name (string), or disable ### timeout? -> `optional` **timeout**: `number` +> `optional` **timeout?**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:871](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L871) +Defined in: [Developer/brk/modules/brk-client/index.js:978](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L978) Request timeout in milliseconds diff --git a/modules/brk-client/docs/interfaces/BtcCentsDeltaSatsUsdPattern.md b/modules/brk-client/docs/interfaces/BtcCentsDeltaSatsUsdPattern.md new file mode 100644 index 000000000..678a67863 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BtcCentsDeltaSatsUsdPattern.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BtcCentsDeltaSatsUsdPattern + +# Interface: BtcCentsDeltaSatsUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2554](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2554) + +## Properties + +### btc + +> **btc**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2555](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2555) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2556](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2556) + +*** + +### delta + +> **delta**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2557](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2557) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2558](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2558) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2559](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2559) diff --git a/modules/brk-client/docs/interfaces/BtcCentsSatsToUsdPattern.md b/modules/brk-client/docs/interfaces/BtcCentsSatsToUsdPattern.md new file mode 100644 index 000000000..5e2223a9d --- /dev/null +++ b/modules/brk-client/docs/interfaces/BtcCentsSatsToUsdPattern.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BtcCentsSatsToUsdPattern + +# Interface: BtcCentsSatsToUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2579](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2579) + +## Properties + +### btc + +> **btc**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2580](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2580) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2581](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2581) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2582](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2582) + +*** + +### toCirculating + +> **toCirculating**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2583](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2583) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2584](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2584) diff --git a/modules/brk-client/docs/interfaces/BtcCentsSatsToUsdPattern2.md b/modules/brk-client/docs/interfaces/BtcCentsSatsToUsdPattern2.md new file mode 100644 index 000000000..f14300a65 --- /dev/null +++ b/modules/brk-client/docs/interfaces/BtcCentsSatsToUsdPattern2.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BtcCentsSatsToUsdPattern2 + +# Interface: BtcCentsSatsToUsdPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:2604](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2604) + +## Properties + +### btc + +> **btc**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2605](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2605) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2606](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2606) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2607](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2607) + +*** + +### toOwn + +> **toOwn**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2608](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2608) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2609](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2609) diff --git a/modules/brk-client/docs/interfaces/BtcCentsSatsToUsdPattern3.md b/modules/brk-client/docs/interfaces/BtcCentsSatsToUsdPattern3.md new file mode 100644 index 000000000..3b984ee1f --- /dev/null +++ b/modules/brk-client/docs/interfaces/BtcCentsSatsToUsdPattern3.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BtcCentsSatsToUsdPattern3 + +# Interface: BtcCentsSatsToUsdPattern3 + +Defined in: [Developer/brk/modules/brk-client/index.js:2269](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2269) + +## Properties + +### btc + +> **btc**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2270](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2270) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2271](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2271) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2272](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2272) + +*** + +### toCirculating + +> **toCirculating**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2273](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2273) + +*** + +### toOwn + +> **toOwn**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2274](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2274) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2275](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2275) diff --git a/modules/brk-client/docs/interfaces/BtcCentsSatsUsdPattern.md b/modules/brk-client/docs/interfaces/BtcCentsSatsUsdPattern.md new file mode 100644 index 000000000..4ea5dfe7b --- /dev/null +++ b/modules/brk-client/docs/interfaces/BtcCentsSatsUsdPattern.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BtcCentsSatsUsdPattern + +# Interface: BtcCentsSatsUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3045](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3045) + +## Properties + +### btc + +> **btc**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3046](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3046) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3047](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3047) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3048](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3048) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3049](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3049) diff --git a/modules/brk-client/docs/interfaces/BtcCentsSatsUsdPattern2.md b/modules/brk-client/docs/interfaces/BtcCentsSatsUsdPattern2.md new file mode 100644 index 000000000..d18b2003b --- /dev/null +++ b/modules/brk-client/docs/interfaces/BtcCentsSatsUsdPattern2.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BtcCentsSatsUsdPattern2 + +# Interface: BtcCentsSatsUsdPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:3068](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3068) + +## Properties + +### btc + +> **btc**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3069](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3069) + +*** + +### cents + +> **cents**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3070](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3070) + +*** + +### sats + +> **sats**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3071](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3071) + +*** + +### usd + +> **usd**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3072](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3072) diff --git a/modules/brk-client/docs/interfaces/BtcCentsSatsUsdPattern3.md b/modules/brk-client/docs/interfaces/BtcCentsSatsUsdPattern3.md new file mode 100644 index 000000000..9db6909ad --- /dev/null +++ b/modules/brk-client/docs/interfaces/BtcCentsSatsUsdPattern3.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BtcCentsSatsUsdPattern3 + +# Interface: BtcCentsSatsUsdPattern3 + +Defined in: [Developer/brk/modules/brk-client/index.js:3022](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3022) + +## Properties + +### btc + +> **btc**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3023](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3023) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3024](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3024) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3025](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3025) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3026](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3026) diff --git a/modules/brk-client/docs/interfaces/CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md b/modules/brk-client/docs/interfaces/CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md deleted file mode 100644 index 23eccbe94..000000000 --- a/modules/brk-client/docs/interfaces/CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md +++ /dev/null @@ -1,393 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern - -# Interface: CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern - -Defined in: [Developer/brk/modules/brk-client/index.js:1802](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1802) - -## Properties - -### capitulationFlow - -> **capitulationFlow**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1804](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1804) - -*** - -### capRaw - -> **capRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1803](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1803) - -*** - -### investorCapRaw - -> **investorCapRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1805](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1805) - -*** - -### investorPrice - -> **investorPrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1806](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1806) - -*** - -### investorPriceCents - -> **investorPriceCents**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1807](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1807) - -*** - -### investorPriceExtra - -> **investorPriceExtra**: [`RatioPattern2`](RatioPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1808](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1808) - -*** - -### lossValueCreated - -> **lossValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1809](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1809) - -*** - -### lossValueDestroyed - -> **lossValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1810](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1810) - -*** - -### lowerPriceBand - -> **lowerPriceBand**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1811](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1811) - -*** - -### mvrv - -> **mvrv**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1812](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1812) - -*** - -### negRealizedLoss - -> **negRealizedLoss**: [`CumulativeSumPattern2`](CumulativeSumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1813](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1813) - -*** - -### netRealizedPnl - -> **netRealizedPnl**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1814](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1814) - -*** - -### netRealizedPnl7dEma - -> **netRealizedPnl7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1815](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1815) - -*** - -### netRealizedPnlCumulative30dDelta - -> **netRealizedPnlCumulative30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1816](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1816) - -*** - -### netRealizedPnlCumulative30dDeltaRelToMarketCap - -> **netRealizedPnlCumulative30dDeltaRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1817](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1817) - -*** - -### netRealizedPnlCumulative30dDeltaRelToRealizedCap - -> **netRealizedPnlCumulative30dDeltaRelToRealizedCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1818](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1818) - -*** - -### netRealizedPnlRelToRealizedCap - -> **netRealizedPnlRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1819](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1819) - -*** - -### peakRegret - -> **peakRegret**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1820](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1820) - -*** - -### peakRegretRelToRealizedCap - -> **peakRegretRelToRealizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1821](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1821) - -*** - -### profitFlow - -> **profitFlow**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1822](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1822) - -*** - -### profitValueCreated - -> **profitValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1823](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1823) - -*** - -### profitValueDestroyed - -> **profitValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1824](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1824) - -*** - -### realizedCap - -> **realizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1825](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1825) - -*** - -### realizedCap30dDelta - -> **realizedCap30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1826](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1826) - -*** - -### realizedCapCents - -> **realizedCapCents**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1827](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1827) - -*** - -### realizedLoss - -> **realizedLoss**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1828](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1828) - -*** - -### realizedLoss7dEma - -> **realizedLoss7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1829](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1829) - -*** - -### realizedLossRelToRealizedCap - -> **realizedLossRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1830](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1830) - -*** - -### realizedPrice - -> **realizedPrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1831](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1831) - -*** - -### realizedPriceExtra - -> **realizedPriceExtra**: [`RatioPattern2`](RatioPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1832](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1832) - -*** - -### realizedProfit - -> **realizedProfit**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1833](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1833) - -*** - -### realizedProfit7dEma - -> **realizedProfit7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1834](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1834) - -*** - -### realizedProfitRelToRealizedCap - -> **realizedProfitRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1835](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1835) - -*** - -### realizedValue - -> **realizedValue**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1836](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1836) - -*** - -### sellSideRiskRatio - -> **sellSideRiskRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1837](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1837) - -*** - -### sellSideRiskRatio30dEma - -> **sellSideRiskRatio30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1838](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1838) - -*** - -### sellSideRiskRatio7dEma - -> **sellSideRiskRatio7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1839](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1839) - -*** - -### sentInLoss - -> **sentInLoss**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1840](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1840) - -*** - -### sentInLoss14dEma - -> **sentInLoss14dEma**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1841](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1841) - -*** - -### sentInProfit - -> **sentInProfit**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1842](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1842) - -*** - -### sentInProfit14dEma - -> **sentInProfit14dEma**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1843](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1843) - -*** - -### sopr - -> **sopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1844](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1844) - -*** - -### sopr30dEma - -> **sopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1845](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1845) - -*** - -### sopr7dEma - -> **sopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1846](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1846) - -*** - -### totalRealizedPnl - -> **totalRealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1847](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1847) - -*** - -### upperPriceBand - -> **upperPriceBand**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1848](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1848) - -*** - -### valueCreated - -> **valueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1849](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1849) - -*** - -### valueDestroyed - -> **valueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1850](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1850) diff --git a/modules/brk-client/docs/interfaces/CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md b/modules/brk-client/docs/interfaces/CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md deleted file mode 100644 index fb5d4a1b9..000000000 --- a/modules/brk-client/docs/interfaces/CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md +++ /dev/null @@ -1,409 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2 - -# Interface: CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2 - -Defined in: [Developer/brk/modules/brk-client/index.js:1687](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1687) - -## Properties - -### capitulationFlow - -> **capitulationFlow**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1689](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1689) - -*** - -### capRaw - -> **capRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1688](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1688) - -*** - -### investorCapRaw - -> **investorCapRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1690](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1690) - -*** - -### investorPrice - -> **investorPrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1691](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1691) - -*** - -### investorPriceCents - -> **investorPriceCents**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1692](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1692) - -*** - -### investorPriceExtra - -> **investorPriceExtra**: [`RatioPattern`](RatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1693](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1693) - -*** - -### lossValueCreated - -> **lossValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1694](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1694) - -*** - -### lossValueDestroyed - -> **lossValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1695](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1695) - -*** - -### lowerPriceBand - -> **lowerPriceBand**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1696](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1696) - -*** - -### mvrv - -> **mvrv**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1697](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1697) - -*** - -### negRealizedLoss - -> **negRealizedLoss**: [`CumulativeSumPattern2`](CumulativeSumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1698](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1698) - -*** - -### netRealizedPnl - -> **netRealizedPnl**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1699](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1699) - -*** - -### netRealizedPnl7dEma - -> **netRealizedPnl7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1700](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1700) - -*** - -### netRealizedPnlCumulative30dDelta - -> **netRealizedPnlCumulative30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1701](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1701) - -*** - -### netRealizedPnlCumulative30dDeltaRelToMarketCap - -> **netRealizedPnlCumulative30dDeltaRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1702](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1702) - -*** - -### netRealizedPnlCumulative30dDeltaRelToRealizedCap - -> **netRealizedPnlCumulative30dDeltaRelToRealizedCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1703](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1703) - -*** - -### netRealizedPnlRelToRealizedCap - -> **netRealizedPnlRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1704](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1704) - -*** - -### peakRegret - -> **peakRegret**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1705](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1705) - -*** - -### peakRegretRelToRealizedCap - -> **peakRegretRelToRealizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1706](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1706) - -*** - -### profitFlow - -> **profitFlow**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1707](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1707) - -*** - -### profitValueCreated - -> **profitValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1708](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1708) - -*** - -### profitValueDestroyed - -> **profitValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1709](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1709) - -*** - -### realizedCap - -> **realizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1710](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1710) - -*** - -### realizedCap30dDelta - -> **realizedCap30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1711](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1711) - -*** - -### realizedCapCents - -> **realizedCapCents**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1712](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1712) - -*** - -### realizedCapRelToOwnMarketCap - -> **realizedCapRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1713](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1713) - -*** - -### realizedLoss - -> **realizedLoss**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1714](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1714) - -*** - -### realizedLoss7dEma - -> **realizedLoss7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1715](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1715) - -*** - -### realizedLossRelToRealizedCap - -> **realizedLossRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1716](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1716) - -*** - -### realizedPrice - -> **realizedPrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1717](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1717) - -*** - -### realizedPriceExtra - -> **realizedPriceExtra**: [`RatioPattern`](RatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1718](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1718) - -*** - -### realizedProfit - -> **realizedProfit**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1719](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1719) - -*** - -### realizedProfit7dEma - -> **realizedProfit7dEma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1720](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1720) - -*** - -### realizedProfitRelToRealizedCap - -> **realizedProfitRelToRealizedCap**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1721](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1721) - -*** - -### realizedProfitToLossRatio - -> **realizedProfitToLossRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1722](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1722) - -*** - -### realizedValue - -> **realizedValue**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1723](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1723) - -*** - -### sellSideRiskRatio - -> **sellSideRiskRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1724](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1724) - -*** - -### sellSideRiskRatio30dEma - -> **sellSideRiskRatio30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1725](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1725) - -*** - -### sellSideRiskRatio7dEma - -> **sellSideRiskRatio7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1726](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1726) - -*** - -### sentInLoss - -> **sentInLoss**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1727](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1727) - -*** - -### sentInLoss14dEma - -> **sentInLoss14dEma**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1728](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1728) - -*** - -### sentInProfit - -> **sentInProfit**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1729](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1729) - -*** - -### sentInProfit14dEma - -> **sentInProfit14dEma**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1730](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1730) - -*** - -### sopr - -> **sopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1731](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1731) - -*** - -### sopr30dEma - -> **sopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1732](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1732) - -*** - -### sopr7dEma - -> **sopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1733](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1733) - -*** - -### totalRealizedPnl - -> **totalRealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1734](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1734) - -*** - -### upperPriceBand - -> **upperPriceBand**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1735](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1735) - -*** - -### valueCreated - -> **valueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1736](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1736) - -*** - -### valueDestroyed - -> **valueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1737](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1737) diff --git a/modules/brk-client/docs/interfaces/CapGrossInvestorLossMvrvNetPeakPriceProfitSellSoprPattern.md b/modules/brk-client/docs/interfaces/CapGrossInvestorLossMvrvNetPeakPriceProfitSellSoprPattern.md new file mode 100644 index 000000000..ee42b1eef --- /dev/null +++ b/modules/brk-client/docs/interfaces/CapGrossInvestorLossMvrvNetPeakPriceProfitSellSoprPattern.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CapGrossInvestorLossMvrvNetPeakPriceProfitSellSoprPattern + +# Interface: CapGrossInvestorLossMvrvNetPeakPriceProfitSellSoprPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:1782](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1782) + +## Properties + +### cap + +> **cap**: [`CentsDeltaToUsdPattern`](CentsDeltaToUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1783](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1783) + +*** + +### grossPnl + +> **grossPnl**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1784](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1784) + +*** + +### investor + +> **investor**: [`PricePattern`](PricePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1785](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1785) + +*** + +### loss + +> **loss**: [`BlockCumulativeNegativeSumPattern`](BlockCumulativeNegativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1786](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1786) + +*** + +### mvrv + +> **mvrv**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1787](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1787) + +*** + +### netPnl + +> **netPnl**: [`BlockChangeCumulativeDeltaSumPattern`](BlockChangeCumulativeDeltaSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1788](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1788) + +*** + +### peakRegret + +> **peakRegret**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1789](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1789) + +*** + +### price + +> **price**: [`BpsCentsPercentilesRatioSatsSmaStdUsdPattern`](BpsCentsPercentilesRatioSatsSmaStdUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1790](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1790) + +*** + +### profit + +> **profit**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1791](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1791) + +*** + +### profitToLossRatio + +> **profitToLossRatio**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1792](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1792) + +*** + +### sellSideRiskRatio + +> **sellSideRiskRatio**: [`_1m1w1y24hPattern7`](1m1w1y24hPattern7.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1793](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1793) + +*** + +### sopr + +> **sopr**: [`AdjustedRatioValuePattern`](AdjustedRatioValuePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1794](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1794) diff --git a/modules/brk-client/docs/interfaces/CapLossMvrvNetPriceProfitSoprPattern.md b/modules/brk-client/docs/interfaces/CapLossMvrvNetPriceProfitSoprPattern.md new file mode 100644 index 000000000..023199316 --- /dev/null +++ b/modules/brk-client/docs/interfaces/CapLossMvrvNetPriceProfitSoprPattern.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CapLossMvrvNetPriceProfitSoprPattern + +# Interface: CapLossMvrvNetPriceProfitSoprPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2043](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2043) + +## Properties + +### cap + +> **cap**: [`CentsDeltaUsdPattern`](CentsDeltaUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2044](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2044) + +*** + +### loss + +> **loss**: [`BlockCumulativeNegativeSumPattern`](BlockCumulativeNegativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2045](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2045) + +*** + +### mvrv + +> **mvrv**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2046](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2046) + +*** + +### netPnl + +> **netPnl**: [`BlockCumulativeDeltaSumPattern`](BlockCumulativeDeltaSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2047](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2047) + +*** + +### price + +> **price**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2048](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2048) + +*** + +### profit + +> **profit**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2049](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2049) + +*** + +### sopr + +> **sopr**: [`RatioValuePattern`](RatioValuePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2050](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2050) diff --git a/modules/brk-client/docs/interfaces/CapLossMvrvPriceProfitPattern.md b/modules/brk-client/docs/interfaces/CapLossMvrvPriceProfitPattern.md new file mode 100644 index 000000000..b5bf6bbe6 --- /dev/null +++ b/modules/brk-client/docs/interfaces/CapLossMvrvPriceProfitPattern.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CapLossMvrvPriceProfitPattern + +# Interface: CapLossMvrvPriceProfitPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2629](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2629) + +## Properties + +### cap + +> **cap**: [`CentsDeltaUsdPattern`](CentsDeltaUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2630](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2630) + +*** + +### loss + +> **loss**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2631](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2631) + +*** + +### mvrv + +> **mvrv**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2632](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2632) + +*** + +### price + +> **price**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2633](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2633) + +*** + +### profit + +> **profit**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2634](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2634) diff --git a/modules/brk-client/docs/interfaces/CentsDeltaToUsdPattern.md b/modules/brk-client/docs/interfaces/CentsDeltaToUsdPattern.md new file mode 100644 index 000000000..b8aed6ec2 --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsDeltaToUsdPattern.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsDeltaToUsdPattern + +# Interface: CentsDeltaToUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3091](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3091) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3092](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3092) + +*** + +### delta + +> **delta**: [`AbsoluteRatePattern2`](AbsoluteRatePattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3093](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3093) + +*** + +### toOwnMcap + +> **toOwnMcap**: [`BpsPercentRatioPattern4`](BpsPercentRatioPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3094](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3094) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3095](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3095) diff --git a/modules/brk-client/docs/interfaces/CentsDeltaUsdPattern.md b/modules/brk-client/docs/interfaces/CentsDeltaUsdPattern.md new file mode 100644 index 000000000..67b18584d --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsDeltaUsdPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsDeltaUsdPattern + +# Interface: CentsDeltaUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3446](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3446) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3447](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3447) + +*** + +### delta + +> **delta**: [`AbsoluteRatePattern2`](AbsoluteRatePattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3448](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3448) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3449](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3449) diff --git a/modules/brk-client/docs/interfaces/CentsNegativeToUsdPattern2.md b/modules/brk-client/docs/interfaces/CentsNegativeToUsdPattern2.md new file mode 100644 index 000000000..93adffc4b --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsNegativeToUsdPattern2.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsNegativeToUsdPattern2 + +# Interface: CentsNegativeToUsdPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:2296](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2296) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2297](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2297) + +*** + +### negative + +> **negative**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2298](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2298) + +*** + +### toMcap + +> **toMcap**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2299](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2299) + +*** + +### toOwnGrossPnl + +> **toOwnGrossPnl**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2300](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2300) + +*** + +### toOwnMcap + +> **toOwnMcap**: [`BpsPercentRatioPattern4`](BpsPercentRatioPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2301](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2301) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2302](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2302) diff --git a/modules/brk-client/docs/interfaces/CentsNegativeUsdPattern.md b/modules/brk-client/docs/interfaces/CentsNegativeUsdPattern.md new file mode 100644 index 000000000..49b82fc37 --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsNegativeUsdPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsNegativeUsdPattern + +# Interface: CentsNegativeUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3467](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3467) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3468](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3468) + +*** + +### negative + +> **negative**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3469](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3469) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3470](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3470) diff --git a/modules/brk-client/docs/interfaces/CentsSatsUsdPattern.md b/modules/brk-client/docs/interfaces/CentsSatsUsdPattern.md new file mode 100644 index 000000000..04d999ae3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsSatsUsdPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsSatsUsdPattern + +# Interface: CentsSatsUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3488](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3488) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3489](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3489) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3490](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3490) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3491](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3491) diff --git a/modules/brk-client/docs/interfaces/CentsSatsUsdPattern3.md b/modules/brk-client/docs/interfaces/CentsSatsUsdPattern3.md new file mode 100644 index 000000000..9ec81be1d --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsSatsUsdPattern3.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsSatsUsdPattern3 + +# Interface: CentsSatsUsdPattern3 + +Defined in: [Developer/brk/modules/brk-client/index.js:3425](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3425) + +## Properties + +### cents + +> **cents**: [`SeriesPattern2`](../type-aliases/SeriesPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3426](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3426) + +*** + +### sats + +> **sats**: [`SeriesPattern2`](../type-aliases/SeriesPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3427](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3427) + +*** + +### usd + +> **usd**: [`SeriesPattern2`](../type-aliases/SeriesPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3428](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3428) diff --git a/modules/brk-client/docs/interfaces/CentsToUsdPattern3.md b/modules/brk-client/docs/interfaces/CentsToUsdPattern3.md new file mode 100644 index 000000000..e3551ed8e --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsToUsdPattern3.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsToUsdPattern3 + +# Interface: CentsToUsdPattern3 + +Defined in: [Developer/brk/modules/brk-client/index.js:3114](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3114) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3115](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3115) + +*** + +### toOwnGrossPnl + +> **toOwnGrossPnl**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3116](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3116) + +*** + +### toOwnMcap + +> **toOwnMcap**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3117](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3117) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3118](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3118) diff --git a/modules/brk-client/docs/interfaces/CentsToUsdPattern4.md b/modules/brk-client/docs/interfaces/CentsToUsdPattern4.md new file mode 100644 index 000000000..f447f5abd --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsToUsdPattern4.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsToUsdPattern4 + +# Interface: CentsToUsdPattern4 + +Defined in: [Developer/brk/modules/brk-client/index.js:2654](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2654) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2655](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2655) + +*** + +### toMcap + +> **toMcap**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2656](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2656) + +*** + +### toOwnGrossPnl + +> **toOwnGrossPnl**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2657](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2657) + +*** + +### toOwnMcap + +> **toOwnMcap**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2658](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2658) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2659](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2659) diff --git a/modules/brk-client/docs/interfaces/CentsUsdPattern.md b/modules/brk-client/docs/interfaces/CentsUsdPattern.md new file mode 100644 index 000000000..e308f49db --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsUsdPattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsUsdPattern + +# Interface: CentsUsdPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3888](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3888) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3889](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3889) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3890](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3890) diff --git a/modules/brk-client/docs/interfaces/CentsUsdPattern2.md b/modules/brk-client/docs/interfaces/CentsUsdPattern2.md new file mode 100644 index 000000000..2ee5f13e1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsUsdPattern2.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsUsdPattern2 + +# Interface: CentsUsdPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:3869](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3869) + +## Properties + +### cents + +> **cents**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3870](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3870) + +*** + +### usd + +> **usd**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3871](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3871) diff --git a/modules/brk-client/docs/interfaces/CentsUsdPattern3.md b/modules/brk-client/docs/interfaces/CentsUsdPattern3.md new file mode 100644 index 000000000..b590b380b --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsUsdPattern3.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsUsdPattern3 + +# Interface: CentsUsdPattern3 + +Defined in: [Developer/brk/modules/brk-client/index.js:3850](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3850) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3851](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3851) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3852](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3852) diff --git a/modules/brk-client/docs/interfaces/CentsUsdPattern4.md b/modules/brk-client/docs/interfaces/CentsUsdPattern4.md new file mode 100644 index 000000000..1692757cf --- /dev/null +++ b/modules/brk-client/docs/interfaces/CentsUsdPattern4.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsUsdPattern4 + +# Interface: CentsUsdPattern4 + +Defined in: [Developer/brk/modules/brk-client/index.js:3907](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3907) + +## Properties + +### cents + +> **cents**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3908](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3908) + +*** + +### usd + +> **usd**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3909](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3909) diff --git a/modules/brk-client/docs/interfaces/CloseHighLowOpenPattern2.md b/modules/brk-client/docs/interfaces/CloseHighLowOpenPattern2.md deleted file mode 100644 index 05493ae69..000000000 --- a/modules/brk-client/docs/interfaces/CloseHighLowOpenPattern2.md +++ /dev/null @@ -1,47 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CloseHighLowOpenPattern2 - -# Interface: CloseHighLowOpenPattern2\ - -Defined in: [Developer/brk/modules/brk-client/index.js:3138](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3138) - -## Type Parameters - -### T - -`T` - -## Properties - -### close - -> **close**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3139](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3139) - -*** - -### high - -> **high**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3140](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3140) - -*** - -### low - -> **low**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3141](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3141) - -*** - -### open - -> **open**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3142](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3142) diff --git a/modules/brk-client/docs/interfaces/CoinblocksCoindaysSatblocksSatdaysSentPattern.md b/modules/brk-client/docs/interfaces/CoinblocksCoindaysSatblocksSatdaysSentPattern.md deleted file mode 100644 index 4133e6196..000000000 --- a/modules/brk-client/docs/interfaces/CoinblocksCoindaysSatblocksSatdaysSentPattern.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CoinblocksCoindaysSatblocksSatdaysSentPattern - -# Interface: CoinblocksCoindaysSatblocksSatdaysSentPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3060](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3060) - -## Properties - -### coinblocksDestroyed - -> **coinblocksDestroyed**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3061](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3061) - -*** - -### coindaysDestroyed - -> **coindaysDestroyed**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3062](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3062) - -*** - -### satblocksDestroyed - -> **satblocksDestroyed**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3063](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3063) - -*** - -### satdaysDestroyed - -> **satdaysDestroyed**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3064](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3064) - -*** - -### sent - -> **sent**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3065](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3065) - -*** - -### sent14dEma - -> **sent14dEma**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3066](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3066) diff --git a/modules/brk-client/docs/interfaces/CoindaysCoinyearsDormancyTransferPattern.md b/modules/brk-client/docs/interfaces/CoindaysCoinyearsDormancyTransferPattern.md new file mode 100644 index 000000000..dc41ed9d4 --- /dev/null +++ b/modules/brk-client/docs/interfaces/CoindaysCoinyearsDormancyTransferPattern.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CoindaysCoinyearsDormancyTransferPattern + +# Interface: CoindaysCoinyearsDormancyTransferPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3137](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3137) + +## Properties + +### coindaysDestroyed + +> **coindaysDestroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3138](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3138) + +*** + +### coinyearsDestroyed + +> **coinyearsDestroyed**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3139](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3139) + +*** + +### dormancy + +> **dormancy**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3140](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3140) + +*** + +### transferVolume + +> **transferVolume**: [`AverageBlockCumulativeInSumPattern`](AverageBlockCumulativeInSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3141](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3141) diff --git a/modules/brk-client/docs/interfaces/CoindaysTransferPattern.md b/modules/brk-client/docs/interfaces/CoindaysTransferPattern.md new file mode 100644 index 000000000..3adfdd4c2 --- /dev/null +++ b/modules/brk-client/docs/interfaces/CoindaysTransferPattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CoindaysTransferPattern + +# Interface: CoindaysTransferPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3926](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3926) + +## Properties + +### coindaysDestroyed + +> **coindaysDestroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3927](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3927) + +*** + +### transferVolume + +> **transferVolume**: [`AverageBlockCumulativeInSumPattern`](AverageBlockCumulativeInSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3928](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3928) diff --git a/modules/brk-client/docs/interfaces/CostBasisCohortParam.md b/modules/brk-client/docs/interfaces/CostBasisCohortParam.md index 31a882c17..ed8926abe 100644 --- a/modules/brk-client/docs/interfaces/CostBasisCohortParam.md +++ b/modules/brk-client/docs/interfaces/CostBasisCohortParam.md @@ -6,7 +6,7 @@ # Interface: CostBasisCohortParam -Defined in: [Developer/brk/modules/brk-client/index.js:209](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L209) +Defined in: [Developer/brk/modules/brk-client/index.js:241](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L241) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:209](https://github.com/b > **cohort**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:210](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L210) +Defined in: [Developer/brk/modules/brk-client/index.js:242](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L242) diff --git a/modules/brk-client/docs/interfaces/CostBasisParams.md b/modules/brk-client/docs/interfaces/CostBasisParams.md index 405a06f61..415e27903 100644 --- a/modules/brk-client/docs/interfaces/CostBasisParams.md +++ b/modules/brk-client/docs/interfaces/CostBasisParams.md @@ -6,7 +6,7 @@ # Interface: CostBasisParams -Defined in: [Developer/brk/modules/brk-client/index.js:215](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L215) +Defined in: [Developer/brk/modules/brk-client/index.js:247](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L247) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:215](https://github.com/b > **cohort**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:216](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L216) +Defined in: [Developer/brk/modules/brk-client/index.js:248](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L248) *** @@ -22,4 +22,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:216](https://github.com/b > **date**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:217](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L217) +Defined in: [Developer/brk/modules/brk-client/index.js:249](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L249) diff --git a/modules/brk-client/docs/interfaces/CostBasisQuery.md b/modules/brk-client/docs/interfaces/CostBasisQuery.md index f000d151f..372798c05 100644 --- a/modules/brk-client/docs/interfaces/CostBasisQuery.md +++ b/modules/brk-client/docs/interfaces/CostBasisQuery.md @@ -6,15 +6,15 @@ # Interface: CostBasisQuery -Defined in: [Developer/brk/modules/brk-client/index.js:222](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L222) +Defined in: [Developer/brk/modules/brk-client/index.js:254](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L254) ## Properties ### bucket? -> `optional` **bucket**: [`CostBasisBucket`](../type-aliases/CostBasisBucket.md) +> `optional` **bucket?**: [`CostBasisBucket`](../type-aliases/CostBasisBucket.md) -Defined in: [Developer/brk/modules/brk-client/index.js:223](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L223) +Defined in: [Developer/brk/modules/brk-client/index.js:255](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L255) Bucket type for aggregation. Default: raw (no aggregation). @@ -22,8 +22,8 @@ Bucket type for aggregation. Default: raw (no aggregation). ### value? -> `optional` **value**: [`CostBasisValue`](../type-aliases/CostBasisValue.md) +> `optional` **value?**: [`CostBasisValue`](../type-aliases/CostBasisValue.md) -Defined in: [Developer/brk/modules/brk-client/index.js:224](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L224) +Defined in: [Developer/brk/modules/brk-client/index.js:256](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L256) Value type to return. Default: supply. diff --git a/modules/brk-client/docs/interfaces/CumulativeRollingSumPattern.md b/modules/brk-client/docs/interfaces/CumulativeRollingSumPattern.md new file mode 100644 index 000000000..36fafb8c5 --- /dev/null +++ b/modules/brk-client/docs/interfaces/CumulativeRollingSumPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CumulativeRollingSumPattern + +# Interface: CumulativeRollingSumPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3509](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3509) + +## Properties + +### cumulative + +> **cumulative**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3510](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3510) + +*** + +### rolling + +> **rolling**: [`AverageMaxMedianMinPct10Pct25Pct75Pct90SumPattern`](AverageMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3511](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3511) + +*** + +### sum + +> **sum**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3512](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3512) diff --git a/modules/brk-client/docs/interfaces/CumulativeSumPattern.md b/modules/brk-client/docs/interfaces/CumulativeSumPattern.md deleted file mode 100644 index 711d37ec8..000000000 --- a/modules/brk-client/docs/interfaces/CumulativeSumPattern.md +++ /dev/null @@ -1,31 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CumulativeSumPattern - -# Interface: CumulativeSumPattern\ - -Defined in: [Developer/brk/modules/brk-client/index.js:3424](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3424) - -## Type Parameters - -### T - -`T` - -## Properties - -### cumulative - -> **cumulative**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3425](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3425) - -*** - -### sum - -> **sum**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3426](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3426) diff --git a/modules/brk-client/docs/interfaces/CumulativeSumPattern2.md b/modules/brk-client/docs/interfaces/CumulativeSumPattern2.md deleted file mode 100644 index 2a04bf1b5..000000000 --- a/modules/brk-client/docs/interfaces/CumulativeSumPattern2.md +++ /dev/null @@ -1,31 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CumulativeSumPattern2 - -# Interface: CumulativeSumPattern2\ - -Defined in: [Developer/brk/modules/brk-client/index.js:3445](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3445) - -## Type Parameters - -### T - -`T` - -## Properties - -### cumulative - -> **cumulative**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3446](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3446) - -*** - -### sum - -> **sum**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3447](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3447) diff --git a/modules/brk-client/docs/interfaces/DataRangeFormat.md b/modules/brk-client/docs/interfaces/DataRangeFormat.md index 4c82cfd8b..f8f53fe2f 100644 --- a/modules/brk-client/docs/interfaces/DataRangeFormat.md +++ b/modules/brk-client/docs/interfaces/DataRangeFormat.md @@ -6,25 +6,25 @@ # Interface: DataRangeFormat -Defined in: [Developer/brk/modules/brk-client/index.js:235](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L235) +Defined in: [Developer/brk/modules/brk-client/index.js:267](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L267) ## Properties ### end? -> `optional` **end**: `number` \| `null` +> `optional` **end?**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:237](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L237) +Defined in: [Developer/brk/modules/brk-client/index.js:269](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L269) -Exclusive ending index, if negative counts from end +Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `to`, `t`, `e` *** ### format? -> `optional` **format**: [`Format`](../type-aliases/Format.md) +> `optional` **format?**: [`Format`](../type-aliases/Format.md) -Defined in: [Developer/brk/modules/brk-client/index.js:239](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L239) +Defined in: [Developer/brk/modules/brk-client/index.js:271](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L271) Format of the output @@ -32,18 +32,18 @@ Format of the output ### limit? -> `optional` **limit**: `number` \| `null` +> `optional` **limit?**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:238](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L238) +Defined in: [Developer/brk/modules/brk-client/index.js:270](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L270) -Maximum number of values to return (ignored if `end` is set) +Maximum number of values to return (ignored if `end` is set). Aliases: `count`, `c`, `l` *** ### start? -> `optional` **start**: `number` \| `null` +> `optional` **start?**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:236](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L236) +Defined in: [Developer/brk/modules/brk-client/index.js:268](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L268) -Inclusive starting index, if negative counts from end +Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s` diff --git a/modules/brk-client/docs/interfaces/DateRangeBuilder.md b/modules/brk-client/docs/interfaces/DateRangeBuilder.md new file mode 100644 index 000000000..3371c311c --- /dev/null +++ b/modules/brk-client/docs/interfaces/DateRangeBuilder.md @@ -0,0 +1,59 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DateRangeBuilder + +# Interface: DateRangeBuilder\ + +Defined in: [Developer/brk/modules/brk-client/index.js:1237](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1237) + +## Type Parameters + +### T + +`T` + +## Properties + +### fetch + +> **fetch**: (`onUpdate?`) => `Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1238](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1238) + +Fetch the range + +#### Parameters + +##### onUpdate? + +(`value`) => `void` + +#### Returns + +`Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\> + +*** + +### fetchCsv + +> **fetchCsv**: () => `Promise`\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1239](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1239) + +Fetch as CSV + +#### Returns + +`Promise`\<`string`\> + +*** + +### then + +> **then**: [`DateThenable`](../type-aliases/DateThenable.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1240](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1240) + +Thenable diff --git a/modules/brk-client/docs/interfaces/DateSeriesDataExtras.md b/modules/brk-client/docs/interfaces/DateSeriesDataExtras.md new file mode 100644 index 000000000..c2753ed17 --- /dev/null +++ b/modules/brk-client/docs/interfaces/DateSeriesDataExtras.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DateSeriesDataExtras + +# Interface: DateSeriesDataExtras\ + +Defined in: [Developer/brk/modules/brk-client/index.js:1163](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1163) + +## Type Parameters + +### T + +`T` + +## Properties + +### dateEntries + +> **dateEntries**: () => \[`Date`, `T`\][] + +Defined in: [Developer/brk/modules/brk-client/index.js:1165](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1165) + +Get [date, value] pairs + +#### Returns + +\[`Date`, `T`\][] + +*** + +### dates + +> **dates**: () => `Date`[] + +Defined in: [Developer/brk/modules/brk-client/index.js:1164](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1164) + +Get dates for each data point + +#### Returns + +`Date`[] + +*** + +### toDateMap + +> **toDateMap**: () => `Map`\<`Date`, `T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1166](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1166) + +Convert to Map + +#### Returns + +`Map`\<`Date`, `T`\> diff --git a/modules/brk-client/docs/interfaces/DateSeriesEndpoint.md b/modules/brk-client/docs/interfaces/DateSeriesEndpoint.md new file mode 100644 index 000000000..67b86f63b --- /dev/null +++ b/modules/brk-client/docs/interfaces/DateSeriesEndpoint.md @@ -0,0 +1,173 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DateSeriesEndpoint + +# Interface: DateSeriesEndpoint\ + +Defined in: [Developer/brk/modules/brk-client/index.js:1191](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1191) + +## Type Parameters + +### T + +`T` + +## Properties + +### fetch + +> **fetch**: (`onUpdate?`) => `Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1197](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1197) + +Fetch all data + +#### Parameters + +##### onUpdate? + +(`value`) => `void` + +#### Returns + +`Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\> + +*** + +### fetchCsv + +> **fetchCsv**: () => `Promise`\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1198](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1198) + +Fetch all data as CSV + +#### Returns + +`Promise`\<`string`\> + +*** + +### first + +> **first**: (`n`) => [`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1194](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1194) + +Get first n items + +#### Parameters + +##### n + +`number` + +#### Returns + +[`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\> + +*** + +### get + +> **get**: (`index`) => [`DateSingleItemBuilder`](DateSingleItemBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1192](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1192) + +Get single item at index or Date + +#### Parameters + +##### index + +`number` \| `Date` + +#### Returns + +[`DateSingleItemBuilder`](DateSingleItemBuilder.md)\<`T`\> + +*** + +### last + +> **last**: (`n`) => [`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1195](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1195) + +Get last n items + +#### Parameters + +##### n + +`number` + +#### Returns + +[`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\> + +*** + +### path + +> **path**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:1200](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1200) + +The endpoint path + +*** + +### skip + +> **skip**: (`n`) => [`DateSkippedBuilder`](DateSkippedBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1196](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1196) + +Skip first n items, chain with take() + +#### Parameters + +##### n + +`number` + +#### Returns + +[`DateSkippedBuilder`](DateSkippedBuilder.md)\<`T`\> + +*** + +### slice + +> **slice**: (`start?`, `end?`) => [`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1193](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1193) + +Slice by index or Date + +#### Parameters + +##### start? + +`number` \| `Date` + +##### end? + +`number` \| `Date` + +#### Returns + +[`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\> + +*** + +### then + +> **then**: [`DateThenable`](../type-aliases/DateThenable.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1199](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1199) + +Thenable (await endpoint) diff --git a/modules/brk-client/docs/interfaces/DateSingleItemBuilder.md b/modules/brk-client/docs/interfaces/DateSingleItemBuilder.md new file mode 100644 index 000000000..9c8967cd8 --- /dev/null +++ b/modules/brk-client/docs/interfaces/DateSingleItemBuilder.md @@ -0,0 +1,59 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DateSingleItemBuilder + +# Interface: DateSingleItemBuilder\ + +Defined in: [Developer/brk/modules/brk-client/index.js:1211](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1211) + +## Type Parameters + +### T + +`T` + +## Properties + +### fetch + +> **fetch**: (`onUpdate?`) => `Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1212](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1212) + +Fetch the item + +#### Parameters + +##### onUpdate? + +(`value`) => `void` + +#### Returns + +`Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\> + +*** + +### fetchCsv + +> **fetchCsv**: () => `Promise`\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1213](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1213) + +Fetch as CSV + +#### Returns + +`Promise`\<`string`\> + +*** + +### then + +> **then**: [`DateThenable`](../type-aliases/DateThenable.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1214](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1214) + +Thenable diff --git a/modules/brk-client/docs/interfaces/DateSkippedBuilder.md b/modules/brk-client/docs/interfaces/DateSkippedBuilder.md new file mode 100644 index 000000000..bb56e61f0 --- /dev/null +++ b/modules/brk-client/docs/interfaces/DateSkippedBuilder.md @@ -0,0 +1,79 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DateSkippedBuilder + +# Interface: DateSkippedBuilder\ + +Defined in: [Developer/brk/modules/brk-client/index.js:1224](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1224) + +## Type Parameters + +### T + +`T` + +## Properties + +### fetch + +> **fetch**: (`onUpdate?`) => `Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1226](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1226) + +Fetch from skipped position to end + +#### Parameters + +##### onUpdate? + +(`value`) => `void` + +#### Returns + +`Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\> + +*** + +### fetchCsv + +> **fetchCsv**: () => `Promise`\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1227](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1227) + +Fetch as CSV + +#### Returns + +`Promise`\<`string`\> + +*** + +### take + +> **take**: (`n`) => [`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1225](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1225) + +Take n items after skipped position + +#### Parameters + +##### n + +`number` + +#### Returns + +[`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\> + +*** + +### then + +> **then**: [`DateThenable`](../type-aliases/DateThenable.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1228](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1228) + +Thenable diff --git a/modules/brk-client/docs/interfaces/DeltaHalfInToTotalPattern.md b/modules/brk-client/docs/interfaces/DeltaHalfInToTotalPattern.md new file mode 100644 index 000000000..ab494a5cb --- /dev/null +++ b/modules/brk-client/docs/interfaces/DeltaHalfInToTotalPattern.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DeltaHalfInToTotalPattern + +# Interface: DeltaHalfInToTotalPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2323](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2323) + +## Properties + +### delta + +> **delta**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2324](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2324) + +*** + +### half + +> **half**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2325](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2325) + +*** + +### inLoss + +> **inLoss**: [`BtcCentsSatsToUsdPattern`](BtcCentsSatsToUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2326](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2326) + +*** + +### inProfit + +> **inProfit**: [`BtcCentsSatsToUsdPattern`](BtcCentsSatsToUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2327](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2327) + +*** + +### toCirculating + +> **toCirculating**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2328](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2328) + +*** + +### total + +> **total**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2329](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2329) diff --git a/modules/brk-client/docs/interfaces/DeltaHalfInToTotalPattern2.md b/modules/brk-client/docs/interfaces/DeltaHalfInToTotalPattern2.md new file mode 100644 index 000000000..d9b9f4ee9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/DeltaHalfInToTotalPattern2.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DeltaHalfInToTotalPattern2 + +# Interface: DeltaHalfInToTotalPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:2350](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2350) + +## Properties + +### delta + +> **delta**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2351](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2351) + +*** + +### half + +> **half**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2352](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2352) + +*** + +### inLoss + +> **inLoss**: [`BtcCentsSatsToUsdPattern3`](BtcCentsSatsToUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2353](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2353) + +*** + +### inProfit + +> **inProfit**: [`BtcCentsSatsToUsdPattern3`](BtcCentsSatsToUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2354](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2354) + +*** + +### toCirculating + +> **toCirculating**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2355](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2355) + +*** + +### total + +> **total**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2356](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2356) diff --git a/modules/brk-client/docs/interfaces/DeltaHalfInTotalPattern2.md b/modules/brk-client/docs/interfaces/DeltaHalfInTotalPattern2.md new file mode 100644 index 000000000..ab65264e3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/DeltaHalfInTotalPattern2.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DeltaHalfInTotalPattern2 + +# Interface: DeltaHalfInTotalPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:2679](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2679) + +## Properties + +### delta + +> **delta**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2680](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2680) + +*** + +### half + +> **half**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2681](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2681) + +*** + +### inLoss + +> **inLoss**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2682](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2682) + +*** + +### inProfit + +> **inProfit**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2683](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2683) + +*** + +### total + +> **total**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2684](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2684) diff --git a/modules/brk-client/docs/interfaces/DeltaTotalPattern.md b/modules/brk-client/docs/interfaces/DeltaTotalPattern.md new file mode 100644 index 000000000..190271d61 --- /dev/null +++ b/modules/brk-client/docs/interfaces/DeltaTotalPattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DeltaTotalPattern + +# Interface: DeltaTotalPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3945](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3945) + +## Properties + +### delta + +> **delta**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3946](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3946) + +*** + +### total + +> **total**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3947](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3947) diff --git a/modules/brk-client/docs/interfaces/DetailedSeriesCount.md b/modules/brk-client/docs/interfaces/DetailedSeriesCount.md new file mode 100644 index 000000000..cf176abc0 --- /dev/null +++ b/modules/brk-client/docs/interfaces/DetailedSeriesCount.md @@ -0,0 +1,63 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DetailedSeriesCount + +# Interface: DetailedSeriesCount + +Defined in: [Developer/brk/modules/brk-client/index.js:283](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L283) + +## Properties + +### byDb + +> **byDb**: `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:288](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L288) + +Per-database breakdown of counts + +#### Index Signature + +\[`key`: `string`\]: [`SeriesCount`](SeriesCount.md) + +*** + +### distinctSeries + +> **distinctSeries**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:284](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L284) + +Number of unique series available (e.g., realized_price, market_cap) + +*** + +### lazyEndpoints + +> **lazyEndpoints**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:286](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L286) + +Number of lazy (computed on-the-fly) series-index combinations + +*** + +### storedEndpoints + +> **storedEndpoints**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:287](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L287) + +Number of eager (stored on disk) series-index combinations + +*** + +### totalEndpoints + +> **totalEndpoints**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:285](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L285) + +Total number of series-index combinations across all timeframes diff --git a/modules/brk-client/docs/interfaces/DifficultyAdjustment.md b/modules/brk-client/docs/interfaces/DifficultyAdjustment.md index a04984607..fd39cd7db 100644 --- a/modules/brk-client/docs/interfaces/DifficultyAdjustment.md +++ b/modules/brk-client/docs/interfaces/DifficultyAdjustment.md @@ -6,7 +6,7 @@ # Interface: DifficultyAdjustment -Defined in: [Developer/brk/modules/brk-client/index.js:251](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L251) +Defined in: [Developer/brk/modules/brk-client/index.js:293](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L293) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:251](https://github.com/b > **adjustedTimeAvg**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:260](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L260) +Defined in: [Developer/brk/modules/brk-client/index.js:302](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L302) Time-adjusted average (accounting for timestamp manipulation) @@ -24,7 +24,7 @@ Time-adjusted average (accounting for timestamp manipulation) > **difficultyChange**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:253](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L253) +Defined in: [Developer/brk/modules/brk-client/index.js:295](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L295) Estimated difficulty change at next retarget (%) @@ -34,7 +34,7 @@ Estimated difficulty change at next retarget (%) > **estimatedRetargetDate**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:254](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L254) +Defined in: [Developer/brk/modules/brk-client/index.js:296](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L296) Estimated Unix timestamp of next retarget @@ -44,7 +44,7 @@ Estimated Unix timestamp of next retarget > **nextRetargetHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:258](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L258) +Defined in: [Developer/brk/modules/brk-client/index.js:300](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L300) Height of next retarget @@ -54,7 +54,7 @@ Height of next retarget > **previousRetarget**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:257](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L257) +Defined in: [Developer/brk/modules/brk-client/index.js:299](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L299) Previous difficulty adjustment (%) @@ -64,7 +64,7 @@ Previous difficulty adjustment (%) > **progressPercent**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:252](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L252) +Defined in: [Developer/brk/modules/brk-client/index.js:294](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L294) Progress through current difficulty epoch (0-100%) @@ -74,7 +74,7 @@ Progress through current difficulty epoch (0-100%) > **remainingBlocks**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:255](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L255) +Defined in: [Developer/brk/modules/brk-client/index.js:297](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L297) Blocks remaining until retarget @@ -84,7 +84,7 @@ Blocks remaining until retarget > **remainingTime**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:256](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L256) +Defined in: [Developer/brk/modules/brk-client/index.js:298](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L298) Estimated seconds until retarget @@ -94,7 +94,7 @@ Estimated seconds until retarget > **timeAvg**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:259](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L259) +Defined in: [Developer/brk/modules/brk-client/index.js:301](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L301) Average block time in current epoch (seconds) @@ -104,6 +104,6 @@ Average block time in current epoch (seconds) > **timeOffset**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:261](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L261) +Defined in: [Developer/brk/modules/brk-client/index.js:303](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L303) Time offset from expected schedule (seconds) diff --git a/modules/brk-client/docs/interfaces/DifficultyAdjustmentEntry.md b/modules/brk-client/docs/interfaces/DifficultyAdjustmentEntry.md index 28b29d693..34ab00e31 100644 --- a/modules/brk-client/docs/interfaces/DifficultyAdjustmentEntry.md +++ b/modules/brk-client/docs/interfaces/DifficultyAdjustmentEntry.md @@ -6,7 +6,7 @@ # Interface: DifficultyAdjustmentEntry -Defined in: [Developer/brk/modules/brk-client/index.js:267](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L267) +Defined in: [Developer/brk/modules/brk-client/index.js:309](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L309) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:267](https://github.com/b > **changePercent**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:271](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L271) +Defined in: [Developer/brk/modules/brk-client/index.js:313](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L313) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:271](https://github.com/b > **difficulty**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:270](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L270) +Defined in: [Developer/brk/modules/brk-client/index.js:312](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L312) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:270](https://github.com/b > **height**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:269](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L269) +Defined in: [Developer/brk/modules/brk-client/index.js:311](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L311) *** @@ -38,4 +38,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:269](https://github.com/b > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:268](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L268) +Defined in: [Developer/brk/modules/brk-client/index.js:310](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L310) diff --git a/modules/brk-client/docs/interfaces/DifficultyEntry.md b/modules/brk-client/docs/interfaces/DifficultyEntry.md index b647a1ab8..c8a1fb7a0 100644 --- a/modules/brk-client/docs/interfaces/DifficultyEntry.md +++ b/modules/brk-client/docs/interfaces/DifficultyEntry.md @@ -6,7 +6,7 @@ # Interface: DifficultyEntry -Defined in: [Developer/brk/modules/brk-client/index.js:276](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L276) +Defined in: [Developer/brk/modules/brk-client/index.js:318](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L318) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:276](https://github.com/b > **difficulty**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:278](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L278) +Defined in: [Developer/brk/modules/brk-client/index.js:320](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L320) Difficulty value. @@ -24,7 +24,7 @@ Difficulty value. > **height**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:279](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L279) +Defined in: [Developer/brk/modules/brk-client/index.js:321](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L321) Block height of the adjustment. @@ -34,6 +34,6 @@ Block height of the adjustment. > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:277](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L277) +Defined in: [Developer/brk/modules/brk-client/index.js:319](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L319) Unix timestamp of the difficulty adjustment. diff --git a/modules/brk-client/docs/interfaces/DiskUsage.md b/modules/brk-client/docs/interfaces/DiskUsage.md index 3dc57bd48..91dcc1f30 100644 --- a/modules/brk-client/docs/interfaces/DiskUsage.md +++ b/modules/brk-client/docs/interfaces/DiskUsage.md @@ -6,7 +6,7 @@ # Interface: DiskUsage -Defined in: [Developer/brk/modules/brk-client/index.js:285](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L285) +Defined in: [Developer/brk/modules/brk-client/index.js:326](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L326) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:285](https://github.com/b > **bitcoin**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:288](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L288) +Defined in: [Developer/brk/modules/brk-client/index.js:329](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L329) Human-readable Bitcoin blocks directory size @@ -24,7 +24,7 @@ Human-readable Bitcoin blocks directory size > **bitcoinBytes**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:289](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L289) +Defined in: [Developer/brk/modules/brk-client/index.js:330](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L330) Bitcoin blocks directory size in bytes @@ -34,7 +34,7 @@ Bitcoin blocks directory size in bytes > **brk**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:286](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L286) +Defined in: [Developer/brk/modules/brk-client/index.js:327](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L327) Human-readable brk data size (e.g., "48.8 GiB") @@ -44,7 +44,7 @@ Human-readable brk data size (e.g., "48.8 GiB") > **brkBytes**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:287](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L287) +Defined in: [Developer/brk/modules/brk-client/index.js:328](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L328) brk data size in bytes @@ -54,6 +54,6 @@ brk data size in bytes > **ratio**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:290](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L290) +Defined in: [Developer/brk/modules/brk-client/index.js:331](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L331) brk as percentage of Bitcoin data diff --git a/modules/brk-client/docs/interfaces/DollarsSatsPattern.md b/modules/brk-client/docs/interfaces/DollarsSatsPattern.md deleted file mode 100644 index 90ac1a138..000000000 --- a/modules/brk-client/docs/interfaces/DollarsSatsPattern.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / DollarsSatsPattern - -# Interface: DollarsSatsPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3328](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3328) - -## Properties - -### dollars - -> **dollars**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3329](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3329) - -*** - -### sats - -> **sats**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3330](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3330) diff --git a/modules/brk-client/docs/interfaces/DollarsSatsPattern2.md b/modules/brk-client/docs/interfaces/DollarsSatsPattern2.md deleted file mode 100644 index c361d119e..000000000 --- a/modules/brk-client/docs/interfaces/DollarsSatsPattern2.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / DollarsSatsPattern2 - -# Interface: DollarsSatsPattern2 - -Defined in: [Developer/brk/modules/brk-client/index.js:3347](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3347) - -## Properties - -### dollars - -> **dollars**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3348](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3348) - -*** - -### sats - -> **sats**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3349](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3349) diff --git a/modules/brk-client/docs/interfaces/EmaHistogramLineSignalPattern.md b/modules/brk-client/docs/interfaces/EmaHistogramLineSignalPattern.md new file mode 100644 index 000000000..13e2cf2a1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/EmaHistogramLineSignalPattern.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / EmaHistogramLineSignalPattern + +# Interface: EmaHistogramLineSignalPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2704](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2704) + +## Properties + +### emaFast + +> **emaFast**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2705](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2705) + +*** + +### emaSlow + +> **emaSlow**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2706](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2706) + +*** + +### histogram + +> **histogram**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2707](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2707) + +*** + +### line + +> **line**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2708](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2708) + +*** + +### signal + +> **signal**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2709](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2709) diff --git a/modules/brk-client/docs/interfaces/EmptyAddrData.md b/modules/brk-client/docs/interfaces/EmptyAddrData.md new file mode 100644 index 000000000..4b1e59ed7 --- /dev/null +++ b/modules/brk-client/docs/interfaces/EmptyAddrData.md @@ -0,0 +1,39 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / EmptyAddrData + +# Interface: EmptyAddrData + +Defined in: [Developer/brk/modules/brk-client/index.js:341](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L341) + +## Properties + +### fundedTxoCount + +> **fundedTxoCount**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:343](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L343) + +Total funded/spent transaction output count (equal since address is empty) + +*** + +### transfered + +> **transfered**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:344](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L344) + +Total satoshis transferred + +*** + +### txCount + +> **txCount**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:342](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L342) + +Total transaction count diff --git a/modules/brk-client/docs/interfaces/EmptyAddressData.md b/modules/brk-client/docs/interfaces/EmptyAddressData.md deleted file mode 100644 index b045d7c43..000000000 --- a/modules/brk-client/docs/interfaces/EmptyAddressData.md +++ /dev/null @@ -1,39 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / EmptyAddressData - -# Interface: EmptyAddressData - -Defined in: [Developer/brk/modules/brk-client/index.js:300](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L300) - -## Properties - -### fundedTxoCount - -> **fundedTxoCount**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:302](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L302) - -Total funded/spent transaction output count (equal since address is empty) - -*** - -### transfered - -> **transfered**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:303](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L303) - -Total satoshis transferred - -*** - -### txCount - -> **txCount**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:301](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L301) - -Total transaction count diff --git a/modules/brk-client/docs/interfaces/ErrorBody.md b/modules/brk-client/docs/interfaces/ErrorBody.md new file mode 100644 index 000000000..0f9192056 --- /dev/null +++ b/modules/brk-client/docs/interfaces/ErrorBody.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / ErrorBody + +# Interface: ErrorBody + +Defined in: [Developer/brk/modules/brk-client/index.js:350](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L350) + +## Properties + +### error + +> **error**: [`ErrorDetail`](ErrorDetail.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:351](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L351) diff --git a/modules/brk-client/docs/interfaces/ErrorDetail.md b/modules/brk-client/docs/interfaces/ErrorDetail.md new file mode 100644 index 000000000..7e8a57ced --- /dev/null +++ b/modules/brk-client/docs/interfaces/ErrorDetail.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / ErrorDetail + +# Interface: ErrorDetail + +Defined in: [Developer/brk/modules/brk-client/index.js:354](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L354) + +## Properties + +### code + +> **code**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:356](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L356) + +Machine-readable error code (e.g. "invalid_addr", "series_not_found") + +*** + +### docUrl + +> **docUrl**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:358](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L358) + +Link to API documentation + +*** + +### message + +> **message**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:357](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L357) + +Human-readable description + +*** + +### type + +> **type**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:355](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L355) + +Error category: "invalid_request", "forbidden", "not_found", "unavailable", or "internal" diff --git a/modules/brk-client/docs/interfaces/FundedAddrData.md b/modules/brk-client/docs/interfaces/FundedAddrData.md new file mode 100644 index 000000000..f6f5badd7 --- /dev/null +++ b/modules/brk-client/docs/interfaces/FundedAddrData.md @@ -0,0 +1,79 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / FundedAddrData + +# Interface: FundedAddrData + +Defined in: [Developer/brk/modules/brk-client/index.js:373](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L373) + +## Properties + +### fundedTxoCount + +> **fundedTxoCount**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:375](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L375) + +Number of transaction outputs funded to this address + +*** + +### investorCapRaw + +> **investorCapRaw**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:380](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L380) + +The investor capitalization: Σ(price² × sats) + +*** + +### realizedCapRaw + +> **realizedCapRaw**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:379](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L379) + +The realized capitalization: Σ(price × sats) + +*** + +### received + +> **received**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:377](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L377) + +Satoshis received by this address + +*** + +### sent + +> **sent**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:378](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L378) + +Satoshis sent by this address + +*** + +### spentTxoCount + +> **spentTxoCount**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:376](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L376) + +Number of transaction outputs spent by this address + +*** + +### txCount + +> **txCount**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:374](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L374) + +Total transaction count diff --git a/modules/brk-client/docs/interfaces/FundedAddressData.md b/modules/brk-client/docs/interfaces/FundedAddressData.md deleted file mode 100644 index cc0931556..000000000 --- a/modules/brk-client/docs/interfaces/FundedAddressData.md +++ /dev/null @@ -1,79 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / FundedAddressData - -# Interface: FundedAddressData - -Defined in: [Developer/brk/modules/brk-client/index.js:320](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L320) - -## Properties - -### fundedTxoCount - -> **fundedTxoCount**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:322](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L322) - -Number of transaction outputs funded to this address - -*** - -### investorCapRaw - -> **investorCapRaw**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:327](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L327) - -The investor capitalization: Σ(price² × sats) - -*** - -### realizedCapRaw - -> **realizedCapRaw**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:326](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L326) - -The realized capitalization: Σ(price × sats) - -*** - -### received - -> **received**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:324](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L324) - -Satoshis received by this address - -*** - -### sent - -> **sent**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:325](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L325) - -Satoshis sent by this address - -*** - -### spentTxoCount - -> **spentTxoCount**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:323](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L323) - -Number of transaction outputs spent by this address - -*** - -### txCount - -> **txCount**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:321](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L321) - -Total transaction count diff --git a/modules/brk-client/docs/interfaces/GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern.md b/modules/brk-client/docs/interfaces/GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern.md deleted file mode 100644 index 59c9749d5..000000000 --- a/modules/brk-client/docs/interfaces/GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern.md +++ /dev/null @@ -1,145 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern - -# Interface: GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:2202](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2202) - -## Properties - -### greedIndex - -> **greedIndex**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2203](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2203) - -*** - -### investedCapitalInLoss - -> **investedCapitalInLoss**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2204](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2204) - -*** - -### investedCapitalInLossRaw - -> **investedCapitalInLossRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2205](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2205) - -*** - -### investedCapitalInProfit - -> **investedCapitalInProfit**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2206](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2206) - -*** - -### investedCapitalInProfitRaw - -> **investedCapitalInProfitRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2207](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2207) - -*** - -### investorCapInLossRaw - -> **investorCapInLossRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2208](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2208) - -*** - -### investorCapInProfitRaw - -> **investorCapInProfitRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2209](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2209) - -*** - -### negUnrealizedLoss - -> **negUnrealizedLoss**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2210](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2210) - -*** - -### netSentiment - -> **netSentiment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2211](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2211) - -*** - -### netUnrealizedPnl - -> **netUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2212](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2212) - -*** - -### painIndex - -> **painIndex**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2213](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2213) - -*** - -### peakRegret - -> **peakRegret**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2214](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2214) - -*** - -### supplyInLoss - -> **supplyInLoss**: [`BitcoinDollarsSatsPattern4`](BitcoinDollarsSatsPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2215](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2215) - -*** - -### supplyInProfit - -> **supplyInProfit**: [`BitcoinDollarsSatsPattern4`](BitcoinDollarsSatsPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2216](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2216) - -*** - -### totalUnrealizedPnl - -> **totalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2217](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2217) - -*** - -### unrealizedLoss - -> **unrealizedLoss**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2218](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2218) - -*** - -### unrealizedProfit - -> **unrealizedProfit**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2219](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2219) diff --git a/modules/brk-client/docs/interfaces/GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern.md b/modules/brk-client/docs/interfaces/GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern.md deleted file mode 100644 index a264305a0..000000000 --- a/modules/brk-client/docs/interfaces/GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern.md +++ /dev/null @@ -1,137 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern - -# Interface: GreedInvestedInvestorNegNetPainSupplyTotalUnrealizedPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:2251](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2251) - -## Properties - -### greedIndex - -> **greedIndex**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2252](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2252) - -*** - -### investedCapitalInLoss - -> **investedCapitalInLoss**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2253](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2253) - -*** - -### investedCapitalInLossRaw - -> **investedCapitalInLossRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2254](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2254) - -*** - -### investedCapitalInProfit - -> **investedCapitalInProfit**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2255](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2255) - -*** - -### investedCapitalInProfitRaw - -> **investedCapitalInProfitRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2256](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2256) - -*** - -### investorCapInLossRaw - -> **investorCapInLossRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2257](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2257) - -*** - -### investorCapInProfitRaw - -> **investorCapInProfitRaw**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2258](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2258) - -*** - -### negUnrealizedLoss - -> **negUnrealizedLoss**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2259](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2259) - -*** - -### netSentiment - -> **netSentiment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2260](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2260) - -*** - -### netUnrealizedPnl - -> **netUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2261](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2261) - -*** - -### painIndex - -> **painIndex**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2262](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2262) - -*** - -### supplyInLoss - -> **supplyInLoss**: [`BitcoinDollarsSatsPattern4`](BitcoinDollarsSatsPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2263](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2263) - -*** - -### supplyInProfit - -> **supplyInProfit**: [`BitcoinDollarsSatsPattern4`](BitcoinDollarsSatsPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2264](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2264) - -*** - -### totalUnrealizedPnl - -> **totalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2265](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2265) - -*** - -### unrealizedLoss - -> **unrealizedLoss**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2266](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2266) - -*** - -### unrealizedProfit - -> **unrealizedProfit**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2267](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2267) diff --git a/modules/brk-client/docs/interfaces/GreedNetPainPattern.md b/modules/brk-client/docs/interfaces/GreedNetPainPattern.md new file mode 100644 index 000000000..029cc798d --- /dev/null +++ b/modules/brk-client/docs/interfaces/GreedNetPainPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / GreedNetPainPattern + +# Interface: GreedNetPainPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3530](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3530) + +## Properties + +### greedIndex + +> **greedIndex**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3531](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3531) + +*** + +### net + +> **net**: [`CentsUsdPattern`](CentsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3532](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3532) + +*** + +### painIndex + +> **painIndex**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3533](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3533) diff --git a/modules/brk-client/docs/interfaces/GrossInvestedInvestorLossNetNuplProfitSentimentPattern2.md b/modules/brk-client/docs/interfaces/GrossInvestedInvestorLossNetNuplProfitSentimentPattern2.md new file mode 100644 index 000000000..0d4a9e8a7 --- /dev/null +++ b/modules/brk-client/docs/interfaces/GrossInvestedInvestorLossNetNuplProfitSentimentPattern2.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / GrossInvestedInvestorLossNetNuplProfitSentimentPattern2 + +# Interface: GrossInvestedInvestorLossNetNuplProfitSentimentPattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:1940](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1940) + +## Properties + +### grossPnl + +> **grossPnl**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1941](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1941) + +*** + +### investedCapital + +> **investedCapital**: [`InPattern`](InPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1942](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1942) + +*** + +### investorCapInLossRaw + +> **investorCapInLossRaw**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1943](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1943) + +*** + +### investorCapInProfitRaw + +> **investorCapInProfitRaw**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1944](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1944) + +*** + +### loss + +> **loss**: [`CentsNegativeToUsdPattern2`](CentsNegativeToUsdPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1945](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1945) + +*** + +### netPnl + +> **netPnl**: [`CentsToUsdPattern3`](CentsToUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1946](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1946) + +*** + +### nupl + +> **nupl**: [`BpsRatioPattern`](BpsRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1947](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1947) + +*** + +### profit + +> **profit**: [`CentsToUsdPattern4`](CentsToUsdPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1948](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1948) + +*** + +### sentiment + +> **sentiment**: [`GreedNetPainPattern`](GreedNetPainPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1949](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1949) diff --git a/modules/brk-client/docs/interfaces/HashrateEntry.md b/modules/brk-client/docs/interfaces/HashrateEntry.md index bd680e44f..e029a9b9d 100644 --- a/modules/brk-client/docs/interfaces/HashrateEntry.md +++ b/modules/brk-client/docs/interfaces/HashrateEntry.md @@ -6,7 +6,7 @@ # Interface: HashrateEntry -Defined in: [Developer/brk/modules/brk-client/index.js:334](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L334) +Defined in: [Developer/brk/modules/brk-client/index.js:387](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L387) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:334](https://github.com/b > **avgHashrate**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:336](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L336) +Defined in: [Developer/brk/modules/brk-client/index.js:389](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L389) Average hashrate (H/s). @@ -24,6 +24,6 @@ Average hashrate (H/s). > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:335](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L335) +Defined in: [Developer/brk/modules/brk-client/index.js:388](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L388) Unix timestamp. diff --git a/modules/brk-client/docs/interfaces/HashrateSummary.md b/modules/brk-client/docs/interfaces/HashrateSummary.md index 0e6e75b9f..7aa571b23 100644 --- a/modules/brk-client/docs/interfaces/HashrateSummary.md +++ b/modules/brk-client/docs/interfaces/HashrateSummary.md @@ -6,7 +6,7 @@ # Interface: HashrateSummary -Defined in: [Developer/brk/modules/brk-client/index.js:341](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L341) +Defined in: [Developer/brk/modules/brk-client/index.js:394](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L394) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:341](https://github.com/b > **currentDifficulty**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:345](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L345) +Defined in: [Developer/brk/modules/brk-client/index.js:398](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L398) Current network difficulty. @@ -24,7 +24,7 @@ Current network difficulty. > **currentHashrate**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:344](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L344) +Defined in: [Developer/brk/modules/brk-client/index.js:397](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L397) Current network hashrate (H/s). @@ -34,7 +34,7 @@ Current network hashrate (H/s). > **difficulty**: [`DifficultyEntry`](DifficultyEntry.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:343](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L343) +Defined in: [Developer/brk/modules/brk-client/index.js:396](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L396) Historical difficulty adjustments. @@ -44,6 +44,6 @@ Historical difficulty adjustments. > **hashrates**: [`HashrateEntry`](HashrateEntry.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:342](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L342) +Defined in: [Developer/brk/modules/brk-client/index.js:395](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L395) Historical hashrate data points. diff --git a/modules/brk-client/docs/interfaces/Health.md b/modules/brk-client/docs/interfaces/Health.md index 112b03753..1882c5704 100644 --- a/modules/brk-client/docs/interfaces/Health.md +++ b/modules/brk-client/docs/interfaces/Health.md @@ -6,15 +6,65 @@ # Interface: Health -Defined in: [Developer/brk/modules/brk-client/index.js:350](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L350) +Defined in: [Developer/brk/modules/brk-client/index.js:403](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L403) ## Properties +### blocksBehind + +> **blocksBehind**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:413](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L413) + +Number of blocks behind the tip + +*** + +### computedHeight + +> **computedHeight**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:411](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L411) + +Height of the last computed block (series) + +*** + +### indexedHeight + +> **indexedHeight**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:410](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L410) + +Height of the last indexed block + +*** + +### lastIndexedAt + +> **lastIndexedAt**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:414](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L414) + +Human-readable timestamp of the last indexed block (ISO 8601) + +*** + +### lastIndexedAtUnix + +> **lastIndexedAtUnix**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:415](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L415) + +Unix timestamp of the last indexed block + +*** + ### service > **service**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:352](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L352) +Defined in: [Developer/brk/modules/brk-client/index.js:405](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L405) *** @@ -22,7 +72,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:352](https://github.com/b > **startedAt**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:354](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L354) +Defined in: [Developer/brk/modules/brk-client/index.js:408](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L408) Server start time (ISO 8601) @@ -32,7 +82,7 @@ Server start time (ISO 8601) > **status**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:351](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L351) +Defined in: [Developer/brk/modules/brk-client/index.js:404](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L404) *** @@ -40,7 +90,17 @@ Defined in: [Developer/brk/modules/brk-client/index.js:351](https://github.com/b > **timestamp**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:353](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L353) +Defined in: [Developer/brk/modules/brk-client/index.js:407](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L407) + +*** + +### tipHeight + +> **tipHeight**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:412](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L412) + +Height of the chain tip (from Bitcoin node) *** @@ -48,6 +108,14 @@ Defined in: [Developer/brk/modules/brk-client/index.js:353](https://github.com/b > **uptimeSeconds**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:355](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L355) +Defined in: [Developer/brk/modules/brk-client/index.js:409](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L409) Uptime in seconds + +*** + +### version + +> **version**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:406](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L406) diff --git a/modules/brk-client/docs/interfaces/HeightParam.md b/modules/brk-client/docs/interfaces/HeightParam.md index 4638290d9..b13aa16a8 100644 --- a/modules/brk-client/docs/interfaces/HeightParam.md +++ b/modules/brk-client/docs/interfaces/HeightParam.md @@ -6,7 +6,7 @@ # Interface: HeightParam -Defined in: [Developer/brk/modules/brk-client/index.js:363](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L363) +Defined in: [Developer/brk/modules/brk-client/index.js:423](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L423) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:363](https://github.com/b > **height**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:364](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L364) +Defined in: [Developer/brk/modules/brk-client/index.js:424](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L424) diff --git a/modules/brk-client/docs/interfaces/InMaxMinPerSupplyPattern.md b/modules/brk-client/docs/interfaces/InMaxMinPerSupplyPattern.md new file mode 100644 index 000000000..e5bc6632f --- /dev/null +++ b/modules/brk-client/docs/interfaces/InMaxMinPerSupplyPattern.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / InMaxMinPerSupplyPattern + +# Interface: InMaxMinPerSupplyPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2072](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2072) + +## Properties + +### inLoss + +> **inLoss**: [`PerPattern`](PerPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2073](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2073) + +*** + +### inProfit + +> **inProfit**: [`PerPattern`](PerPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2074](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2074) + +*** + +### max + +> **max**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2075](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2075) + +*** + +### min + +> **min**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2076](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2076) + +*** + +### perCoin + +> **perCoin**: [`Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern`](Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2077](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2077) + +*** + +### perDollar + +> **perDollar**: [`Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern`](Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2078](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2078) + +*** + +### supplyDensity + +> **supplyDensity**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2079](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2079) diff --git a/modules/brk-client/docs/interfaces/InPattern.md b/modules/brk-client/docs/interfaces/InPattern.md new file mode 100644 index 000000000..1f679e7e9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/InPattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / InPattern + +# Interface: InPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3964](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3964) + +## Properties + +### inLoss + +> **inLoss**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3965](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3965) + +*** + +### inProfit + +> **inProfit**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3966](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3966) diff --git a/modules/brk-client/docs/interfaces/IndexInfo.md b/modules/brk-client/docs/interfaces/IndexInfo.md index 49dab2177..9356b8e67 100644 --- a/modules/brk-client/docs/interfaces/IndexInfo.md +++ b/modules/brk-client/docs/interfaces/IndexInfo.md @@ -6,7 +6,7 @@ # Interface: IndexInfo -Defined in: [Developer/brk/modules/brk-client/index.js:385](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L385) +Defined in: [Developer/brk/modules/brk-client/index.js:448](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L448) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:385](https://github.com/b > **aliases**: `string`[] -Defined in: [Developer/brk/modules/brk-client/index.js:387](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L387) +Defined in: [Developer/brk/modules/brk-client/index.js:450](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L450) All Accepted query aliases @@ -24,6 +24,6 @@ All Accepted query aliases > **index**: [`Index`](../type-aliases/Index.md) -Defined in: [Developer/brk/modules/brk-client/index.js:386](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L386) +Defined in: [Developer/brk/modules/brk-client/index.js:449](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L449) The canonical index name diff --git a/modules/brk-client/docs/interfaces/InvestedMaxMinPercentilesSpotPattern.md b/modules/brk-client/docs/interfaces/InvestedMaxMinPercentilesSpotPattern.md deleted file mode 100644 index 0aab658d7..000000000 --- a/modules/brk-client/docs/interfaces/InvestedMaxMinPercentilesSpotPattern.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / InvestedMaxMinPercentilesSpotPattern - -# Interface: InvestedMaxMinPercentilesSpotPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3087](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3087) - -## Properties - -### investedCapital - -> **investedCapital**: [`Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern`](Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3088](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3088) - -*** - -### max - -> **max**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3089](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3089) - -*** - -### min - -> **min**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3090](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3090) - -*** - -### percentiles - -> **percentiles**: [`Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern`](Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3091](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3091) - -*** - -### spotCostBasisPercentile - -> **spotCostBasisPercentile**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3092](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3092) - -*** - -### spotInvestedCapitalPercentile - -> **spotInvestedCapitalPercentile**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3093](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3093) diff --git a/modules/brk-client/docs/interfaces/InvestedNegNetNuplSupplyUnrealizedPattern.md b/modules/brk-client/docs/interfaces/InvestedNegNetNuplSupplyUnrealizedPattern.md deleted file mode 100644 index 36dd59e7a..000000000 --- a/modules/brk-client/docs/interfaces/InvestedNegNetNuplSupplyUnrealizedPattern.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / InvestedNegNetNuplSupplyUnrealizedPattern - -# Interface: InvestedNegNetNuplSupplyUnrealizedPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:2423](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2423) - -## Properties - -### investedCapitalInLossPct - -> **investedCapitalInLossPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2424](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2424) - -*** - -### investedCapitalInProfitPct - -> **investedCapitalInProfitPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2425](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2425) - -*** - -### negUnrealizedLossRelToMarketCap - -> **negUnrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2426](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2426) - -*** - -### netUnrealizedPnlRelToMarketCap - -> **netUnrealizedPnlRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2427](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2427) - -*** - -### nupl - -> **nupl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2428](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2428) - -*** - -### supplyInLossRelToCirculatingSupply - -> **supplyInLossRelToCirculatingSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2429](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2429) - -*** - -### supplyInLossRelToOwnSupply - -> **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2430](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2430) - -*** - -### supplyInProfitRelToCirculatingSupply - -> **supplyInProfitRelToCirculatingSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2431](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2431) - -*** - -### supplyInProfitRelToOwnSupply - -> **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2432](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2432) - -*** - -### supplyRelToCirculatingSupply - -> **supplyRelToCirculatingSupply**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2433](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2433) - -*** - -### unrealizedLossRelToMarketCap - -> **unrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2434](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2434) - -*** - -### unrealizedProfitRelToMarketCap - -> **unrealizedProfitRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2435](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2435) diff --git a/modules/brk-client/docs/interfaces/InvestedNegNetNuplSupplyUnrealizedPattern3.md b/modules/brk-client/docs/interfaces/InvestedNegNetNuplSupplyUnrealizedPattern3.md deleted file mode 100644 index 054cec183..000000000 --- a/modules/brk-client/docs/interfaces/InvestedNegNetNuplSupplyUnrealizedPattern3.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / InvestedNegNetNuplSupplyUnrealizedPattern3 - -# Interface: InvestedNegNetNuplSupplyUnrealizedPattern3 - -Defined in: [Developer/brk/modules/brk-client/index.js:2343](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2343) - -## Properties - -### investedCapitalInLossPct - -> **investedCapitalInLossPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2344](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2344) - -*** - -### investedCapitalInProfitPct - -> **investedCapitalInProfitPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2345](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2345) - -*** - -### negUnrealizedLossRelToMarketCap - -> **negUnrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2346](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2346) - -*** - -### netUnrealizedPnlRelToMarketCap - -> **netUnrealizedPnlRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2347](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2347) - -*** - -### nupl - -> **nupl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2348](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2348) - -*** - -### supplyInLossRelToCirculatingSupply - -> **supplyInLossRelToCirculatingSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2349](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2349) - -*** - -### supplyInLossRelToOwnSupply - -> **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2350](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2350) - -*** - -### supplyInProfitRelToCirculatingSupply - -> **supplyInProfitRelToCirculatingSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2351](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2351) - -*** - -### supplyInProfitRelToOwnSupply - -> **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2352](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2352) - -*** - -### supplyRelToCirculatingSupply - -> **supplyRelToCirculatingSupply**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2353](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2353) - -*** - -### unrealizedLossRelToMarketCap - -> **unrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2354](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2354) - -*** - -### unrealizedPeakRegretRelToMarketCap - -> **unrealizedPeakRegretRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2355](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2355) - -*** - -### unrealizedProfitRelToMarketCap - -> **unrealizedProfitRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2356](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2356) diff --git a/modules/brk-client/docs/interfaces/InvestedNegNetNuplSupplyUnrealizedPattern4.md b/modules/brk-client/docs/interfaces/InvestedNegNetNuplSupplyUnrealizedPattern4.md deleted file mode 100644 index f6b553409..000000000 --- a/modules/brk-client/docs/interfaces/InvestedNegNetNuplSupplyUnrealizedPattern4.md +++ /dev/null @@ -1,177 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / InvestedNegNetNuplSupplyUnrealizedPattern4 - -# Interface: InvestedNegNetNuplSupplyUnrealizedPattern4 - -Defined in: [Developer/brk/modules/brk-client/index.js:1984](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1984) - -## Properties - -### investedCapitalInLossPct - -> **investedCapitalInLossPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1985](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1985) - -*** - -### investedCapitalInProfitPct - -> **investedCapitalInProfitPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1986](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1986) - -*** - -### negUnrealizedLossRelToMarketCap - -> **negUnrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1987](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1987) - -*** - -### negUnrealizedLossRelToOwnMarketCap - -> **negUnrealizedLossRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1988](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1988) - -*** - -### negUnrealizedLossRelToOwnTotalUnrealizedPnl - -> **negUnrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1989](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1989) - -*** - -### netUnrealizedPnlRelToMarketCap - -> **netUnrealizedPnlRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1990](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1990) - -*** - -### netUnrealizedPnlRelToOwnMarketCap - -> **netUnrealizedPnlRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1991](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1991) - -*** - -### netUnrealizedPnlRelToOwnTotalUnrealizedPnl - -> **netUnrealizedPnlRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1992](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1992) - -*** - -### nupl - -> **nupl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1993](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1993) - -*** - -### supplyInLossRelToCirculatingSupply - -> **supplyInLossRelToCirculatingSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1994](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1994) - -*** - -### supplyInLossRelToOwnSupply - -> **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1995](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1995) - -*** - -### supplyInProfitRelToCirculatingSupply - -> **supplyInProfitRelToCirculatingSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1996](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1996) - -*** - -### supplyInProfitRelToOwnSupply - -> **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1997](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1997) - -*** - -### supplyRelToCirculatingSupply - -> **supplyRelToCirculatingSupply**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1998](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1998) - -*** - -### unrealizedLossRelToMarketCap - -> **unrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1999](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1999) - -*** - -### unrealizedLossRelToOwnMarketCap - -> **unrealizedLossRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2000](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2000) - -*** - -### unrealizedLossRelToOwnTotalUnrealizedPnl - -> **unrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2001](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2001) - -*** - -### unrealizedPeakRegretRelToMarketCap - -> **unrealizedPeakRegretRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2002](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2002) - -*** - -### unrealizedProfitRelToMarketCap - -> **unrealizedProfitRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2003](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2003) - -*** - -### unrealizedProfitRelToOwnMarketCap - -> **unrealizedProfitRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2004](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2004) - -*** - -### unrealizedProfitRelToOwnTotalUnrealizedPnl - -> **unrealizedProfitRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2005](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2005) diff --git a/modules/brk-client/docs/interfaces/InvestedNegNetSupplyUnrealizedPattern.md b/modules/brk-client/docs/interfaces/InvestedNegNetSupplyUnrealizedPattern.md deleted file mode 100644 index 7af3c396b..000000000 --- a/modules/brk-client/docs/interfaces/InvestedNegNetSupplyUnrealizedPattern.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / InvestedNegNetSupplyUnrealizedPattern - -# Interface: InvestedNegNetSupplyUnrealizedPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:2462](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2462) - -## Properties - -### investedCapitalInLossPct - -> **investedCapitalInLossPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2463](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2463) - -*** - -### investedCapitalInProfitPct - -> **investedCapitalInProfitPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2464](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2464) - -*** - -### negUnrealizedLossRelToOwnMarketCap - -> **negUnrealizedLossRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2465](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2465) - -*** - -### negUnrealizedLossRelToOwnTotalUnrealizedPnl - -> **negUnrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2466](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2466) - -*** - -### netUnrealizedPnlRelToOwnMarketCap - -> **netUnrealizedPnlRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2467](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2467) - -*** - -### netUnrealizedPnlRelToOwnTotalUnrealizedPnl - -> **netUnrealizedPnlRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2468](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2468) - -*** - -### supplyInLossRelToOwnSupply - -> **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2469](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2469) - -*** - -### supplyInProfitRelToOwnSupply - -> **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2470](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2470) - -*** - -### unrealizedLossRelToOwnMarketCap - -> **unrealizedLossRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2471](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2471) - -*** - -### unrealizedLossRelToOwnTotalUnrealizedPnl - -> **unrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2472](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2472) - -*** - -### unrealizedProfitRelToOwnMarketCap - -> **unrealizedProfitRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2473](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2473) - -*** - -### unrealizedProfitRelToOwnTotalUnrealizedPnl - -> **unrealizedProfitRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2474](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2474) diff --git a/modules/brk-client/docs/interfaces/InvestedSupplyPattern.md b/modules/brk-client/docs/interfaces/InvestedSupplyPattern.md deleted file mode 100644 index fa824c12b..000000000 --- a/modules/brk-client/docs/interfaces/InvestedSupplyPattern.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / InvestedSupplyPattern - -# Interface: InvestedSupplyPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3114](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3114) - -## Properties - -### investedCapitalInLossPct - -> **investedCapitalInLossPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3115](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3115) - -*** - -### investedCapitalInProfitPct - -> **investedCapitalInProfitPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3116](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3116) - -*** - -### supplyInLossRelToOwnSupply - -> **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3117](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3117) - -*** - -### supplyInProfitRelToOwnSupply - -> **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3118](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3118) diff --git a/modules/brk-client/docs/interfaces/LegacySeriesParam.md b/modules/brk-client/docs/interfaces/LegacySeriesParam.md new file mode 100644 index 000000000..6b487cb64 --- /dev/null +++ b/modules/brk-client/docs/interfaces/LegacySeriesParam.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / LegacySeriesParam + +# Interface: LegacySeriesParam + +Defined in: [Developer/brk/modules/brk-client/index.js:455](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L455) + +## Properties + +### metric + +> **metric**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:456](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L456) diff --git a/modules/brk-client/docs/interfaces/LegacySeriesWithIndex.md b/modules/brk-client/docs/interfaces/LegacySeriesWithIndex.md new file mode 100644 index 000000000..424dc8158 --- /dev/null +++ b/modules/brk-client/docs/interfaces/LegacySeriesWithIndex.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / LegacySeriesWithIndex + +# Interface: LegacySeriesWithIndex + +Defined in: [Developer/brk/modules/brk-client/index.js:461](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L461) + +## Properties + +### index + +> **index**: [`Index`](../type-aliases/Index.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:463](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L463) + +*** + +### metric + +> **metric**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:462](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L462) diff --git a/modules/brk-client/docs/interfaces/LimitParam.md b/modules/brk-client/docs/interfaces/LimitParam.md deleted file mode 100644 index 8ec999bac..000000000 --- a/modules/brk-client/docs/interfaces/LimitParam.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / LimitParam - -# Interface: LimitParam - -Defined in: [Developer/brk/modules/brk-client/index.js:395](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L395) - -## Properties - -### limit? - -> `optional` **limit**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:396](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L396) diff --git a/modules/brk-client/docs/interfaces/LossNetNuplProfitPattern.md b/modules/brk-client/docs/interfaces/LossNetNuplProfitPattern.md new file mode 100644 index 000000000..c4e5e4455 --- /dev/null +++ b/modules/brk-client/docs/interfaces/LossNetNuplProfitPattern.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / LossNetNuplProfitPattern + +# Interface: LossNetNuplProfitPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3160](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3160) + +## Properties + +### loss + +> **loss**: [`CentsNegativeUsdPattern`](CentsNegativeUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3161](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3161) + +*** + +### netPnl + +> **netPnl**: [`CentsUsdPattern`](CentsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3162](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3162) + +*** + +### nupl + +> **nupl**: [`BpsRatioPattern`](BpsRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3163](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3163) + +*** + +### profit + +> **profit**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3164](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3164) diff --git a/modules/brk-client/docs/interfaces/LossNuplProfitPattern.md b/modules/brk-client/docs/interfaces/LossNuplProfitPattern.md new file mode 100644 index 000000000..de90fd12a --- /dev/null +++ b/modules/brk-client/docs/interfaces/LossNuplProfitPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / LossNuplProfitPattern + +# Interface: LossNuplProfitPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3551](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3551) + +## Properties + +### loss + +> **loss**: [`CentsNegativeUsdPattern`](CentsNegativeUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3552](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3552) + +*** + +### nupl + +> **nupl**: [`BpsRatioPattern`](BpsRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3553](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3553) + +*** + +### profit + +> **profit**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3554](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3554) diff --git a/modules/brk-client/docs/interfaces/MaxMedianMinPct10Pct25Pct75Pct90Pattern.md b/modules/brk-client/docs/interfaces/MaxMedianMinPct10Pct25Pct75Pct90Pattern.md new file mode 100644 index 000000000..f7c6426df --- /dev/null +++ b/modules/brk-client/docs/interfaces/MaxMedianMinPct10Pct25Pct75Pct90Pattern.md @@ -0,0 +1,71 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MaxMedianMinPct10Pct25Pct75Pct90Pattern + +# Interface: MaxMedianMinPct10Pct25Pct75Pct90Pattern\ + +Defined in: [Developer/brk/modules/brk-client/index.js:2131](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2131) + +## Type Parameters + +### T + +`T` + +## Properties + +### max + +> **max**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2132](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2132) + +*** + +### median + +> **median**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2133](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2133) + +*** + +### min + +> **min**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2134](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2134) + +*** + +### pct10 + +> **pct10**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2135](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2135) + +*** + +### pct25 + +> **pct25**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2136](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2136) + +*** + +### pct75 + +> **pct75**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2137](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2137) + +*** + +### pct90 + +> **pct90**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2138](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2138) diff --git a/modules/brk-client/docs/interfaces/MaxMedianMinPct10Pct25Pct75Pct90Pattern2.md b/modules/brk-client/docs/interfaces/MaxMedianMinPct10Pct25Pct75Pct90Pattern2.md new file mode 100644 index 000000000..d6543bb88 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MaxMedianMinPct10Pct25Pct75Pct90Pattern2.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MaxMedianMinPct10Pct25Pct75Pct90Pattern2 + +# Interface: MaxMedianMinPct10Pct25Pct75Pct90Pattern2 + +Defined in: [Developer/brk/modules/brk-client/index.js:2101](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2101) + +## Properties + +### max + +> **max**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2102](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2102) + +*** + +### median + +> **median**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2103](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2103) + +*** + +### min + +> **min**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2104](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2104) + +*** + +### pct10 + +> **pct10**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2105](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2105) + +*** + +### pct25 + +> **pct25**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2106](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2106) + +*** + +### pct75 + +> **pct75**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2107](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2107) + +*** + +### pct90 + +> **pct90**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2108](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2108) diff --git a/modules/brk-client/docs/interfaces/MaxMinPattern.md b/modules/brk-client/docs/interfaces/MaxMinPattern.md deleted file mode 100644 index d37622c4c..000000000 --- a/modules/brk-client/docs/interfaces/MaxMinPattern.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MaxMinPattern - -# Interface: MaxMinPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3366](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3366) - -## Properties - -### max - -> **max**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3367](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3367) - -*** - -### min - -> **min**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3368](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3368) diff --git a/modules/brk-client/docs/interfaces/MempoolBlock.md b/modules/brk-client/docs/interfaces/MempoolBlock.md index 276985ca4..4e6e38a61 100644 --- a/modules/brk-client/docs/interfaces/MempoolBlock.md +++ b/modules/brk-client/docs/interfaces/MempoolBlock.md @@ -6,7 +6,7 @@ # Interface: MempoolBlock -Defined in: [Developer/brk/modules/brk-client/index.js:406](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L406) +Defined in: [Developer/brk/modules/brk-client/index.js:478](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L478) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:406](https://github.com/b > **blockSize**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:407](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L407) +Defined in: [Developer/brk/modules/brk-client/index.js:479](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L479) Total block size in weight units @@ -24,7 +24,7 @@ Total block size in weight units > **blockVSize**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:408](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L408) +Defined in: [Developer/brk/modules/brk-client/index.js:480](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L480) Total block virtual size in vbytes @@ -34,7 +34,7 @@ Total block virtual size in vbytes > **feeRange**: `number`[] -Defined in: [Developer/brk/modules/brk-client/index.js:412](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L412) +Defined in: [Developer/brk/modules/brk-client/index.js:484](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L484) Fee rate range: [min, 10%, 25%, 50%, 75%, 90%, max] @@ -44,7 +44,7 @@ Fee rate range: [min, 10%, 25%, 50%, 75%, 90%, max] > **medianFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:411](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L411) +Defined in: [Developer/brk/modules/brk-client/index.js:483](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L483) Median fee rate in sat/vB @@ -54,7 +54,7 @@ Median fee rate in sat/vB > **nTx**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:409](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L409) +Defined in: [Developer/brk/modules/brk-client/index.js:481](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L481) Number of transactions in the projected block @@ -64,6 +64,6 @@ Number of transactions in the projected block > **totalFees**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:410](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L410) +Defined in: [Developer/brk/modules/brk-client/index.js:482](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L482) Total fees in satoshis diff --git a/modules/brk-client/docs/interfaces/MempoolInfo.md b/modules/brk-client/docs/interfaces/MempoolInfo.md index 951ce0c50..982042dd6 100644 --- a/modules/brk-client/docs/interfaces/MempoolInfo.md +++ b/modules/brk-client/docs/interfaces/MempoolInfo.md @@ -6,7 +6,7 @@ # Interface: MempoolInfo -Defined in: [Developer/brk/modules/brk-client/index.js:417](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L417) +Defined in: [Developer/brk/modules/brk-client/index.js:489](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L489) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:417](https://github.com/b > **count**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:418](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L418) +Defined in: [Developer/brk/modules/brk-client/index.js:490](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L490) Number of transactions in the mempool @@ -24,7 +24,7 @@ Number of transactions in the mempool > **totalFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:420](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L420) +Defined in: [Developer/brk/modules/brk-client/index.js:492](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L492) Total fees of all transactions in the mempool (satoshis) @@ -34,6 +34,6 @@ Total fees of all transactions in the mempool (satoshis) > **vsize**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:419](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L419) +Defined in: [Developer/brk/modules/brk-client/index.js:491](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L491) Total virtual size of all transactions in the mempool (vbytes) diff --git a/modules/brk-client/docs/interfaces/MetricCount.md b/modules/brk-client/docs/interfaces/MetricCount.md deleted file mode 100644 index 187abaf88..000000000 --- a/modules/brk-client/docs/interfaces/MetricCount.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricCount - -# Interface: MetricCount - -Defined in: [Developer/brk/modules/brk-client/index.js:430](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L430) - -## Properties - -### distinctMetrics - -> **distinctMetrics**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:431](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L431) - -Number of unique metrics available (e.g., realized_price, market_cap) - -*** - -### lazyEndpoints - -> **lazyEndpoints**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:433](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L433) - -Number of lazy (computed on-the-fly) metric-index combinations - -*** - -### storedEndpoints - -> **storedEndpoints**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:434](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L434) - -Number of eager (stored on disk) metric-index combinations - -*** - -### totalEndpoints - -> **totalEndpoints**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:432](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L432) - -Total number of metric-index combinations across all timeframes diff --git a/modules/brk-client/docs/interfaces/MetricData.md b/modules/brk-client/docs/interfaces/MetricData.md deleted file mode 100644 index a688af051..000000000 --- a/modules/brk-client/docs/interfaces/MetricData.md +++ /dev/null @@ -1,197 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricData - -# Interface: MetricData\ - -Defined in: [Developer/brk/modules/brk-client/index.js:1002](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1002) - -## Type Parameters - -### T - -`T` - -## Properties - -### data - -> **data**: `T`[] - -Defined in: [Developer/brk/modules/brk-client/index.js:1009](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1009) - -The metric data - -*** - -### dateEntries() - -> **dateEntries**: () => \[`Date`, `T`\][] - -Defined in: [Developer/brk/modules/brk-client/index.js:1014](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1014) - -Return data as [date, value] pairs (date-based only) - -#### Returns - -\[`Date`, `T`\][] - -*** - -### dates() - -> **dates**: () => `Date`[] - -Defined in: [Developer/brk/modules/brk-client/index.js:1010](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1010) - -Convert index range to dates (date-based indexes only) - -#### Returns - -`Date`[] - -*** - -### end - -> **end**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:1007](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1007) - -End index (exclusive) - -*** - -### index - -> **index**: [`Index`](../type-aliases/Index.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:1004](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1004) - -The index type used for this query - -*** - -### indexEntries() - -> **indexEntries**: () => \[`number`, `T`\][] - -Defined in: [Developer/brk/modules/brk-client/index.js:1015](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1015) - -Return data as [index, value] pairs - -#### Returns - -\[`number`, `T`\][] - -*** - -### indexes() - -> **indexes**: () => `number`[] - -Defined in: [Developer/brk/modules/brk-client/index.js:1011](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1011) - -Get index range as array - -#### Returns - -`number`[] - -*** - -### iter() - -> **iter**: () => `IterableIterator`\<\[`number`, `T`\]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1016](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1016) - -Iterate over [index, value] pairs - -#### Returns - -`IterableIterator`\<\[`number`, `T`\]\> - -*** - -### iterDates() - -> **iterDates**: () => `IterableIterator`\<\[`Date`, `T`\]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1017](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1017) - -Iterate over [date, value] pairs (date-based only) - -#### Returns - -`IterableIterator`\<\[`Date`, `T`\]\> - -*** - -### stamp - -> **stamp**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:1008](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1008) - -ISO 8601 timestamp of when the response was generated - -*** - -### start - -> **start**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:1006](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1006) - -Start index (inclusive) - -*** - -### toDateMap() - -> **toDateMap**: () => `Map`\<`Date`, `T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1012](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1012) - -Return data as Map keyed by date (date-based only) - -#### Returns - -`Map`\<`Date`, `T`\> - -*** - -### toIndexMap() - -> **toIndexMap**: () => `Map`\<`number`, `T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1013](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1013) - -Return data as Map keyed by index - -#### Returns - -`Map`\<`number`, `T`\> - -*** - -### total - -> **total**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:1005](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1005) - -Total number of data points - -*** - -### version - -> **version**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:1003](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1003) - -Version of the metric data diff --git a/modules/brk-client/docs/interfaces/MetricEndpointBuilder.md b/modules/brk-client/docs/interfaces/MetricEndpointBuilder.md deleted file mode 100644 index cfff0fd59..000000000 --- a/modules/brk-client/docs/interfaces/MetricEndpointBuilder.md +++ /dev/null @@ -1,173 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricEndpointBuilder - -# Interface: MetricEndpointBuilder\ - -Defined in: [Developer/brk/modules/brk-client/index.js:1030](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1030) - -## Type Parameters - -### T - -`T` - -## Properties - -### fetch() - -> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1036](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1036) - -Fetch all data - -#### Parameters - -##### onUpdate? - -(`value`) => `void` - -#### Returns - -`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> - -*** - -### fetchCsv() - -> **fetchCsv**: () => `Promise`\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1037](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1037) - -Fetch all data as CSV - -#### Returns - -`Promise`\<`string`\> - -*** - -### first() - -> **first**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1033](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1033) - -Get first n items - -#### Parameters - -##### n - -`number` - -#### Returns - -[`RangeBuilder`](RangeBuilder.md)\<`T`\> - -*** - -### get() - -> **get**: (`index`) => [`SingleItemBuilder`](SingleItemBuilder.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1031](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1031) - -Get single item at index - -#### Parameters - -##### index - -`number` - -#### Returns - -[`SingleItemBuilder`](SingleItemBuilder.md)\<`T`\> - -*** - -### last() - -> **last**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1034](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1034) - -Get last n items - -#### Parameters - -##### n - -`number` - -#### Returns - -[`RangeBuilder`](RangeBuilder.md)\<`T`\> - -*** - -### path - -> **path**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:1039](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1039) - -The endpoint path - -*** - -### skip() - -> **skip**: (`n`) => [`SkippedBuilder`](SkippedBuilder.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1035](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1035) - -Skip first n items, chain with take() - -#### Parameters - -##### n - -`number` - -#### Returns - -[`SkippedBuilder`](SkippedBuilder.md)\<`T`\> - -*** - -### slice() - -> **slice**: (`start?`, `end?`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1032](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1032) - -Slice like Array.slice - -#### Parameters - -##### start? - -`number` - -##### end? - -`number` - -#### Returns - -[`RangeBuilder`](RangeBuilder.md)\<`T`\> - -*** - -### then - -> **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1038](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1038) - -Thenable (await endpoint) diff --git a/modules/brk-client/docs/interfaces/MetricLeafWithSchema.md b/modules/brk-client/docs/interfaces/MetricLeafWithSchema.md deleted file mode 100644 index 305aa1b2c..000000000 --- a/modules/brk-client/docs/interfaces/MetricLeafWithSchema.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricLeafWithSchema - -# Interface: MetricLeafWithSchema - -Defined in: [Developer/brk/modules/brk-client/index.js:439](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L439) - -## Properties - -### indexes - -> **indexes**: [`Index`](../type-aliases/Index.md)[] - -Defined in: [Developer/brk/modules/brk-client/index.js:442](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L442) - -Available indexes for this metric - -*** - -### kind - -> **kind**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:441](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L441) - -The Rust type (e.g., "Sats", "StoredF64") - -*** - -### name - -> **name**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:440](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L440) - -The metric name/identifier - -*** - -### type - -> **type**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:443](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L443) - -JSON Schema type (e.g., "integer", "number", "string", "boolean", "array", "object") diff --git a/modules/brk-client/docs/interfaces/MetricParam.md b/modules/brk-client/docs/interfaces/MetricParam.md deleted file mode 100644 index d2165dbd0..000000000 --- a/modules/brk-client/docs/interfaces/MetricParam.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricParam - -# Interface: MetricParam - -Defined in: [Developer/brk/modules/brk-client/index.js:446](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L446) - -## Properties - -### metric - -> **metric**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:447](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L447) diff --git a/modules/brk-client/docs/interfaces/MetricPattern.md b/modules/brk-client/docs/interfaces/MetricPattern.md deleted file mode 100644 index d1254b0c1..000000000 --- a/modules/brk-client/docs/interfaces/MetricPattern.md +++ /dev/null @@ -1,69 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern - -# Interface: MetricPattern\ - -Defined in: [Developer/brk/modules/brk-client/index.js:1070](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1070) - -## Type Parameters - -### T - -`T` - -## Properties - -### by - -> **by**: `Readonly`\<`Partial`\<`Record`\<[`Index`](../type-aliases/Index.md), [`MetricEndpointBuilder`](MetricEndpointBuilder.md)\<`T`\>\>\>\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1072](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1072) - -Index endpoints as lazy getters. Access via .by.dateindex or .by['dateindex'] - -*** - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -Defined in: [Developer/brk/modules/brk-client/index.js:1074](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1074) - -Get an endpoint for a specific index - -#### Parameters - -##### index - -[`Index`](../type-aliases/Index.md) - -#### Returns - -[`MetricEndpointBuilder`](MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -*** - -### indexes() - -> **indexes**: () => readonly [`Index`](../type-aliases/Index.md)[] - -Defined in: [Developer/brk/modules/brk-client/index.js:1073](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1073) - -Get the list of available indexes - -#### Returns - -readonly [`Index`](../type-aliases/Index.md)[] - -*** - -### name - -> **name**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:1071](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1071) - -The metric name diff --git a/modules/brk-client/docs/interfaces/MetricSelection.md b/modules/brk-client/docs/interfaces/MetricSelection.md deleted file mode 100644 index 07901a379..000000000 --- a/modules/brk-client/docs/interfaces/MetricSelection.md +++ /dev/null @@ -1,69 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricSelection - -# Interface: MetricSelection - -Defined in: [Developer/brk/modules/brk-client/index.js:452](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L452) - -## Properties - -### end? - -> `optional` **end**: `number` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:456](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L456) - -Exclusive ending index, if negative counts from end - -*** - -### format? - -> `optional` **format**: [`Format`](../type-aliases/Format.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:458](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L458) - -Format of the output - -*** - -### index - -> **index**: [`Index`](../type-aliases/Index.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:454](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L454) - -Index to query - -*** - -### limit? - -> `optional` **limit**: `number` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:457](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L457) - -Maximum number of values to return (ignored if `end` is set) - -*** - -### metrics - -> **metrics**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:453](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L453) - -Requested metrics - -*** - -### start? - -> `optional` **start**: `number` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:455](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L455) - -Inclusive starting index, if negative counts from end diff --git a/modules/brk-client/docs/interfaces/MetricSelectionLegacy.md b/modules/brk-client/docs/interfaces/MetricSelectionLegacy.md deleted file mode 100644 index fee05bd99..000000000 --- a/modules/brk-client/docs/interfaces/MetricSelectionLegacy.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricSelectionLegacy - -# Interface: MetricSelectionLegacy - -Defined in: [Developer/brk/modules/brk-client/index.js:463](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L463) - -## Properties - -### end? - -> `optional` **end**: `number` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:467](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L467) - -Exclusive ending index, if negative counts from end - -*** - -### format? - -> `optional` **format**: [`Format`](../type-aliases/Format.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:469](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L469) - -Format of the output - -*** - -### ids - -> **ids**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:465](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L465) - -*** - -### index - -> **index**: [`Index`](../type-aliases/Index.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:464](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L464) - -*** - -### limit? - -> `optional` **limit**: `number` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:468](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L468) - -Maximum number of values to return (ignored if `end` is set) - -*** - -### start? - -> `optional` **start**: `number` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:466](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L466) - -Inclusive starting index, if negative counts from end diff --git a/modules/brk-client/docs/interfaces/MetricWithIndex.md b/modules/brk-client/docs/interfaces/MetricWithIndex.md deleted file mode 100644 index c7914b80b..000000000 --- a/modules/brk-client/docs/interfaces/MetricWithIndex.md +++ /dev/null @@ -1,29 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricWithIndex - -# Interface: MetricWithIndex - -Defined in: [Developer/brk/modules/brk-client/index.js:472](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L472) - -## Properties - -### index - -> **index**: [`Index`](../type-aliases/Index.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:474](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L474) - -Aggregation index - -*** - -### metric - -> **metric**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:473](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L473) - -Metric name diff --git a/modules/brk-client/docs/interfaces/MetricsTree.md b/modules/brk-client/docs/interfaces/MetricsTree.md deleted file mode 100644 index cdc2d7cba..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree - -# Interface: MetricsTree - -Defined in: [Developer/brk/modules/brk-client/index.js:3505](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3505) - -## Properties - -### addresses - -> **addresses**: [`MetricsTree_Addresses`](MetricsTree_Addresses.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3510](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3510) - -*** - -### blocks - -> **blocks**: [`MetricsTree_Blocks`](MetricsTree_Blocks.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3506](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3506) - -*** - -### cointime - -> **cointime**: [`MetricsTree_Cointime`](MetricsTree_Cointime.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3513](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3513) - -*** - -### constants - -> **constants**: [`MetricsTree_Constants`](MetricsTree_Constants.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3514](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3514) - -*** - -### distribution - -> **distribution**: [`MetricsTree_Distribution`](MetricsTree_Distribution.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3519](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3519) - -*** - -### indexes - -> **indexes**: [`MetricsTree_Indexes`](MetricsTree_Indexes.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3515](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3515) - -*** - -### inputs - -> **inputs**: [`MetricsTree_Inputs`](MetricsTree_Inputs.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3508](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3508) - -*** - -### market - -> **market**: [`MetricsTree_Market`](MetricsTree_Market.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3516](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3516) - -*** - -### outputs - -> **outputs**: [`MetricsTree_Outputs`](MetricsTree_Outputs.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3509](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3509) - -*** - -### pools - -> **pools**: [`MetricsTree_Pools`](MetricsTree_Pools.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3517](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3517) - -*** - -### positions - -> **positions**: [`MetricsTree_Positions`](MetricsTree_Positions.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3512](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3512) - -*** - -### price - -> **price**: [`MetricsTree_Price`](MetricsTree_Price.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3518](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3518) - -*** - -### scripts - -> **scripts**: [`MetricsTree_Scripts`](MetricsTree_Scripts.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3511](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3511) - -*** - -### supply - -> **supply**: [`MetricsTree_Supply`](MetricsTree_Supply.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3520](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3520) - -*** - -### transactions - -> **transactions**: [`MetricsTree_Transactions`](MetricsTree_Transactions.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3507](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3507) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Addresses.md b/modules/brk-client/docs/interfaces/MetricsTree_Addresses.md deleted file mode 100644 index b0075e4ef..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Addresses.md +++ /dev/null @@ -1,137 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Addresses - -# Interface: MetricsTree\_Addresses - -Defined in: [Developer/brk/modules/brk-client/index.js:3735](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3735) - -## Properties - -### firstP2aaddressindex - -> **firstP2aaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3743](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3743) - -*** - -### firstP2pk33addressindex - -> **firstP2pk33addressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3737](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3737) - -*** - -### firstP2pk65addressindex - -> **firstP2pk65addressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3736](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3736) - -*** - -### firstP2pkhaddressindex - -> **firstP2pkhaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3738](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3738) - -*** - -### firstP2shaddressindex - -> **firstP2shaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3739](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3739) - -*** - -### firstP2traddressindex - -> **firstP2traddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3742](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3742) - -*** - -### firstP2wpkhaddressindex - -> **firstP2wpkhaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3740](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3740) - -*** - -### firstP2wshaddressindex - -> **firstP2wshaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3741](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3741) - -*** - -### p2abytes - -> **p2abytes**: [`MetricPattern16`](../type-aliases/MetricPattern16.md)\<[`U8x2`](../type-aliases/U8x2.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3751](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3751) - -*** - -### p2pk33bytes - -> **p2pk33bytes**: [`MetricPattern18`](../type-aliases/MetricPattern18.md)\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3745](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3745) - -*** - -### p2pk65bytes - -> **p2pk65bytes**: [`MetricPattern19`](../type-aliases/MetricPattern19.md)\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3744](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3744) - -*** - -### p2pkhbytes - -> **p2pkhbytes**: [`MetricPattern20`](../type-aliases/MetricPattern20.md)\<[`U8x20`](../type-aliases/U8x20.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3746](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3746) - -*** - -### p2shbytes - -> **p2shbytes**: [`MetricPattern21`](../type-aliases/MetricPattern21.md)\<[`U8x20`](../type-aliases/U8x20.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3747](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3747) - -*** - -### p2trbytes - -> **p2trbytes**: [`MetricPattern22`](../type-aliases/MetricPattern22.md)\<[`U8x32`](../type-aliases/U8x32.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3750](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3750) - -*** - -### p2wpkhbytes - -> **p2wpkhbytes**: [`MetricPattern23`](../type-aliases/MetricPattern23.md)\<[`U8x20`](../type-aliases/U8x20.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3748](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3748) - -*** - -### p2wshbytes - -> **p2wshbytes**: [`MetricPattern24`](../type-aliases/MetricPattern24.md)\<[`U8x32`](../type-aliases/U8x32.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3749](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3749) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks.md deleted file mode 100644 index 0b1e61785..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Blocks.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Blocks - -# Interface: MetricsTree\_Blocks - -Defined in: [Developer/brk/modules/brk-client/index.js:3524](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3524) - -## Properties - -### blockhash - -> **blockhash**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3525](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3525) - -*** - -### count - -> **count**: [`MetricsTree_Blocks_Count`](MetricsTree_Blocks_Count.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3530](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3530) - -*** - -### difficulty - -> **difficulty**: [`MetricsTree_Blocks_Difficulty`](MetricsTree_Blocks_Difficulty.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3526](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3526) - -*** - -### fullness - -> **fullness**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3537](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3537) - -*** - -### halving - -> **halving**: [`MetricsTree_Blocks_Halving`](MetricsTree_Blocks_Halving.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3534](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3534) - -*** - -### interval - -> **interval**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3531](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3531) - -*** - -### mining - -> **mining**: [`MetricsTree_Blocks_Mining`](MetricsTree_Blocks_Mining.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3532](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3532) - -*** - -### rewards - -> **rewards**: [`MetricsTree_Blocks_Rewards`](MetricsTree_Blocks_Rewards.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3533](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3533) - -*** - -### size - -> **size**: [`MetricsTree_Blocks_Size`](MetricsTree_Blocks_Size.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3536](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3536) - -*** - -### time - -> **time**: [`MetricsTree_Blocks_Time`](MetricsTree_Blocks_Time.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3527](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3527) - -*** - -### totalSize - -> **totalSize**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3528](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3528) - -*** - -### vbytes - -> **vbytes**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3535](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3535) - -*** - -### weight - -> **weight**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3529](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3529) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Count.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Count.md deleted file mode 100644 index 63d03577a..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Count.md +++ /dev/null @@ -1,89 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Blocks\_Count - -# Interface: MetricsTree\_Blocks\_Count - -Defined in: [Developer/brk/modules/brk-client/index.js:3558](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3558) - -## Properties - -### \_1mBlockCount - -> **\_1mBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3567](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3567) - -*** - -### \_1mStart - -> **\_1mStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3563](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3563) - -*** - -### \_1wBlockCount - -> **\_1wBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3566](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3566) - -*** - -### \_1wStart - -> **\_1wStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3562](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3562) - -*** - -### \_1yBlockCount - -> **\_1yBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3568](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3568) - -*** - -### \_1yStart - -> **\_1yStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3564](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3564) - -*** - -### \_24hBlockCount - -> **\_24hBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3565](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3565) - -*** - -### \_24hStart - -> **\_24hStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3561](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3561) - -*** - -### blockCount - -> **blockCount**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3560](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3560) - -*** - -### blockCountTarget - -> **blockCountTarget**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3559](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3559) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Difficulty.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Difficulty.md deleted file mode 100644 index 5ce21a847..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Difficulty.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Blocks\_Difficulty - -# Interface: MetricsTree\_Blocks\_Difficulty - -Defined in: [Developer/brk/modules/brk-client/index.js:3541](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3541) - -## Properties - -### adjustment - -> **adjustment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3544](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3544) - -*** - -### asHash - -> **asHash**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3543](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3543) - -*** - -### blocksBeforeNextAdjustment - -> **blocksBeforeNextAdjustment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3546](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3546) - -*** - -### daysBeforeNextAdjustment - -> **daysBeforeNextAdjustment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3547](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3547) - -*** - -### epoch - -> **epoch**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3545](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3545) - -*** - -### raw - -> **raw**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3542](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3542) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Halving.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Halving.md deleted file mode 100644 index d64f48152..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Halving.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Blocks\_Halving - -# Interface: MetricsTree\_Blocks\_Halving - -Defined in: [Developer/brk/modules/brk-client/index.js:3611](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3611) - -## Properties - -### blocksBeforeNextHalving - -> **blocksBeforeNextHalving**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3613](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3613) - -*** - -### daysBeforeNextHalving - -> **daysBeforeNextHalving**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3614](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3614) - -*** - -### epoch - -> **epoch**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3612](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3612) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Mining.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Mining.md deleted file mode 100644 index 4e79ab0d0..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Mining.md +++ /dev/null @@ -1,145 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Blocks\_Mining - -# Interface: MetricsTree\_Blocks\_Mining - -Defined in: [Developer/brk/modules/brk-client/index.js:3572](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3572) - -## Properties - -### hashPricePhs - -> **hashPricePhs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3582](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3582) - -*** - -### hashPricePhsMin - -> **hashPricePhsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3583](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3583) - -*** - -### hashPriceRebound - -> **hashPriceRebound**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3584](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3584) - -*** - -### hashPriceThs - -> **hashPriceThs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3580](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3580) - -*** - -### hashPriceThsMin - -> **hashPriceThsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3581](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3581) - -*** - -### hashRate - -> **hashRate**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3573](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3573) - -*** - -### hashRate1mSma - -> **hashRate1mSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3575](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3575) - -*** - -### hashRate1wSma - -> **hashRate1wSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3574](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3574) - -*** - -### hashRate1ySma - -> **hashRate1ySma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3577](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3577) - -*** - -### hashRate2mSma - -> **hashRate2mSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3576](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3576) - -*** - -### hashRateAth - -> **hashRateAth**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3578](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3578) - -*** - -### hashRateDrawdown - -> **hashRateDrawdown**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3579](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3579) - -*** - -### hashValuePhs - -> **hashValuePhs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3587](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3587) - -*** - -### hashValuePhsMin - -> **hashValuePhsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3588](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3588) - -*** - -### hashValueRebound - -> **hashValueRebound**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3589](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3589) - -*** - -### hashValueThs - -> **hashValueThs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3585](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3585) - -*** - -### hashValueThsMin - -> **hashValueThsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3586](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3586) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards.md deleted file mode 100644 index 6cbfe6701..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Blocks\_Rewards - -# Interface: MetricsTree\_Blocks\_Rewards - -Defined in: [Developer/brk/modules/brk-client/index.js:3593](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3593) - -## Properties - -### \_24hCoinbaseSum - -> **\_24hCoinbaseSum**: [`MetricsTree_Blocks_Rewards_24hCoinbaseSum`](MetricsTree_Blocks_Rewards_24hCoinbaseSum.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3594](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3594) - -*** - -### coinbase - -> **coinbase**: [`BitcoinDollarsSatsPattern2`](BitcoinDollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3595](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3595) - -*** - -### feeDominance - -> **feeDominance**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3598](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3598) - -*** - -### subsidy - -> **subsidy**: [`BitcoinDollarsSatsPattern2`](BitcoinDollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3596](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3596) - -*** - -### subsidyDominance - -> **subsidyDominance**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3599](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3599) - -*** - -### subsidyUsd1ySma - -> **subsidyUsd1ySma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3600](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3600) - -*** - -### unclaimedRewards - -> **unclaimedRewards**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3597](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3597) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards_24hCoinbaseSum.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards_24hCoinbaseSum.md deleted file mode 100644 index 97edf87e2..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards_24hCoinbaseSum.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Blocks\_Rewards\_24hCoinbaseSum - -# Interface: MetricsTree\_Blocks\_Rewards\_24hCoinbaseSum - -Defined in: [Developer/brk/modules/brk-client/index.js:3604](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3604) - -## Properties - -### bitcoin - -> **bitcoin**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3606](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3606) - -*** - -### dollars - -> **dollars**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3607](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3607) - -*** - -### sats - -> **sats**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3605](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3605) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Size.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Size.md deleted file mode 100644 index 95c37a4db..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Size.md +++ /dev/null @@ -1,89 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Blocks\_Size - -# Interface: MetricsTree\_Blocks\_Size - -Defined in: [Developer/brk/modules/brk-client/index.js:3618](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3618) - -## Properties - -### average - -> **average**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3620](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3620) - -*** - -### cumulative - -> **cumulative**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3619](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3619) - -*** - -### max - -> **max**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3622](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3622) - -*** - -### median - -> **median**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3625](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3625) - -*** - -### min - -> **min**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3621](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3621) - -*** - -### pct10 - -> **pct10**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3623](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3623) - -*** - -### pct25 - -> **pct25**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3624](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3624) - -*** - -### pct75 - -> **pct75**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3626](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3626) - -*** - -### pct90 - -> **pct90**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3627](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3627) - -*** - -### sum - -> **sum**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3628](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3628) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Time.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Time.md deleted file mode 100644 index 3237edcab..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Time.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Blocks\_Time - -# Interface: MetricsTree\_Blocks\_Time - -Defined in: [Developer/brk/modules/brk-client/index.js:3551](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3551) - -## Properties - -### date - -> **date**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3553](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3553) - -*** - -### timestamp - -> **timestamp**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3552](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3552) - -*** - -### timestampMonotonic - -> **timestampMonotonic**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3554](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3554) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime.md deleted file mode 100644 index 0dc4ec60f..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Cointime.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Cointime - -# Interface: MetricsTree\_Cointime - -Defined in: [Developer/brk/modules/brk-client/index.js:3799](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3799) - -## Properties - -### activity - -> **activity**: [`MetricsTree_Cointime_Activity`](MetricsTree_Cointime_Activity.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3800](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3800) - -*** - -### adjusted - -> **adjusted**: [`MetricsTree_Cointime_Adjusted`](MetricsTree_Cointime_Adjusted.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3805](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3805) - -*** - -### cap - -> **cap**: [`MetricsTree_Cointime_Cap`](MetricsTree_Cointime_Cap.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3803](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3803) - -*** - -### pricing - -> **pricing**: [`MetricsTree_Cointime_Pricing`](MetricsTree_Cointime_Pricing.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3804](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3804) - -*** - -### reserveRisk - -> **reserveRisk**: [`MetricsTree_Cointime_ReserveRisk`](MetricsTree_Cointime_ReserveRisk.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3806](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3806) - -*** - -### supply - -> **supply**: [`MetricsTree_Cointime_Supply`](MetricsTree_Cointime_Supply.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3801](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3801) - -*** - -### value - -> **value**: [`MetricsTree_Cointime_Value`](MetricsTree_Cointime_Value.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3802](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3802) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Activity.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Activity.md deleted file mode 100644 index 7a64ea0cd..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Activity.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Cointime\_Activity - -# Interface: MetricsTree\_Cointime\_Activity - -Defined in: [Developer/brk/modules/brk-client/index.js:3810](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3810) - -## Properties - -### activityToVaultednessRatio - -> **activityToVaultednessRatio**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3815](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3815) - -*** - -### coinblocksCreated - -> **coinblocksCreated**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3811](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3811) - -*** - -### coinblocksStored - -> **coinblocksStored**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3812](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3812) - -*** - -### liveliness - -> **liveliness**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3813](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3813) - -*** - -### vaultedness - -> **vaultedness**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3814](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3814) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Adjusted.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Adjusted.md deleted file mode 100644 index 624b3b0f7..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Adjusted.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Cointime\_Adjusted - -# Interface: MetricsTree\_Cointime\_Adjusted - -Defined in: [Developer/brk/modules/brk-client/index.js:3854](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3854) - -## Properties - -### cointimeAdjInflationRate - -> **cointimeAdjInflationRate**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3855](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3855) - -*** - -### cointimeAdjTxBtcVelocity - -> **cointimeAdjTxBtcVelocity**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3856](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3856) - -*** - -### cointimeAdjTxUsdVelocity - -> **cointimeAdjTxUsdVelocity**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3857](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3857) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Cap.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Cap.md deleted file mode 100644 index 0546126da..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Cap.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Cointime\_Cap - -# Interface: MetricsTree\_Cointime\_Cap - -Defined in: [Developer/brk/modules/brk-client/index.js:3833](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3833) - -## Properties - -### activeCap - -> **activeCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3837](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3837) - -*** - -### cointimeCap - -> **cointimeCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3838](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3838) - -*** - -### investorCap - -> **investorCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3835](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3835) - -*** - -### thermoCap - -> **thermoCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3834](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3834) - -*** - -### vaultedCap - -> **vaultedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3836](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3836) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Pricing.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Pricing.md deleted file mode 100644 index 4b422b030..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Pricing.md +++ /dev/null @@ -1,73 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Cointime\_Pricing - -# Interface: MetricsTree\_Cointime\_Pricing - -Defined in: [Developer/brk/modules/brk-client/index.js:3842](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3842) - -## Properties - -### activePrice - -> **activePrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3845](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3845) - -*** - -### activePriceRatio - -> **activePriceRatio**: [`RatioPattern`](RatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3846](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3846) - -*** - -### cointimePrice - -> **cointimePrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3849](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3849) - -*** - -### cointimePriceRatio - -> **cointimePriceRatio**: [`RatioPattern`](RatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3850](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3850) - -*** - -### trueMarketMean - -> **trueMarketMean**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3847](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3847) - -*** - -### trueMarketMeanRatio - -> **trueMarketMeanRatio**: [`RatioPattern`](RatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3848](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3848) - -*** - -### vaultedPrice - -> **vaultedPrice**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3843](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3843) - -*** - -### vaultedPriceRatio - -> **vaultedPriceRatio**: [`RatioPattern`](RatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3844](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3844) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_ReserveRisk.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_ReserveRisk.md deleted file mode 100644 index 1b0bd0ba4..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_ReserveRisk.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Cointime\_ReserveRisk - -# Interface: MetricsTree\_Cointime\_ReserveRisk - -Defined in: [Developer/brk/modules/brk-client/index.js:3861](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3861) - -## Properties - -### hodlBank - -> **hodlBank**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3863](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3863) - -*** - -### reserveRisk - -> **reserveRisk**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3864](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3864) - -*** - -### vocdd365dMedian - -> **vocdd365dMedian**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3862](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3862) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Supply.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Supply.md deleted file mode 100644 index 1715bf52e..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Supply.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Cointime\_Supply - -# Interface: MetricsTree\_Cointime\_Supply - -Defined in: [Developer/brk/modules/brk-client/index.js:3819](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3819) - -## Properties - -### activeSupply - -> **activeSupply**: [`BitcoinDollarsSatsPattern4`](BitcoinDollarsSatsPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3821](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3821) - -*** - -### vaultedSupply - -> **vaultedSupply**: [`BitcoinDollarsSatsPattern4`](BitcoinDollarsSatsPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3820](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3820) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Value.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Value.md deleted file mode 100644 index f5f33f85c..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Value.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Cointime\_Value - -# Interface: MetricsTree\_Cointime\_Value - -Defined in: [Developer/brk/modules/brk-client/index.js:3825](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3825) - -## Properties - -### cointimeValueCreated - -> **cointimeValueCreated**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3827](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3827) - -*** - -### cointimeValueDestroyed - -> **cointimeValueDestroyed**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3826](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3826) - -*** - -### cointimeValueStored - -> **cointimeValueStored**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3828](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3828) - -*** - -### vocdd - -> **vocdd**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3829](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3829) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Constants.md b/modules/brk-client/docs/interfaces/MetricsTree_Constants.md deleted file mode 100644 index b0b85d8de..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Constants.md +++ /dev/null @@ -1,153 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Constants - -# Interface: MetricsTree\_Constants - -Defined in: [Developer/brk/modules/brk-client/index.js:3868](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3868) - -## Properties - -### constant0 - -> **constant0**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3869](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3869) - -*** - -### constant1 - -> **constant1**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3870](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3870) - -*** - -### constant100 - -> **constant100**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3881](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3881) - -*** - -### constant2 - -> **constant2**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3871](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3871) - -*** - -### constant20 - -> **constant20**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3874](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3874) - -*** - -### constant3 - -> **constant3**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3872](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3872) - -*** - -### constant30 - -> **constant30**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3875](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3875) - -*** - -### constant382 - -> **constant382**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3876](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3876) - -*** - -### constant4 - -> **constant4**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3873](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3873) - -*** - -### constant50 - -> **constant50**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3877](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3877) - -*** - -### constant600 - -> **constant600**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3882](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3882) - -*** - -### constant618 - -> **constant618**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3878](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3878) - -*** - -### constant70 - -> **constant70**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3879](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3879) - -*** - -### constant80 - -> **constant80**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3880](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3880) - -*** - -### constantMinus1 - -> **constantMinus1**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3883](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3883) - -*** - -### constantMinus2 - -> **constantMinus2**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3884](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3884) - -*** - -### constantMinus3 - -> **constantMinus3**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3885](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3885) - -*** - -### constantMinus4 - -> **constantMinus4**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3886](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3886) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution.md deleted file mode 100644 index e77f32435..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution - -# Interface: MetricsTree\_Distribution - -Defined in: [Developer/brk/modules/brk-client/index.js:4586](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4586) - -## Properties - -### addrCount - -> **addrCount**: [`AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern`](AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4592](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4592) - -*** - -### addressActivity - -> **addressActivity**: [`MetricsTree_Distribution_AddressActivity`](MetricsTree_Distribution_AddressActivity.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4594](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4594) - -*** - -### addressCohorts - -> **addressCohorts**: [`MetricsTree_Distribution_AddressCohorts`](MetricsTree_Distribution_AddressCohorts.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4591](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4591) - -*** - -### addressesData - -> **addressesData**: [`MetricsTree_Distribution_AddressesData`](MetricsTree_Distribution_AddressesData.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4589](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4589) - -*** - -### anyAddressIndexes - -> **anyAddressIndexes**: [`MetricsTree_Distribution_AnyAddressIndexes`](MetricsTree_Distribution_AnyAddressIndexes.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4588](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4588) - -*** - -### emptyAddrCount - -> **emptyAddrCount**: [`AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern`](AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4593](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4593) - -*** - -### emptyaddressindex - -> **emptyaddressindex**: [`MetricPattern32`](../type-aliases/MetricPattern32.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4599](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4599) - -*** - -### fundedaddressindex - -> **fundedaddressindex**: [`MetricPattern31`](../type-aliases/MetricPattern31.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4598](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4598) - -*** - -### growthRate - -> **growthRate**: [`MetricsTree_Distribution_GrowthRate`](MetricsTree_Distribution_GrowthRate.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4597](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4597) - -*** - -### newAddrCount - -> **newAddrCount**: [`MetricsTree_Distribution_NewAddrCount`](MetricsTree_Distribution_NewAddrCount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4596](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4596) - -*** - -### supplyState - -> **supplyState**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<[`SupplyState`](SupplyState.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4587](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4587) - -*** - -### totalAddrCount - -> **totalAddrCount**: [`MetricsTree_Distribution_TotalAddrCount`](MetricsTree_Distribution_TotalAddrCount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4595](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4595) - -*** - -### utxoCohorts - -> **utxoCohorts**: [`MetricsTree_Distribution_UtxoCohorts`](MetricsTree_Distribution_UtxoCohorts.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4590](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4590) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressActivity.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressActivity.md deleted file mode 100644 index cb898090f..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressActivity.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_AddressActivity - -# Interface: MetricsTree\_Distribution\_AddressActivity - -Defined in: [Developer/brk/modules/brk-client/index.js:4921](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4921) - -## Properties - -### all - -> **all**: [`BalanceBothReactivatedReceivingSendingPattern`](BalanceBothReactivatedReceivingSendingPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4922](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4922) - -*** - -### p2a - -> **p2a**: [`BalanceBothReactivatedReceivingSendingPattern`](BalanceBothReactivatedReceivingSendingPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4930](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4930) - -*** - -### p2pk33 - -> **p2pk33**: [`BalanceBothReactivatedReceivingSendingPattern`](BalanceBothReactivatedReceivingSendingPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4924](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4924) - -*** - -### p2pk65 - -> **p2pk65**: [`BalanceBothReactivatedReceivingSendingPattern`](BalanceBothReactivatedReceivingSendingPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4923](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4923) - -*** - -### p2pkh - -> **p2pkh**: [`BalanceBothReactivatedReceivingSendingPattern`](BalanceBothReactivatedReceivingSendingPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4925](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4925) - -*** - -### p2sh - -> **p2sh**: [`BalanceBothReactivatedReceivingSendingPattern`](BalanceBothReactivatedReceivingSendingPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4926](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4926) - -*** - -### p2tr - -> **p2tr**: [`BalanceBothReactivatedReceivingSendingPattern`](BalanceBothReactivatedReceivingSendingPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4929](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4929) - -*** - -### p2wpkh - -> **p2wpkh**: [`BalanceBothReactivatedReceivingSendingPattern`](BalanceBothReactivatedReceivingSendingPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4927](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4927) - -*** - -### p2wsh - -> **p2wsh**: [`BalanceBothReactivatedReceivingSendingPattern`](BalanceBothReactivatedReceivingSendingPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4928](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4928) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts.md deleted file mode 100644 index 4bbdaef66..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_AddressCohorts - -# Interface: MetricsTree\_Distribution\_AddressCohorts - -Defined in: [Developer/brk/modules/brk-client/index.js:4861](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4861) - -## Properties - -### amountRange - -> **amountRange**: [`MetricsTree_Distribution_AddressCohorts_AmountRange`](MetricsTree_Distribution_AddressCohorts_AmountRange.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4863](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4863) - -*** - -### geAmount - -> **geAmount**: [`MetricsTree_Distribution_AddressCohorts_GeAmount`](MetricsTree_Distribution_AddressCohorts_GeAmount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4862](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4862) - -*** - -### ltAmount - -> **ltAmount**: [`MetricsTree_Distribution_AddressCohorts_LtAmount`](MetricsTree_Distribution_AddressCohorts_LtAmount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4864](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4864) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_AmountRange.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_AmountRange.md deleted file mode 100644 index f9a19aced..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_AmountRange.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_AddressCohorts\_AmountRange - -# Interface: MetricsTree\_Distribution\_AddressCohorts\_AmountRange - -Defined in: [Developer/brk/modules/brk-client/index.js:4885](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4885) - -## Properties - -### \_0sats - -> **\_0sats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4886](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4886) - -*** - -### \_100btcTo1kBtc - -> **\_100btcTo1kBtc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4897](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4897) - -*** - -### \_100kBtcOrMore - -> **\_100kBtcOrMore**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4900](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4900) - -*** - -### \_100kSatsTo1mSats - -> **\_100kSatsTo1mSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4892](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4892) - -*** - -### \_100satsTo1kSats - -> **\_100satsTo1kSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4889](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4889) - -*** - -### \_10btcTo100btc - -> **\_10btcTo100btc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4896](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4896) - -*** - -### \_10kBtcTo100kBtc - -> **\_10kBtcTo100kBtc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4899](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4899) - -*** - -### \_10kSatsTo100kSats - -> **\_10kSatsTo100kSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4891](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4891) - -*** - -### \_10mSatsTo1btc - -> **\_10mSatsTo1btc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4894](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4894) - -*** - -### \_10satsTo100sats - -> **\_10satsTo100sats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4888](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4888) - -*** - -### \_1btcTo10btc - -> **\_1btcTo10btc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4895](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4895) - -*** - -### \_1kBtcTo10kBtc - -> **\_1kBtcTo10kBtc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4898](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4898) - -*** - -### \_1kSatsTo10kSats - -> **\_1kSatsTo10kSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4890](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4890) - -*** - -### \_1mSatsTo10mSats - -> **\_1mSatsTo10mSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4893](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4893) - -*** - -### \_1satTo10sats - -> **\_1satTo10sats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4887](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4887) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_GeAmount.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_GeAmount.md deleted file mode 100644 index 510d4a86e..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_GeAmount.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_AddressCohorts\_GeAmount - -# Interface: MetricsTree\_Distribution\_AddressCohorts\_GeAmount - -Defined in: [Developer/brk/modules/brk-client/index.js:4868](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4868) - -## Properties - -### \_100btc - -> **\_100btc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4879](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4879) - -*** - -### \_100kSats - -> **\_100kSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4874](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4874) - -*** - -### \_100sats - -> **\_100sats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4871](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4871) - -*** - -### \_10btc - -> **\_10btc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4878](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4878) - -*** - -### \_10kBtc - -> **\_10kBtc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4881](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4881) - -*** - -### \_10kSats - -> **\_10kSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4873](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4873) - -*** - -### \_10mSats - -> **\_10mSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4876](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4876) - -*** - -### \_10sats - -> **\_10sats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4870](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4870) - -*** - -### \_1btc - -> **\_1btc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4877](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4877) - -*** - -### \_1kBtc - -> **\_1kBtc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4880](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4880) - -*** - -### \_1kSats - -> **\_1kSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4872](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4872) - -*** - -### \_1mSats - -> **\_1mSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4875](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4875) - -*** - -### \_1sat - -> **\_1sat**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4869](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4869) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_LtAmount.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_LtAmount.md deleted file mode 100644 index 0ae0ec5b0..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_LtAmount.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_AddressCohorts\_LtAmount - -# Interface: MetricsTree\_Distribution\_AddressCohorts\_LtAmount - -Defined in: [Developer/brk/modules/brk-client/index.js:4904](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4904) - -## Properties - -### \_100btc - -> **\_100btc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4914](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4914) - -*** - -### \_100kBtc - -> **\_100kBtc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4917](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4917) - -*** - -### \_100kSats - -> **\_100kSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4909](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4909) - -*** - -### \_100sats - -> **\_100sats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4906](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4906) - -*** - -### \_10btc - -> **\_10btc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4913](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4913) - -*** - -### \_10kBtc - -> **\_10kBtc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4916](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4916) - -*** - -### \_10kSats - -> **\_10kSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4908](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4908) - -*** - -### \_10mSats - -> **\_10mSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4911](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4911) - -*** - -### \_10sats - -> **\_10sats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4905](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4905) - -*** - -### \_1btc - -> **\_1btc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4912](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4912) - -*** - -### \_1kBtc - -> **\_1kBtc**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4915](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4915) - -*** - -### \_1kSats - -> **\_1kSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4907](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4907) - -*** - -### \_1mSats - -> **\_1mSats**: [`ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityAddrCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4910](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4910) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressesData.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressesData.md deleted file mode 100644 index fb4589ef7..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressesData.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_AddressesData - -# Interface: MetricsTree\_Distribution\_AddressesData - -Defined in: [Developer/brk/modules/brk-client/index.js:4615](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4615) - -## Properties - -### empty - -> **empty**: [`MetricPattern32`](../type-aliases/MetricPattern32.md)\<[`EmptyAddressData`](EmptyAddressData.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4617](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4617) - -*** - -### funded - -> **funded**: [`MetricPattern31`](../type-aliases/MetricPattern31.md)\<[`FundedAddressData`](FundedAddressData.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4616](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4616) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AnyAddressIndexes.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AnyAddressIndexes.md deleted file mode 100644 index 4daaa2643..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AnyAddressIndexes.md +++ /dev/null @@ -1,73 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_AnyAddressIndexes - -# Interface: MetricsTree\_Distribution\_AnyAddressIndexes - -Defined in: [Developer/brk/modules/brk-client/index.js:4603](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4603) - -## Properties - -### p2a - -> **p2a**: [`MetricPattern16`](../type-aliases/MetricPattern16.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4604](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4604) - -*** - -### p2pk33 - -> **p2pk33**: [`MetricPattern18`](../type-aliases/MetricPattern18.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4605](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4605) - -*** - -### p2pk65 - -> **p2pk65**: [`MetricPattern19`](../type-aliases/MetricPattern19.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4606](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4606) - -*** - -### p2pkh - -> **p2pkh**: [`MetricPattern20`](../type-aliases/MetricPattern20.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4607](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4607) - -*** - -### p2sh - -> **p2sh**: [`MetricPattern21`](../type-aliases/MetricPattern21.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4608](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4608) - -*** - -### p2tr - -> **p2tr**: [`MetricPattern22`](../type-aliases/MetricPattern22.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4609](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4609) - -*** - -### p2wpkh - -> **p2wpkh**: [`MetricPattern23`](../type-aliases/MetricPattern23.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4610](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4610) - -*** - -### p2wsh - -> **p2wsh**: [`MetricPattern24`](../type-aliases/MetricPattern24.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4611](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4611) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_GrowthRate.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_GrowthRate.md deleted file mode 100644 index 1c235b0a6..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_GrowthRate.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_GrowthRate - -# Interface: MetricsTree\_Distribution\_GrowthRate - -Defined in: [Developer/brk/modules/brk-client/index.js:4960](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4960) - -## Properties - -### all - -> **all**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4961](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4961) - -*** - -### p2a - -> **p2a**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4969](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4969) - -*** - -### p2pk33 - -> **p2pk33**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4963](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4963) - -*** - -### p2pk65 - -> **p2pk65**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4962](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4962) - -*** - -### p2pkh - -> **p2pkh**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4964](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4964) - -*** - -### p2sh - -> **p2sh**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4965](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4965) - -*** - -### p2tr - -> **p2tr**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4968](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4968) - -*** - -### p2wpkh - -> **p2wpkh**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4966](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4966) - -*** - -### p2wsh - -> **p2wsh**: [`AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern`](AverageBaseMaxMedianMinPct10Pct25Pct75Pct90Pattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4967](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4967) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_NewAddrCount.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_NewAddrCount.md deleted file mode 100644 index 013fc99b4..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_NewAddrCount.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_NewAddrCount - -# Interface: MetricsTree\_Distribution\_NewAddrCount - -Defined in: [Developer/brk/modules/brk-client/index.js:4947](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4947) - -## Properties - -### all - -> **all**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4948](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4948) - -*** - -### p2a - -> **p2a**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4956](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4956) - -*** - -### p2pk33 - -> **p2pk33**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4950](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4950) - -*** - -### p2pk65 - -> **p2pk65**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4949](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4949) - -*** - -### p2pkh - -> **p2pkh**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4951](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4951) - -*** - -### p2sh - -> **p2sh**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4952](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4952) - -*** - -### p2tr - -> **p2tr**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4955](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4955) - -*** - -### p2wpkh - -> **p2wpkh**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4953](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4953) - -*** - -### p2wsh - -> **p2wsh**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4954](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4954) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_TotalAddrCount.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_TotalAddrCount.md deleted file mode 100644 index 8098ebceb..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_TotalAddrCount.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_TotalAddrCount - -# Interface: MetricsTree\_Distribution\_TotalAddrCount - -Defined in: [Developer/brk/modules/brk-client/index.js:4934](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4934) - -## Properties - -### all - -> **all**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4935](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4935) - -*** - -### p2a - -> **p2a**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4943](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4943) - -*** - -### p2pk33 - -> **p2pk33**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4937](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4937) - -*** - -### p2pk65 - -> **p2pk65**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4936](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4936) - -*** - -### p2pkh - -> **p2pkh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4938](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4938) - -*** - -### p2sh - -> **p2sh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4939](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4939) - -*** - -### p2tr - -> **p2tr**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4942](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4942) - -*** - -### p2wpkh - -> **p2wpkh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4940](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4940) - -*** - -### p2wsh - -> **p2wsh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4941](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4941) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts.md deleted file mode 100644 index ae0c0cfe0..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts.md +++ /dev/null @@ -1,97 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts - -# Interface: MetricsTree\_Distribution\_UtxoCohorts - -Defined in: [Developer/brk/modules/brk-client/index.js:4621](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4621) - -## Properties - -### ageRange - -> **ageRange**: [`MetricsTree_Distribution_UtxoCohorts_AgeRange`](MetricsTree_Distribution_UtxoCohorts_AgeRange.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4623](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4623) - -*** - -### all - -> **all**: [`MetricsTree_Distribution_UtxoCohorts_All`](MetricsTree_Distribution_UtxoCohorts_All.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4622](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4622) - -*** - -### amountRange - -> **amountRange**: [`MetricsTree_Distribution_UtxoCohorts_AmountRange`](MetricsTree_Distribution_UtxoCohorts_AmountRange.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4628](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4628) - -*** - -### epoch - -> **epoch**: [`MetricsTree_Distribution_UtxoCohorts_Epoch`](MetricsTree_Distribution_UtxoCohorts_Epoch.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4624](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4624) - -*** - -### geAmount - -> **geAmount**: [`MetricsTree_Distribution_UtxoCohorts_GeAmount`](MetricsTree_Distribution_UtxoCohorts_GeAmount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4627](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4627) - -*** - -### ltAmount - -> **ltAmount**: [`MetricsTree_Distribution_UtxoCohorts_LtAmount`](MetricsTree_Distribution_UtxoCohorts_LtAmount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4632](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4632) - -*** - -### maxAge - -> **maxAge**: [`MetricsTree_Distribution_UtxoCohorts_MaxAge`](MetricsTree_Distribution_UtxoCohorts_MaxAge.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4631](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4631) - -*** - -### minAge - -> **minAge**: [`MetricsTree_Distribution_UtxoCohorts_MinAge`](MetricsTree_Distribution_UtxoCohorts_MinAge.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4626](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4626) - -*** - -### term - -> **term**: [`MetricsTree_Distribution_UtxoCohorts_Term`](MetricsTree_Distribution_UtxoCohorts_Term.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4629](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4629) - -*** - -### type - -> **type**: [`MetricsTree_Distribution_UtxoCohorts_Type`](MetricsTree_Distribution_UtxoCohorts_Type.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4630](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4630) - -*** - -### year - -> **year**: [`MetricsTree_Distribution_UtxoCohorts_Year`](MetricsTree_Distribution_UtxoCohorts_Year.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4625](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4625) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AgeRange.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AgeRange.md deleted file mode 100644 index f0673a8b3..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AgeRange.md +++ /dev/null @@ -1,177 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_AgeRange - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_AgeRange - -Defined in: [Developer/brk/modules/brk-client/index.js:4665](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4665) - -## Properties - -### \_10yTo12y - -> **\_10yTo12y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4684](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4684) - -*** - -### \_12yTo15y - -> **\_12yTo15y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4685](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4685) - -*** - -### \_1dTo1w - -> **\_1dTo1w**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4668](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4668) - -*** - -### \_1hTo1d - -> **\_1hTo1d**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4667](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4667) - -*** - -### \_1mTo2m - -> **\_1mTo2m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4670](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4670) - -*** - -### \_1wTo1m - -> **\_1wTo1m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4669](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4669) - -*** - -### \_1yTo2y - -> **\_1yTo2y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4676](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4676) - -*** - -### \_2mTo3m - -> **\_2mTo3m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4671](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4671) - -*** - -### \_2yTo3y - -> **\_2yTo3y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4677](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4677) - -*** - -### \_3mTo4m - -> **\_3mTo4m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4672](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4672) - -*** - -### \_3yTo4y - -> **\_3yTo4y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4678](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4678) - -*** - -### \_4mTo5m - -> **\_4mTo5m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4673](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4673) - -*** - -### \_4yTo5y - -> **\_4yTo5y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4679](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4679) - -*** - -### \_5mTo6m - -> **\_5mTo6m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4674](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4674) - -*** - -### \_5yTo6y - -> **\_5yTo6y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4680](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4680) - -*** - -### \_6mTo1y - -> **\_6mTo1y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4675](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4675) - -*** - -### \_6yTo7y - -> **\_6yTo7y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4681](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4681) - -*** - -### \_7yTo8y - -> **\_7yTo8y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4682](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4682) - -*** - -### \_8yTo10y - -> **\_8yTo10y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4683](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4683) - -*** - -### from15y - -> **from15y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4686](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4686) - -*** - -### upTo1h - -> **upTo1h**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4666](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4666) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All.md deleted file mode 100644 index b2285ab46..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_All - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_All - -Defined in: [Developer/brk/modules/brk-client/index.js:4636](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4636) - -## Properties - -### activity - -> **activity**: [`CoinblocksCoindaysSatblocksSatdaysSentPattern`](CoinblocksCoindaysSatblocksSatdaysSentPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4639](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4639) - -*** - -### costBasis - -> **costBasis**: [`InvestedMaxMinPercentilesSpotPattern`](InvestedMaxMinPercentilesSpotPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4642](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4642) - -*** - -### outputs - -> **outputs**: [`UtxoPattern`](UtxoPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4638](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4638) - -*** - -### realized - -> **realized**: [`AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern`](AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4640](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4640) - -*** - -### relative - -> **relative**: [`MetricsTree_Distribution_UtxoCohorts_All_Relative`](MetricsTree_Distribution_UtxoCohorts_All_Relative.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4643](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4643) - -*** - -### supply - -> **supply**: [`_30dHalvedTotalPattern`](30dHalvedTotalPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4637](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4637) - -*** - -### unrealized - -> **unrealized**: [`GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern`](GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4641](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4641) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All_Relative.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All_Relative.md deleted file mode 100644 index 1945eabf6..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All_Relative.md +++ /dev/null @@ -1,121 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_All\_Relative - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_All\_Relative - -Defined in: [Developer/brk/modules/brk-client/index.js:4647](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4647) - -## Properties - -### investedCapitalInLossPct - -> **investedCapitalInLossPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4660](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4660) - -*** - -### investedCapitalInProfitPct - -> **investedCapitalInProfitPct**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4659](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4659) - -*** - -### negUnrealizedLossRelToMarketCap - -> **negUnrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4652](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4652) - -*** - -### negUnrealizedLossRelToOwnTotalUnrealizedPnl - -> **negUnrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4657](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4657) - -*** - -### netUnrealizedPnlRelToMarketCap - -> **netUnrealizedPnlRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4653](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4653) - -*** - -### netUnrealizedPnlRelToOwnTotalUnrealizedPnl - -> **netUnrealizedPnlRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4658](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4658) - -*** - -### nupl - -> **nupl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4654](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4654) - -*** - -### supplyInLossRelToOwnSupply - -> **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4649](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4649) - -*** - -### supplyInProfitRelToOwnSupply - -> **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4648](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4648) - -*** - -### unrealizedLossRelToMarketCap - -> **unrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4651](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4651) - -*** - -### unrealizedLossRelToOwnTotalUnrealizedPnl - -> **unrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4656](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4656) - -*** - -### unrealizedPeakRegretRelToMarketCap - -> **unrealizedPeakRegretRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4661](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4661) - -*** - -### unrealizedProfitRelToMarketCap - -> **unrealizedProfitRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4650](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4650) - -*** - -### unrealizedProfitRelToOwnTotalUnrealizedPnl - -> **unrealizedProfitRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4655](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4655) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AmountRange.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AmountRange.md deleted file mode 100644 index f0d143cbe..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AmountRange.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_AmountRange - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_AmountRange - -Defined in: [Developer/brk/modules/brk-client/index.js:4760](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4760) - -## Properties - -### \_0sats - -> **\_0sats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4761](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4761) - -*** - -### \_100btcTo1kBtc - -> **\_100btcTo1kBtc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4772](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4772) - -*** - -### \_100kBtcOrMore - -> **\_100kBtcOrMore**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4775](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4775) - -*** - -### \_100kSatsTo1mSats - -> **\_100kSatsTo1mSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4767](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4767) - -*** - -### \_100satsTo1kSats - -> **\_100satsTo1kSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4764](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4764) - -*** - -### \_10btcTo100btc - -> **\_10btcTo100btc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4771](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4771) - -*** - -### \_10kBtcTo100kBtc - -> **\_10kBtcTo100kBtc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4774](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4774) - -*** - -### \_10kSatsTo100kSats - -> **\_10kSatsTo100kSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4766](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4766) - -*** - -### \_10mSatsTo1btc - -> **\_10mSatsTo1btc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4769](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4769) - -*** - -### \_10satsTo100sats - -> **\_10satsTo100sats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4763](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4763) - -*** - -### \_1btcTo10btc - -> **\_1btcTo10btc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4770](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4770) - -*** - -### \_1kBtcTo10kBtc - -> **\_1kBtcTo10kBtc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4773](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4773) - -*** - -### \_1kSatsTo10kSats - -> **\_1kSatsTo10kSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4765](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4765) - -*** - -### \_1mSatsTo10mSats - -> **\_1mSatsTo10mSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4768](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4768) - -*** - -### \_1satTo10sats - -> **\_1satTo10sats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4762](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4762) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Epoch.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Epoch.md deleted file mode 100644 index 925c46de9..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Epoch.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_Epoch - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_Epoch - -Defined in: [Developer/brk/modules/brk-client/index.js:4690](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4690) - -## Properties - -### \_0 - -> **\_0**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4691](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4691) - -*** - -### \_1 - -> **\_1**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4692](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4692) - -*** - -### \_2 - -> **\_2**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4693](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4693) - -*** - -### \_3 - -> **\_3**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4694](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4694) - -*** - -### \_4 - -> **\_4**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4695](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4695) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_GeAmount.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_GeAmount.md deleted file mode 100644 index e2d1f0285..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_GeAmount.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_GeAmount - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_GeAmount - -Defined in: [Developer/brk/modules/brk-client/index.js:4743](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4743) - -## Properties - -### \_100btc - -> **\_100btc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4754](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4754) - -*** - -### \_100kSats - -> **\_100kSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4749](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4749) - -*** - -### \_100sats - -> **\_100sats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4746](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4746) - -*** - -### \_10btc - -> **\_10btc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4753](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4753) - -*** - -### \_10kBtc - -> **\_10kBtc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4756](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4756) - -*** - -### \_10kSats - -> **\_10kSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4748](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4748) - -*** - -### \_10mSats - -> **\_10mSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4751](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4751) - -*** - -### \_10sats - -> **\_10sats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4745](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4745) - -*** - -### \_1btc - -> **\_1btc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4752](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4752) - -*** - -### \_1kBtc - -> **\_1kBtc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4755](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4755) - -*** - -### \_1kSats - -> **\_1kSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4747](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4747) - -*** - -### \_1mSats - -> **\_1mSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4750](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4750) - -*** - -### \_1sat - -> **\_1sat**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4744](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4744) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_LtAmount.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_LtAmount.md deleted file mode 100644 index a9cc484e3..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_LtAmount.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_LtAmount - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_LtAmount - -Defined in: [Developer/brk/modules/brk-client/index.js:4844](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4844) - -## Properties - -### \_100btc - -> **\_100btc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4854](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4854) - -*** - -### \_100kBtc - -> **\_100kBtc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4857](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4857) - -*** - -### \_100kSats - -> **\_100kSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4849](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4849) - -*** - -### \_100sats - -> **\_100sats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4846](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4846) - -*** - -### \_10btc - -> **\_10btc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4853](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4853) - -*** - -### \_10kBtc - -> **\_10kBtc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4856](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4856) - -*** - -### \_10kSats - -> **\_10kSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4848](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4848) - -*** - -### \_10mSats - -> **\_10mSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4851](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4851) - -*** - -### \_10sats - -> **\_10sats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4845](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4845) - -*** - -### \_1btc - -> **\_1btc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4852](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4852) - -*** - -### \_1kBtc - -> **\_1kBtc**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4855](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4855) - -*** - -### \_1kSats - -> **\_1kSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4847](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4847) - -*** - -### \_1mSats - -> **\_1mSats**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4850](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4850) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MaxAge.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MaxAge.md deleted file mode 100644 index 7164c68e7..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MaxAge.md +++ /dev/null @@ -1,153 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_MaxAge - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_MaxAge - -Defined in: [Developer/brk/modules/brk-client/index.js:4822](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4822) - -## Properties - -### \_10y - -> **\_10y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4838](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4838) - -*** - -### \_12y - -> **\_12y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4839](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4839) - -*** - -### \_15y - -> **\_15y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4840](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4840) - -*** - -### \_1m - -> **\_1m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4824](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4824) - -*** - -### \_1w - -> **\_1w**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4823](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4823) - -*** - -### \_1y - -> **\_1y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4830](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4830) - -*** - -### \_2m - -> **\_2m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4825](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4825) - -*** - -### \_2y - -> **\_2y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4831](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4831) - -*** - -### \_3m - -> **\_3m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4826](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4826) - -*** - -### \_3y - -> **\_3y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4832](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4832) - -*** - -### \_4m - -> **\_4m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4827](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4827) - -*** - -### \_4y - -> **\_4y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4833](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4833) - -*** - -### \_5m - -> **\_5m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4828](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4828) - -*** - -### \_5y - -> **\_5y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4834](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4834) - -*** - -### \_6m - -> **\_6m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4829](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4829) - -*** - -### \_6y - -> **\_6y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4835](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4835) - -*** - -### \_7y - -> **\_7y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4836](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4836) - -*** - -### \_8y - -> **\_8y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4837](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4837) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MinAge.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MinAge.md deleted file mode 100644 index 2dff55ead..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MinAge.md +++ /dev/null @@ -1,153 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_MinAge - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_MinAge - -Defined in: [Developer/brk/modules/brk-client/index.js:4721](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4721) - -## Properties - -### \_10y - -> **\_10y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4738](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4738) - -*** - -### \_12y - -> **\_12y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4739](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4739) - -*** - -### \_1d - -> **\_1d**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4722](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4722) - -*** - -### \_1m - -> **\_1m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4724](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4724) - -*** - -### \_1w - -> **\_1w**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4723](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4723) - -*** - -### \_1y - -> **\_1y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4730](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4730) - -*** - -### \_2m - -> **\_2m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4725](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4725) - -*** - -### \_2y - -> **\_2y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4731](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4731) - -*** - -### \_3m - -> **\_3m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4726](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4726) - -*** - -### \_3y - -> **\_3y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4732](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4732) - -*** - -### \_4m - -> **\_4m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4727](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4727) - -*** - -### \_4y - -> **\_4y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4733](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4733) - -*** - -### \_5m - -> **\_5m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4728](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4728) - -*** - -### \_5y - -> **\_5y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4734](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4734) - -*** - -### \_6m - -> **\_6m**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4729](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4729) - -*** - -### \_6y - -> **\_6y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4735](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4735) - -*** - -### \_7y - -> **\_7y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4736](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4736) - -*** - -### \_8y - -> **\_8y**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern6.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4737](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4737) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term.md deleted file mode 100644 index d76af16eb..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_Term - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_Term - -Defined in: [Developer/brk/modules/brk-client/index.js:4779](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4779) - -## Properties - -### long - -> **long**: [`MetricsTree_Distribution_UtxoCohorts_Term_Long`](MetricsTree_Distribution_UtxoCohorts_Term_Long.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4781](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4781) - -*** - -### short - -> **short**: [`MetricsTree_Distribution_UtxoCohorts_Term_Short`](MetricsTree_Distribution_UtxoCohorts_Term_Short.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4780](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4780) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term_Long.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term_Long.md deleted file mode 100644 index adc3e3122..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term_Long.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_Term\_Long - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_Term\_Long - -Defined in: [Developer/brk/modules/brk-client/index.js:4796](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4796) - -## Properties - -### activity - -> **activity**: [`CoinblocksCoindaysSatblocksSatdaysSentPattern`](CoinblocksCoindaysSatblocksSatdaysSentPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4799](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4799) - -*** - -### costBasis - -> **costBasis**: [`InvestedMaxMinPercentilesSpotPattern`](InvestedMaxMinPercentilesSpotPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4802](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4802) - -*** - -### outputs - -> **outputs**: [`UtxoPattern`](UtxoPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4798](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4798) - -*** - -### realized - -> **realized**: [`CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2`](CapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4800](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4800) - -*** - -### relative - -> **relative**: [`InvestedNegNetNuplSupplyUnrealizedPattern4`](InvestedNegNetNuplSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4803](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4803) - -*** - -### supply - -> **supply**: [`_30dHalvedTotalPattern`](30dHalvedTotalPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4797](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4797) - -*** - -### unrealized - -> **unrealized**: [`GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern`](GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4801](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4801) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term_Short.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term_Short.md deleted file mode 100644 index 6d969eb51..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term_Short.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_Term\_Short - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_Term\_Short - -Defined in: [Developer/brk/modules/brk-client/index.js:4785](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4785) - -## Properties - -### activity - -> **activity**: [`CoinblocksCoindaysSatblocksSatdaysSentPattern`](CoinblocksCoindaysSatblocksSatdaysSentPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4788](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4788) - -*** - -### costBasis - -> **costBasis**: [`InvestedMaxMinPercentilesSpotPattern`](InvestedMaxMinPercentilesSpotPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4791](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4791) - -*** - -### outputs - -> **outputs**: [`UtxoPattern`](UtxoPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4787](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4787) - -*** - -### realized - -> **realized**: [`AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern`](AdjustedCapCapitulationInvestorLossLowerMvrvNegNetPeakProfitRealizedSellSentSoprTotalUpperValuePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4789](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4789) - -*** - -### relative - -> **relative**: [`InvestedNegNetNuplSupplyUnrealizedPattern4`](InvestedNegNetNuplSupplyUnrealizedPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4792](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4792) - -*** - -### supply - -> **supply**: [`_30dHalvedTotalPattern`](30dHalvedTotalPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4786](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4786) - -*** - -### unrealized - -> **unrealized**: [`GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern`](GreedInvestedInvestorNegNetPainPeakSupplyTotalUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4790](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4790) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Type.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Type.md deleted file mode 100644 index 39d4c49de..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Type.md +++ /dev/null @@ -1,97 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_Type - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_Type - -Defined in: [Developer/brk/modules/brk-client/index.js:4807](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4807) - -## Properties - -### empty - -> **empty**: [`ActivityCostOutputsRealizedSupplyUnrealizedPattern`](ActivityCostOutputsRealizedSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4818](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4818) - -*** - -### p2a - -> **p2a**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4816](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4816) - -*** - -### p2ms - -> **p2ms**: [`ActivityCostOutputsRealizedSupplyUnrealizedPattern`](ActivityCostOutputsRealizedSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4811](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4811) - -*** - -### p2pk33 - -> **p2pk33**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4809](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4809) - -*** - -### p2pk65 - -> **p2pk65**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4808](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4808) - -*** - -### p2pkh - -> **p2pkh**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4810](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4810) - -*** - -### p2sh - -> **p2sh**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4812](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4812) - -*** - -### p2tr - -> **p2tr**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4815](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4815) - -*** - -### p2wpkh - -> **p2wpkh**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4813](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4813) - -*** - -### p2wsh - -> **p2wsh**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4814](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4814) - -*** - -### unknown - -> **unknown**: [`ActivityCostOutputsRealizedSupplyUnrealizedPattern`](ActivityCostOutputsRealizedSupplyUnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4817](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4817) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Year.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Year.md deleted file mode 100644 index a628d7610..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Year.md +++ /dev/null @@ -1,153 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_Year - -# Interface: MetricsTree\_Distribution\_UtxoCohorts\_Year - -Defined in: [Developer/brk/modules/brk-client/index.js:4699](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4699) - -## Properties - -### \_2009 - -> **\_2009**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4700](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4700) - -*** - -### \_2010 - -> **\_2010**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4701](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4701) - -*** - -### \_2011 - -> **\_2011**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4702](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4702) - -*** - -### \_2012 - -> **\_2012**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4703](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4703) - -*** - -### \_2013 - -> **\_2013**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4704](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4704) - -*** - -### \_2014 - -> **\_2014**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4705](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4705) - -*** - -### \_2015 - -> **\_2015**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4706](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4706) - -*** - -### \_2016 - -> **\_2016**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4707](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4707) - -*** - -### \_2017 - -> **\_2017**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4708](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4708) - -*** - -### \_2018 - -> **\_2018**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4709](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4709) - -*** - -### \_2019 - -> **\_2019**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4710](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4710) - -*** - -### \_2020 - -> **\_2020**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4711](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4711) - -*** - -### \_2021 - -> **\_2021**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4712](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4712) - -*** - -### \_2022 - -> **\_2022**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4713](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4713) - -*** - -### \_2023 - -> **\_2023**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4714](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4714) - -*** - -### \_2024 - -> **\_2024**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4715](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4715) - -*** - -### \_2025 - -> **\_2025**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4716](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4716) - -*** - -### \_2026 - -> **\_2026**: [`ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3`](ActivityCostOutputsRealizedRelativeSupplyUnrealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4717](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4717) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes.md deleted file mode 100644 index 373616b79..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes.md +++ /dev/null @@ -1,121 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes - -# Interface: MetricsTree\_Indexes - -Defined in: [Developer/brk/modules/brk-client/index.js:3890](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3890) - -## Properties - -### address - -> **address**: [`MetricsTree_Indexes_Address`](MetricsTree_Indexes_Address.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3891](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3891) - -*** - -### dateindex - -> **dateindex**: [`MetricsTree_Indexes_Dateindex`](MetricsTree_Indexes_Dateindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3895](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3895) - -*** - -### decadeindex - -> **decadeindex**: [`MetricsTree_Indexes_Decadeindex`](MetricsTree_Indexes_Decadeindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3901](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3901) - -*** - -### difficultyepoch - -> **difficultyepoch**: [`MetricsTree_Indexes_Difficultyepoch`](MetricsTree_Indexes_Difficultyepoch.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3893](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3893) - -*** - -### halvingepoch - -> **halvingepoch**: [`MetricsTree_Indexes_Halvingepoch`](MetricsTree_Indexes_Halvingepoch.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3894](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3894) - -*** - -### height - -> **height**: [`MetricsTree_Indexes_Height`](MetricsTree_Indexes_Height.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3892](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3892) - -*** - -### monthindex - -> **monthindex**: [`MetricsTree_Indexes_Monthindex`](MetricsTree_Indexes_Monthindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3897](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3897) - -*** - -### quarterindex - -> **quarterindex**: [`MetricsTree_Indexes_Quarterindex`](MetricsTree_Indexes_Quarterindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3898](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3898) - -*** - -### semesterindex - -> **semesterindex**: [`MetricsTree_Indexes_Semesterindex`](MetricsTree_Indexes_Semesterindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3899](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3899) - -*** - -### txindex - -> **txindex**: [`MetricsTree_Indexes_Txindex`](MetricsTree_Indexes_Txindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3902](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3902) - -*** - -### txinindex - -> **txinindex**: [`MetricsTree_Indexes_Txinindex`](MetricsTree_Indexes_Txinindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3903](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3903) - -*** - -### txoutindex - -> **txoutindex**: [`MetricsTree_Indexes_Txoutindex`](MetricsTree_Indexes_Txoutindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3904](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3904) - -*** - -### weekindex - -> **weekindex**: [`MetricsTree_Indexes_Weekindex`](MetricsTree_Indexes_Weekindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3896](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3896) - -*** - -### yearindex - -> **yearindex**: [`MetricsTree_Indexes_Yearindex`](MetricsTree_Indexes_Yearindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3900](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3900) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address.md deleted file mode 100644 index 4751faa95..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address - -# Interface: MetricsTree\_Indexes\_Address - -Defined in: [Developer/brk/modules/brk-client/index.js:3908](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3908) - -## Properties - -### empty - -> **empty**: [`MetricsTree_Indexes_Address_Empty`](MetricsTree_Indexes_Address_Empty.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3918](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3918) - -*** - -### opreturn - -> **opreturn**: [`MetricsTree_Indexes_Address_Opreturn`](MetricsTree_Indexes_Address_Opreturn.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3920](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3920) - -*** - -### p2a - -> **p2a**: [`MetricsTree_Indexes_Address_P2a`](MetricsTree_Indexes_Address_P2a.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3916](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3916) - -*** - -### p2ms - -> **p2ms**: [`MetricsTree_Indexes_Address_P2ms`](MetricsTree_Indexes_Address_P2ms.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3917](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3917) - -*** - -### p2pk33 - -> **p2pk33**: [`MetricsTree_Indexes_Address_P2pk33`](MetricsTree_Indexes_Address_P2pk33.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3909](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3909) - -*** - -### p2pk65 - -> **p2pk65**: [`MetricsTree_Indexes_Address_P2pk65`](MetricsTree_Indexes_Address_P2pk65.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3910](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3910) - -*** - -### p2pkh - -> **p2pkh**: [`MetricsTree_Indexes_Address_P2pkh`](MetricsTree_Indexes_Address_P2pkh.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3911](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3911) - -*** - -### p2sh - -> **p2sh**: [`MetricsTree_Indexes_Address_P2sh`](MetricsTree_Indexes_Address_P2sh.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3912](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3912) - -*** - -### p2tr - -> **p2tr**: [`MetricsTree_Indexes_Address_P2tr`](MetricsTree_Indexes_Address_P2tr.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3913](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3913) - -*** - -### p2wpkh - -> **p2wpkh**: [`MetricsTree_Indexes_Address_P2wpkh`](MetricsTree_Indexes_Address_P2wpkh.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3914](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3914) - -*** - -### p2wsh - -> **p2wsh**: [`MetricsTree_Indexes_Address_P2wsh`](MetricsTree_Indexes_Address_P2wsh.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3915](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3915) - -*** - -### unknown - -> **unknown**: [`MetricsTree_Indexes_Address_Unknown`](MetricsTree_Indexes_Address_Unknown.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3919](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3919) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Empty.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Empty.md deleted file mode 100644 index adf152fbc..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Empty.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_Empty - -# Interface: MetricsTree\_Indexes\_Address\_Empty - -Defined in: [Developer/brk/modules/brk-client/index.js:3969](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3969) - -## Properties - -### identity - -> **identity**: [`MetricPattern9`](../type-aliases/MetricPattern9.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3970](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3970) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Opreturn.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Opreturn.md deleted file mode 100644 index 3bdf885eb..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Opreturn.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_Opreturn - -# Interface: MetricsTree\_Indexes\_Address\_Opreturn - -Defined in: [Developer/brk/modules/brk-client/index.js:3979](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3979) - -## Properties - -### identity - -> **identity**: [`MetricPattern14`](../type-aliases/MetricPattern14.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3980](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3980) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2a.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2a.md deleted file mode 100644 index 44b148be5..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2a.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_P2a - -# Interface: MetricsTree\_Indexes\_Address\_P2a - -Defined in: [Developer/brk/modules/brk-client/index.js:3959](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3959) - -## Properties - -### identity - -> **identity**: [`MetricPattern16`](../type-aliases/MetricPattern16.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3960](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3960) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2ms.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2ms.md deleted file mode 100644 index cf91a9c81..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2ms.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_P2ms - -# Interface: MetricsTree\_Indexes\_Address\_P2ms - -Defined in: [Developer/brk/modules/brk-client/index.js:3964](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3964) - -## Properties - -### identity - -> **identity**: [`MetricPattern17`](../type-aliases/MetricPattern17.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3965](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3965) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk33.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk33.md deleted file mode 100644 index 07b8bc803..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk33.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_P2pk33 - -# Interface: MetricsTree\_Indexes\_Address\_P2pk33 - -Defined in: [Developer/brk/modules/brk-client/index.js:3924](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3924) - -## Properties - -### identity - -> **identity**: [`MetricPattern18`](../type-aliases/MetricPattern18.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3925](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3925) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk65.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk65.md deleted file mode 100644 index 54e82f5ea..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk65.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_P2pk65 - -# Interface: MetricsTree\_Indexes\_Address\_P2pk65 - -Defined in: [Developer/brk/modules/brk-client/index.js:3929](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3929) - -## Properties - -### identity - -> **identity**: [`MetricPattern19`](../type-aliases/MetricPattern19.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3930](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3930) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pkh.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pkh.md deleted file mode 100644 index 0abbe8e61..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pkh.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_P2pkh - -# Interface: MetricsTree\_Indexes\_Address\_P2pkh - -Defined in: [Developer/brk/modules/brk-client/index.js:3934](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3934) - -## Properties - -### identity - -> **identity**: [`MetricPattern20`](../type-aliases/MetricPattern20.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3935](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3935) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2sh.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2sh.md deleted file mode 100644 index 315110879..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2sh.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_P2sh - -# Interface: MetricsTree\_Indexes\_Address\_P2sh - -Defined in: [Developer/brk/modules/brk-client/index.js:3939](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3939) - -## Properties - -### identity - -> **identity**: [`MetricPattern21`](../type-aliases/MetricPattern21.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3940](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3940) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2tr.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2tr.md deleted file mode 100644 index 67e57bbc9..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2tr.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_P2tr - -# Interface: MetricsTree\_Indexes\_Address\_P2tr - -Defined in: [Developer/brk/modules/brk-client/index.js:3944](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3944) - -## Properties - -### identity - -> **identity**: [`MetricPattern22`](../type-aliases/MetricPattern22.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3945](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3945) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wpkh.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wpkh.md deleted file mode 100644 index 5a62fc4e2..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wpkh.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_P2wpkh - -# Interface: MetricsTree\_Indexes\_Address\_P2wpkh - -Defined in: [Developer/brk/modules/brk-client/index.js:3949](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3949) - -## Properties - -### identity - -> **identity**: [`MetricPattern23`](../type-aliases/MetricPattern23.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3950](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3950) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wsh.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wsh.md deleted file mode 100644 index e437bd2b6..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wsh.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_P2wsh - -# Interface: MetricsTree\_Indexes\_Address\_P2wsh - -Defined in: [Developer/brk/modules/brk-client/index.js:3954](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3954) - -## Properties - -### identity - -> **identity**: [`MetricPattern24`](../type-aliases/MetricPattern24.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3955](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3955) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Unknown.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Unknown.md deleted file mode 100644 index 651e00973..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Unknown.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Address\_Unknown - -# Interface: MetricsTree\_Indexes\_Address\_Unknown - -Defined in: [Developer/brk/modules/brk-client/index.js:3974](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3974) - -## Properties - -### identity - -> **identity**: [`MetricPattern28`](../type-aliases/MetricPattern28.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3975](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3975) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Dateindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Dateindex.md deleted file mode 100644 index d5e73d9bb..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Dateindex.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Dateindex - -# Interface: MetricsTree\_Indexes\_Dateindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4006](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4006) - -## Properties - -### date - -> **date**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4008](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4008) - -*** - -### firstHeight - -> **firstHeight**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4009](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4009) - -*** - -### heightCount - -> **heightCount**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4010](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4010) - -*** - -### identity - -> **identity**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4007](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4007) - -*** - -### monthindex - -> **monthindex**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4012](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4012) - -*** - -### weekindex - -> **weekindex**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4011](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4011) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Decadeindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Decadeindex.md deleted file mode 100644 index 027bb2451..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Decadeindex.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Decadeindex - -# Interface: MetricsTree\_Indexes\_Decadeindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4060](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4060) - -## Properties - -### date - -> **date**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4062](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4062) - -*** - -### firstYearindex - -> **firstYearindex**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4063](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4063) - -*** - -### identity - -> **identity**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4061](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4061) - -*** - -### yearindexCount - -> **yearindexCount**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4064](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4064) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Difficultyepoch.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Difficultyepoch.md deleted file mode 100644 index 5de078695..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Difficultyepoch.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Difficultyepoch - -# Interface: MetricsTree\_Indexes\_Difficultyepoch - -Defined in: [Developer/brk/modules/brk-client/index.js:3993](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3993) - -## Properties - -### firstHeight - -> **firstHeight**: [`MetricPattern8`](../type-aliases/MetricPattern8.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3995](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3995) - -*** - -### heightCount - -> **heightCount**: [`MetricPattern8`](../type-aliases/MetricPattern8.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3996](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3996) - -*** - -### identity - -> **identity**: [`MetricPattern8`](../type-aliases/MetricPattern8.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3994](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3994) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Halvingepoch.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Halvingepoch.md deleted file mode 100644 index d818edbec..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Halvingepoch.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Halvingepoch - -# Interface: MetricsTree\_Indexes\_Halvingepoch - -Defined in: [Developer/brk/modules/brk-client/index.js:4000](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4000) - -## Properties - -### firstHeight - -> **firstHeight**: [`MetricPattern10`](../type-aliases/MetricPattern10.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4002](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4002) - -*** - -### identity - -> **identity**: [`MetricPattern10`](../type-aliases/MetricPattern10.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4001](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4001) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Height.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Height.md deleted file mode 100644 index 608b16626..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Height.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Height - -# Interface: MetricsTree\_Indexes\_Height - -Defined in: [Developer/brk/modules/brk-client/index.js:3984](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3984) - -## Properties - -### dateindex - -> **dateindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3986](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3986) - -*** - -### difficultyepoch - -> **difficultyepoch**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3987](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3987) - -*** - -### halvingepoch - -> **halvingepoch**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3988](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3988) - -*** - -### identity - -> **identity**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3985](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3985) - -*** - -### txindexCount - -> **txindexCount**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3989](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3989) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Monthindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Monthindex.md deleted file mode 100644 index b17c4c6f7..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Monthindex.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Monthindex - -# Interface: MetricsTree\_Indexes\_Monthindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4024](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4024) - -## Properties - -### date - -> **date**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4026](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4026) - -*** - -### dateindexCount - -> **dateindexCount**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4028](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4028) - -*** - -### firstDateindex - -> **firstDateindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4027](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4027) - -*** - -### identity - -> **identity**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4025](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4025) - -*** - -### quarterindex - -> **quarterindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4029](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4029) - -*** - -### semesterindex - -> **semesterindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4030](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4030) - -*** - -### yearindex - -> **yearindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4031](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4031) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Quarterindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Quarterindex.md deleted file mode 100644 index 6819f79f6..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Quarterindex.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Quarterindex - -# Interface: MetricsTree\_Indexes\_Quarterindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4035](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4035) - -## Properties - -### date - -> **date**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4037](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4037) - -*** - -### firstMonthindex - -> **firstMonthindex**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4038](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4038) - -*** - -### identity - -> **identity**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4036](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4036) - -*** - -### monthindexCount - -> **monthindexCount**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4039](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4039) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Semesterindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Semesterindex.md deleted file mode 100644 index 5a018e45c..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Semesterindex.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Semesterindex - -# Interface: MetricsTree\_Indexes\_Semesterindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4043](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4043) - -## Properties - -### date - -> **date**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4045](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4045) - -*** - -### firstMonthindex - -> **firstMonthindex**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4046](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4046) - -*** - -### identity - -> **identity**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4044](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4044) - -*** - -### monthindexCount - -> **monthindexCount**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4047](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4047) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txindex.md deleted file mode 100644 index a42be3eab..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txindex.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Txindex - -# Interface: MetricsTree\_Indexes\_Txindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4068](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4068) - -## Properties - -### identity - -> **identity**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4069](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4069) - -*** - -### inputCount - -> **inputCount**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4070](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4070) - -*** - -### outputCount - -> **outputCount**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4071](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4071) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txinindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txinindex.md deleted file mode 100644 index 186b14b1a..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txinindex.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Txinindex - -# Interface: MetricsTree\_Indexes\_Txinindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4075](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4075) - -## Properties - -### identity - -> **identity**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4076](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4076) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txoutindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txoutindex.md deleted file mode 100644 index b4831f1ee..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txoutindex.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Txoutindex - -# Interface: MetricsTree\_Indexes\_Txoutindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4080](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4080) - -## Properties - -### identity - -> **identity**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4081](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4081) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Weekindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Weekindex.md deleted file mode 100644 index 8c71e2077..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Weekindex.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Weekindex - -# Interface: MetricsTree\_Indexes\_Weekindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4016](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4016) - -## Properties - -### date - -> **date**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4018](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4018) - -*** - -### dateindexCount - -> **dateindexCount**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4020](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4020) - -*** - -### firstDateindex - -> **firstDateindex**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4019](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4019) - -*** - -### identity - -> **identity**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4017](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4017) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Yearindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Yearindex.md deleted file mode 100644 index 5cf3df0ef..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Yearindex.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Indexes\_Yearindex - -# Interface: MetricsTree\_Indexes\_Yearindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4051](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4051) - -## Properties - -### date - -> **date**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4053](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4053) - -*** - -### decadeindex - -> **decadeindex**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4056](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4056) - -*** - -### firstMonthindex - -> **firstMonthindex**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4054](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4054) - -*** - -### identity - -> **identity**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4052](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4052) - -*** - -### monthindexCount - -> **monthindexCount**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4055](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4055) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Inputs.md b/modules/brk-client/docs/interfaces/MetricsTree_Inputs.md deleted file mode 100644 index cda4697e6..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Inputs.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Inputs - -# Interface: MetricsTree\_Inputs - -Defined in: [Developer/brk/modules/brk-client/index.js:3696](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3696) - -## Properties - -### count - -> **count**: [`AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3703](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3703) - -*** - -### firstTxinindex - -> **firstTxinindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3697](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3697) - -*** - -### outpoint - -> **outpoint**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3698](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3698) - -*** - -### outputtype - -> **outputtype**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<[`OutputType`](../type-aliases/OutputType.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3700](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3700) - -*** - -### spent - -> **spent**: [`MetricsTree_Inputs_Spent`](MetricsTree_Inputs_Spent.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3702](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3702) - -*** - -### txindex - -> **txindex**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3699](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3699) - -*** - -### typeindex - -> **typeindex**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3701](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3701) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Inputs_Spent.md b/modules/brk-client/docs/interfaces/MetricsTree_Inputs_Spent.md deleted file mode 100644 index 60f8cbc61..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Inputs_Spent.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Inputs\_Spent - -# Interface: MetricsTree\_Inputs\_Spent - -Defined in: [Developer/brk/modules/brk-client/index.js:3707](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3707) - -## Properties - -### txoutindex - -> **txoutindex**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3708](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3708) - -*** - -### value - -> **value**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3709](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3709) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market.md b/modules/brk-client/docs/interfaces/MetricsTree_Market.md deleted file mode 100644 index 3a6e57708..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market.md +++ /dev/null @@ -1,73 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market - -# Interface: MetricsTree\_Market - -Defined in: [Developer/brk/modules/brk-client/index.js:4085](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4085) - -## Properties - -### ath - -> **ath**: [`MetricsTree_Market_Ath`](MetricsTree_Market_Ath.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4086](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4086) - -*** - -### dca - -> **dca**: [`MetricsTree_Market_Dca`](MetricsTree_Market_Dca.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4092](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4092) - -*** - -### indicators - -> **indicators**: [`MetricsTree_Market_Indicators`](MetricsTree_Market_Indicators.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4093](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4093) - -*** - -### lookback - -> **lookback**: [`MetricsTree_Market_Lookback`](MetricsTree_Market_Lookback.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4087](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4087) - -*** - -### movingAverage - -> **movingAverage**: [`MetricsTree_Market_MovingAverage`](MetricsTree_Market_MovingAverage.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4091](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4091) - -*** - -### range - -> **range**: [`MetricsTree_Market_Range`](MetricsTree_Market_Range.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4090](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4090) - -*** - -### returns - -> **returns**: [`MetricsTree_Market_Returns`](MetricsTree_Market_Returns.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4088](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4088) - -*** - -### volatility - -> **volatility**: [`MetricsTree_Market_Volatility`](MetricsTree_Market_Volatility.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4089](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4089) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Ath.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Ath.md deleted file mode 100644 index bb9f8c027..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Ath.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Ath - -# Interface: MetricsTree\_Market\_Ath - -Defined in: [Developer/brk/modules/brk-client/index.js:4097](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4097) - -## Properties - -### daysSincePriceAth - -> **daysSincePriceAth**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4100](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4100) - -*** - -### maxDaysBetweenPriceAths - -> **maxDaysBetweenPriceAths**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4102](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4102) - -*** - -### maxYearsBetweenPriceAths - -> **maxYearsBetweenPriceAths**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4103](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4103) - -*** - -### priceAth - -> **priceAth**: [`DollarsSatsPattern`](DollarsSatsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4098](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4098) - -*** - -### priceDrawdown - -> **priceDrawdown**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4099](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4099) - -*** - -### yearsSincePriceAth - -> **yearsSincePriceAth**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4101](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4101) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca.md deleted file mode 100644 index 9fbc79e61..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca.md +++ /dev/null @@ -1,177 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Dca - -# Interface: MetricsTree\_Market\_Dca - -Defined in: [Developer/brk/modules/brk-client/index.js:4221](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4221) - -## Properties - -### classAveragePrice - -> **classAveragePrice**: [`MetricsTree_Market_Dca_ClassAveragePrice`](MetricsTree_Market_Dca_ClassAveragePrice.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4237](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4237) - -*** - -### classDaysInLoss - -> **classDaysInLoss**: [`MetricsTree_Market_Dca_ClassDaysInLoss`](MetricsTree_Market_Dca_ClassDaysInLoss.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4240](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4240) - -*** - -### classDaysInProfit - -> **classDaysInProfit**: [`MetricsTree_Market_Dca_ClassDaysInProfit`](MetricsTree_Market_Dca_ClassDaysInProfit.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4239](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4239) - -*** - -### classMaxReturn - -> **classMaxReturn**: [`MetricsTree_Market_Dca_ClassMaxReturn`](MetricsTree_Market_Dca_ClassMaxReturn.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4242](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4242) - -*** - -### classMinReturn - -> **classMinReturn**: [`MetricsTree_Market_Dca_ClassMinReturn`](MetricsTree_Market_Dca_ClassMinReturn.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4241](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4241) - -*** - -### classReturns - -> **classReturns**: [`_201520162017201820192020202120222023202420252026Pattern2`](201520162017201820192020202120222023202420252026Pattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4238](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4238) - -*** - -### classStack - -> **classStack**: [`MetricsTree_Market_Dca_ClassStack`](MetricsTree_Market_Dca_ClassStack.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4236](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4236) - -*** - -### periodAveragePrice - -> **periodAveragePrice**: [`MetricsTree_Market_Dca_PeriodAveragePrice`](MetricsTree_Market_Dca_PeriodAveragePrice.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4223](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4223) - -*** - -### periodCagr - -> **periodCagr**: [`_10y2y3y4y5y6y8yPattern`](10y2y3y4y5y6y8yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4225](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4225) - -*** - -### periodDaysInLoss - -> **periodDaysInLoss**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4227](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4227) - -*** - -### periodDaysInProfit - -> **periodDaysInProfit**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4226](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4226) - -*** - -### periodLumpSumDaysInLoss - -> **periodLumpSumDaysInLoss**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4233](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4233) - -*** - -### periodLumpSumDaysInProfit - -> **periodLumpSumDaysInProfit**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4232](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4232) - -*** - -### periodLumpSumMaxReturn - -> **periodLumpSumMaxReturn**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4235](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4235) - -*** - -### periodLumpSumMinReturn - -> **periodLumpSumMinReturn**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4234](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4234) - -*** - -### periodLumpSumReturns - -> **periodLumpSumReturns**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4231](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4231) - -*** - -### periodLumpSumStack - -> **periodLumpSumStack**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern3`](10y1m1w1y2y3m3y4y5y6m6y8yPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4230](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4230) - -*** - -### periodMaxReturn - -> **periodMaxReturn**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4229](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4229) - -*** - -### periodMinReturn - -> **periodMinReturn**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4228](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4228) - -*** - -### periodReturns - -> **periodReturns**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4224](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4224) - -*** - -### periodStack - -> **periodStack**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern3`](10y1m1w1y2y3m3y4y5y6m6y8yPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4222](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4222) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassAveragePrice.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassAveragePrice.md deleted file mode 100644 index 72b6fbc50..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassAveragePrice.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Dca\_ClassAveragePrice - -# Interface: MetricsTree\_Market\_Dca\_ClassAveragePrice - -Defined in: [Developer/brk/modules/brk-client/index.js:4278](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4278) - -## Properties - -### \_2015 - -> **\_2015**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4279](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4279) - -*** - -### \_2016 - -> **\_2016**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4280](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4280) - -*** - -### \_2017 - -> **\_2017**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4281](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4281) - -*** - -### \_2018 - -> **\_2018**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4282](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4282) - -*** - -### \_2019 - -> **\_2019**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4283](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4283) - -*** - -### \_2020 - -> **\_2020**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4284](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4284) - -*** - -### \_2021 - -> **\_2021**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4285](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4285) - -*** - -### \_2022 - -> **\_2022**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4286](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4286) - -*** - -### \_2023 - -> **\_2023**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4287](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4287) - -*** - -### \_2024 - -> **\_2024**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4288](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4288) - -*** - -### \_2025 - -> **\_2025**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4289](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4289) - -*** - -### \_2026 - -> **\_2026**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4290](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4290) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassDaysInLoss.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassDaysInLoss.md deleted file mode 100644 index 895432486..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassDaysInLoss.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Dca\_ClassDaysInLoss - -# Interface: MetricsTree\_Market\_Dca\_ClassDaysInLoss - -Defined in: [Developer/brk/modules/brk-client/index.js:4310](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4310) - -## Properties - -### \_2015 - -> **\_2015**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4311](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4311) - -*** - -### \_2016 - -> **\_2016**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4312](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4312) - -*** - -### \_2017 - -> **\_2017**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4313](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4313) - -*** - -### \_2018 - -> **\_2018**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4314](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4314) - -*** - -### \_2019 - -> **\_2019**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4315](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4315) - -*** - -### \_2020 - -> **\_2020**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4316](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4316) - -*** - -### \_2021 - -> **\_2021**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4317](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4317) - -*** - -### \_2022 - -> **\_2022**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4318](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4318) - -*** - -### \_2023 - -> **\_2023**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4319](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4319) - -*** - -### \_2024 - -> **\_2024**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4320](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4320) - -*** - -### \_2025 - -> **\_2025**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4321](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4321) - -*** - -### \_2026 - -> **\_2026**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4322](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4322) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassDaysInProfit.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassDaysInProfit.md deleted file mode 100644 index 10633c61f..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassDaysInProfit.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Dca\_ClassDaysInProfit - -# Interface: MetricsTree\_Market\_Dca\_ClassDaysInProfit - -Defined in: [Developer/brk/modules/brk-client/index.js:4294](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4294) - -## Properties - -### \_2015 - -> **\_2015**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4295](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4295) - -*** - -### \_2016 - -> **\_2016**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4296](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4296) - -*** - -### \_2017 - -> **\_2017**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4297](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4297) - -*** - -### \_2018 - -> **\_2018**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4298](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4298) - -*** - -### \_2019 - -> **\_2019**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4299](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4299) - -*** - -### \_2020 - -> **\_2020**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4300](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4300) - -*** - -### \_2021 - -> **\_2021**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4301](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4301) - -*** - -### \_2022 - -> **\_2022**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4302](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4302) - -*** - -### \_2023 - -> **\_2023**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4303](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4303) - -*** - -### \_2024 - -> **\_2024**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4304](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4304) - -*** - -### \_2025 - -> **\_2025**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4305](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4305) - -*** - -### \_2026 - -> **\_2026**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4306](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4306) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassMaxReturn.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassMaxReturn.md deleted file mode 100644 index e51692897..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassMaxReturn.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Dca\_ClassMaxReturn - -# Interface: MetricsTree\_Market\_Dca\_ClassMaxReturn - -Defined in: [Developer/brk/modules/brk-client/index.js:4342](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4342) - -## Properties - -### \_2015 - -> **\_2015**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4343](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4343) - -*** - -### \_2016 - -> **\_2016**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4344](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4344) - -*** - -### \_2017 - -> **\_2017**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4345](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4345) - -*** - -### \_2018 - -> **\_2018**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4346](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4346) - -*** - -### \_2019 - -> **\_2019**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4347](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4347) - -*** - -### \_2020 - -> **\_2020**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4348](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4348) - -*** - -### \_2021 - -> **\_2021**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4349](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4349) - -*** - -### \_2022 - -> **\_2022**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4350](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4350) - -*** - -### \_2023 - -> **\_2023**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4351](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4351) - -*** - -### \_2024 - -> **\_2024**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4352](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4352) - -*** - -### \_2025 - -> **\_2025**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4353](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4353) - -*** - -### \_2026 - -> **\_2026**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4354](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4354) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassMinReturn.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassMinReturn.md deleted file mode 100644 index b47cf70aa..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassMinReturn.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Dca\_ClassMinReturn - -# Interface: MetricsTree\_Market\_Dca\_ClassMinReturn - -Defined in: [Developer/brk/modules/brk-client/index.js:4326](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4326) - -## Properties - -### \_2015 - -> **\_2015**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4327](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4327) - -*** - -### \_2016 - -> **\_2016**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4328](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4328) - -*** - -### \_2017 - -> **\_2017**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4329](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4329) - -*** - -### \_2018 - -> **\_2018**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4330](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4330) - -*** - -### \_2019 - -> **\_2019**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4331](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4331) - -*** - -### \_2020 - -> **\_2020**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4332](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4332) - -*** - -### \_2021 - -> **\_2021**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4333](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4333) - -*** - -### \_2022 - -> **\_2022**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4334](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4334) - -*** - -### \_2023 - -> **\_2023**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4335](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4335) - -*** - -### \_2024 - -> **\_2024**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4336](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4336) - -*** - -### \_2025 - -> **\_2025**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4337](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4337) - -*** - -### \_2026 - -> **\_2026**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4338](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4338) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassStack.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassStack.md deleted file mode 100644 index fdf633817..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassStack.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Dca\_ClassStack - -# Interface: MetricsTree\_Market\_Dca\_ClassStack - -Defined in: [Developer/brk/modules/brk-client/index.js:4262](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4262) - -## Properties - -### \_2015 - -> **\_2015**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4263](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4263) - -*** - -### \_2016 - -> **\_2016**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4264](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4264) - -*** - -### \_2017 - -> **\_2017**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4265](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4265) - -*** - -### \_2018 - -> **\_2018**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4266](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4266) - -*** - -### \_2019 - -> **\_2019**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4267](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4267) - -*** - -### \_2020 - -> **\_2020**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4268](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4268) - -*** - -### \_2021 - -> **\_2021**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4269](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4269) - -*** - -### \_2022 - -> **\_2022**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4270](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4270) - -*** - -### \_2023 - -> **\_2023**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4271](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4271) - -*** - -### \_2024 - -> **\_2024**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4272](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4272) - -*** - -### \_2025 - -> **\_2025**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4273](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4273) - -*** - -### \_2026 - -> **\_2026**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4274](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4274) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_PeriodAveragePrice.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_PeriodAveragePrice.md deleted file mode 100644 index 6582b5afc..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_PeriodAveragePrice.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Dca\_PeriodAveragePrice - -# Interface: MetricsTree\_Market\_Dca\_PeriodAveragePrice - -Defined in: [Developer/brk/modules/brk-client/index.js:4246](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4246) - -## Properties - -### \_10y - -> **\_10y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4258](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4258) - -*** - -### \_1m - -> **\_1m**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4248](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4248) - -*** - -### \_1w - -> **\_1w**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4247](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4247) - -*** - -### \_1y - -> **\_1y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4251](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4251) - -*** - -### \_2y - -> **\_2y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4252](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4252) - -*** - -### \_3m - -> **\_3m**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4249](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4249) - -*** - -### \_3y - -> **\_3y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4253](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4253) - -*** - -### \_4y - -> **\_4y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4254](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4254) - -*** - -### \_5y - -> **\_5y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4255](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4255) - -*** - -### \_6m - -> **\_6m**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4250](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4250) - -*** - -### \_6y - -> **\_6y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4256](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4256) - -*** - -### \_8y - -> **\_8y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4257](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4257) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Indicators.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Indicators.md deleted file mode 100644 index c78edb74b..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Indicators.md +++ /dev/null @@ -1,161 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Indicators - -# Interface: MetricsTree\_Market\_Indicators - -Defined in: [Developer/brk/modules/brk-client/index.js:4358](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4358) - -## Properties - -### gini - -> **gini**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4377](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4377) - -*** - -### macdHistogram - -> **macdHistogram**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4376](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4376) - -*** - -### macdLine - -> **macdLine**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4374](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4374) - -*** - -### macdSignal - -> **macdSignal**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4375](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4375) - -*** - -### nvt - -> **nvt**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4360](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4360) - -*** - -### piCycle - -> **piCycle**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4373](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4373) - -*** - -### puellMultiple - -> **puellMultiple**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4359](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4359) - -*** - -### rsi14d - -> **rsi14d**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4365](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4365) - -*** - -### rsi14dMax - -> **rsi14dMax**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4367](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4367) - -*** - -### rsi14dMin - -> **rsi14dMin**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4366](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4366) - -*** - -### rsiAverageGain14d - -> **rsiAverageGain14d**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4363](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4363) - -*** - -### rsiAverageLoss14d - -> **rsiAverageLoss14d**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4364](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4364) - -*** - -### rsiGains - -> **rsiGains**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4361](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4361) - -*** - -### rsiLosses - -> **rsiLosses**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4362](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4362) - -*** - -### stochD - -> **stochD**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4372](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4372) - -*** - -### stochK - -> **stochK**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4371](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4371) - -*** - -### stochRsi - -> **stochRsi**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4368](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4368) - -*** - -### stochRsiD - -> **stochRsiD**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4370](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4370) - -*** - -### stochRsiK - -> **stochRsiK**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4369](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4369) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Lookback.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Lookback.md deleted file mode 100644 index 70d641010..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Lookback.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Lookback - -# Interface: MetricsTree\_Market\_Lookback - -Defined in: [Developer/brk/modules/brk-client/index.js:4107](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4107) - -## Properties - -### \_10y - -> **\_10y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4120](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4120) - -*** - -### \_1d - -> **\_1d**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4108](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4108) - -*** - -### \_1m - -> **\_1m**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4110](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4110) - -*** - -### \_1w - -> **\_1w**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4109](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4109) - -*** - -### \_1y - -> **\_1y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4113](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4113) - -*** - -### \_2y - -> **\_2y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4114](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4114) - -*** - -### \_3m - -> **\_3m**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4111](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4111) - -*** - -### \_3y - -> **\_3y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4115](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4115) - -*** - -### \_4y - -> **\_4y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4116](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4116) - -*** - -### \_5y - -> **\_5y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4117](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4117) - -*** - -### \_6m - -> **\_6m**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4112](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4112) - -*** - -### \_6y - -> **\_6y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4118](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4118) - -*** - -### \_8y - -> **\_8y**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4119](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4119) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_MovingAverage.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_MovingAverage.md deleted file mode 100644 index 60d154694..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_MovingAverage.md +++ /dev/null @@ -1,289 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_MovingAverage - -# Interface: MetricsTree\_Market\_MovingAverage - -Defined in: [Developer/brk/modules/brk-client/index.js:4182](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4182) - -## Properties - -### price111dSma - -> **price111dSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4191](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4191) - -*** - -### price12dEma - -> **price12dEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4201](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4201) - -*** - -### price13dEma - -> **price13dEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4202](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4202) - -*** - -### price13dSma - -> **price13dSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4185](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4185) - -*** - -### price144dEma - -> **price144dEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4209](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4209) - -*** - -### price144dSma - -> **price144dSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4192](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4192) - -*** - -### price1mEma - -> **price1mEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4205](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4205) - -*** - -### price1mSma - -> **price1mSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4187](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4187) - -*** - -### price1wEma - -> **price1wEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4199](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4199) - -*** - -### price1wSma - -> **price1wSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4183](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4183) - -*** - -### price1yEma - -> **price1yEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4211](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4211) - -*** - -### price1ySma - -> **price1ySma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4195](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4195) - -*** - -### price200dEma - -> **price200dEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4210](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4210) - -*** - -### price200dSma - -> **price200dSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4193](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4193) - -*** - -### price200dSmaX08 - -> **price200dSmaX08**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4216](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4216) - -*** - -### price200dSmaX24 - -> **price200dSmaX24**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4215](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4215) - -*** - -### price200wEma - -> **price200wEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4213](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4213) - -*** - -### price200wSma - -> **price200wSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4197](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4197) - -*** - -### price21dEma - -> **price21dEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4203](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4203) - -*** - -### price21dSma - -> **price21dSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4186](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4186) - -*** - -### price26dEma - -> **price26dEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4204](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4204) - -*** - -### price2yEma - -> **price2yEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4212](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4212) - -*** - -### price2ySma - -> **price2ySma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4196](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4196) - -*** - -### price34dEma - -> **price34dEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4206](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4206) - -*** - -### price34dSma - -> **price34dSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4188](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4188) - -*** - -### price350dSma - -> **price350dSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4194](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4194) - -*** - -### price350dSmaX2 - -> **price350dSmaX2**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4217](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4217) - -*** - -### price4yEma - -> **price4yEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4214](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4214) - -*** - -### price4ySma - -> **price4ySma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4198](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4198) - -*** - -### price55dEma - -> **price55dEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4207](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4207) - -*** - -### price55dSma - -> **price55dSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4189](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4189) - -*** - -### price89dEma - -> **price89dEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4208](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4208) - -*** - -### price89dSma - -> **price89dSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4190](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4190) - -*** - -### price8dEma - -> **price8dEma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4200](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4200) - -*** - -### price8dSma - -> **price8dSma**: [`PriceRatioPattern`](PriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4184](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4184) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Range.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Range.md deleted file mode 100644 index e74eff5d5..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Range.md +++ /dev/null @@ -1,97 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Range - -# Interface: MetricsTree\_Market\_Range - -Defined in: [Developer/brk/modules/brk-client/index.js:4167](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4167) - -## Properties - -### price1mMax - -> **price1mMax**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4173](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4173) - -*** - -### price1mMin - -> **price1mMin**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4172](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4172) - -*** - -### price1wMax - -> **price1wMax**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4169](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4169) - -*** - -### price1wMin - -> **price1wMin**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4168](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4168) - -*** - -### price1yMax - -> **price1yMax**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4175](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4175) - -*** - -### price1yMin - -> **price1yMin**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4174](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4174) - -*** - -### price2wChoppinessIndex - -> **price2wChoppinessIndex**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4178](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4178) - -*** - -### price2wMax - -> **price2wMax**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4171](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4171) - -*** - -### price2wMin - -> **price2wMin**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4170](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4170) - -*** - -### priceTrueRange - -> **priceTrueRange**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4176](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4176) - -*** - -### priceTrueRange2wSum - -> **priceTrueRange2wSum**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4177](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4177) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns.md deleted file mode 100644 index 8958e177f..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Returns - -# Interface: MetricsTree\_Market\_Returns - -Defined in: [Developer/brk/modules/brk-client/index.js:4124](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4124) - -## Properties - -### \_1dReturns1mSd - -> **\_1dReturns1mSd**: [`SdSmaPattern`](SdSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4128](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4128) - -*** - -### \_1dReturns1wSd - -> **\_1dReturns1wSd**: [`SdSmaPattern`](SdSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4127](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4127) - -*** - -### \_1dReturns1ySd - -> **\_1dReturns1ySd**: [`SdSmaPattern`](SdSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4129](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4129) - -*** - -### cagr - -> **cagr**: [`_10y2y3y4y5y6y8yPattern`](10y2y3y4y5y6y8yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4126](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4126) - -*** - -### downside1mSd - -> **downside1mSd**: [`SdSmaPattern`](SdSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4132](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4132) - -*** - -### downside1wSd - -> **downside1wSd**: [`SdSmaPattern`](SdSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4131](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4131) - -*** - -### downside1ySd - -> **downside1ySd**: [`SdSmaPattern`](SdSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4133](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4133) - -*** - -### downsideReturns - -> **downsideReturns**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4130](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4130) - -*** - -### priceReturns - -> **priceReturns**: [`MetricsTree_Market_Returns_PriceReturns`](MetricsTree_Market_Returns_PriceReturns.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4125](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4125) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns_PriceReturns.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns_PriceReturns.md deleted file mode 100644 index 7eaa58868..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns_PriceReturns.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Returns\_PriceReturns - -# Interface: MetricsTree\_Market\_Returns\_PriceReturns - -Defined in: [Developer/brk/modules/brk-client/index.js:4137](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4137) - -## Properties - -### \_10y - -> **\_10y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4150](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4150) - -*** - -### \_1d - -> **\_1d**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4138](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4138) - -*** - -### \_1m - -> **\_1m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4140](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4140) - -*** - -### \_1w - -> **\_1w**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4139](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4139) - -*** - -### \_1y - -> **\_1y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4143](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4143) - -*** - -### \_2y - -> **\_2y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4144](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4144) - -*** - -### \_3m - -> **\_3m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4141](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4141) - -*** - -### \_3y - -> **\_3y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4145](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4145) - -*** - -### \_4y - -> **\_4y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4146](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4146) - -*** - -### \_5y - -> **\_5y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4147](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4147) - -*** - -### \_6m - -> **\_6m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4142](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4142) - -*** - -### \_6y - -> **\_6y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4148](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4148) - -*** - -### \_8y - -> **\_8y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4149](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4149) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Volatility.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Volatility.md deleted file mode 100644 index 5af98bf83..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Market_Volatility.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Market\_Volatility - -# Interface: MetricsTree\_Market\_Volatility - -Defined in: [Developer/brk/modules/brk-client/index.js:4154](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4154) - -## Properties - -### price1mVolatility - -> **price1mVolatility**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4156](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4156) - -*** - -### price1wVolatility - -> **price1wVolatility**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4155](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4155) - -*** - -### price1yVolatility - -> **price1yVolatility**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4157](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4157) - -*** - -### sharpe1m - -> **sharpe1m**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4159](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4159) - -*** - -### sharpe1w - -> **sharpe1w**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4158](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4158) - -*** - -### sharpe1y - -> **sharpe1y**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4160](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4160) - -*** - -### sortino1m - -> **sortino1m**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4162](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4162) - -*** - -### sortino1w - -> **sortino1w**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4161](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4161) - -*** - -### sortino1y - -> **sortino1y**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4163](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4163) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Outputs.md b/modules/brk-client/docs/interfaces/MetricsTree_Outputs.md deleted file mode 100644 index 4bfd769e9..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Outputs.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Outputs - -# Interface: MetricsTree\_Outputs - -Defined in: [Developer/brk/modules/brk-client/index.js:3713](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3713) - -## Properties - -### count - -> **count**: [`MetricsTree_Outputs_Count`](MetricsTree_Outputs_Count.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3720](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3720) - -*** - -### firstTxoutindex - -> **firstTxoutindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3714](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3714) - -*** - -### outputtype - -> **outputtype**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<[`OutputType`](../type-aliases/OutputType.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3716](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3716) - -*** - -### spent - -> **spent**: [`MetricsTree_Outputs_Spent`](MetricsTree_Outputs_Spent.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3719](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3719) - -*** - -### txindex - -> **txindex**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3718](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3718) - -*** - -### typeindex - -> **typeindex**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3717](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3717) - -*** - -### value - -> **value**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3715](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3715) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Count.md b/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Count.md deleted file mode 100644 index 9c0e11914..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Count.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Outputs\_Count - -# Interface: MetricsTree\_Outputs\_Count - -Defined in: [Developer/brk/modules/brk-client/index.js:3729](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3729) - -## Properties - -### totalCount - -> **totalCount**: [`AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3730](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3730) - -*** - -### utxoCount - -> **utxoCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3731](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3731) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Spent.md b/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Spent.md deleted file mode 100644 index 8edeb18eb..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Spent.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Outputs\_Spent - -# Interface: MetricsTree\_Outputs\_Spent - -Defined in: [Developer/brk/modules/brk-client/index.js:3724](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3724) - -## Properties - -### txinindex - -> **txinindex**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3725](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3725) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Pools.md b/modules/brk-client/docs/interfaces/MetricsTree_Pools.md deleted file mode 100644 index ef221687d..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Pools.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Pools - -# Interface: MetricsTree\_Pools - -Defined in: [Developer/brk/modules/brk-client/index.js:4381](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4381) - -## Properties - -### heightToPool - -> **heightToPool**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<[`PoolSlug`](../type-aliases/PoolSlug.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4382](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4382) - -*** - -### vecs - -> **vecs**: [`MetricsTree_Pools_Vecs`](MetricsTree_Pools_Vecs.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4383](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4383) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Pools_Vecs.md b/modules/brk-client/docs/interfaces/MetricsTree_Pools_Vecs.md deleted file mode 100644 index c945d897d..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Pools_Vecs.md +++ /dev/null @@ -1,1273 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Pools\_Vecs - -# Interface: MetricsTree\_Pools\_Vecs - -Defined in: [Developer/brk/modules/brk-client/index.js:4387](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4387) - -## Properties - -### aaopool - -> **aaopool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4497](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4497) - -*** - -### antpool - -> **antpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4432](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4432) - -*** - -### arkpool - -> **arkpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4501](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4501) - -*** - -### asicminer - -> **asicminer**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4404](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4404) - -*** - -### axbt - -> **axbt**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4403](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4403) - -*** - -### batpool - -> **batpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4463](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4463) - -*** - -### bcmonster - -> **bcmonster**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4457](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4457) - -*** - -### bcpoolio - -> **bcpoolio**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4434](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4434) - -*** - -### binancepool - -> **binancepool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4493](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4493) - -*** - -### bitalo - -> **bitalo**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4423](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4423) - -*** - -### bitclub - -> **bitclub**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4440](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4440) - -*** - -### bitcoinaffiliatenetwork - -> **bitcoinaffiliatenetwork**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4441](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4441) - -*** - -### bitcoincom - -> **bitcoincom**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4400](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4400) - -*** - -### bitcoinindia - -> **bitcoinindia**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4469](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4469) - -*** - -### bitcoinrussia - -> **bitcoinrussia**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4406](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4406) - -*** - -### bitcoinukraine - -> **bitcoinukraine**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4481](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4481) - -*** - -### bitfarms - -> **bitfarms**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4395](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4395) - -*** - -### bitfufupool - -> **bitfufupool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4538](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4538) - -*** - -### bitfury - -> **bitfury**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4446](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4446) - -*** - -### bitminter - -> **bitminter**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4405](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4405) - -*** - -### bitparking - -> **bitparking**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4419](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4419) - -*** - -### bitsolo - -> **bitsolo**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4445](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4445) - -*** - -### bixin - -> **bixin**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4459](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4459) - -*** - -### blockfills - -> **blockfills**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4389](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4389) - -*** - -### braiinspool - -> **braiinspool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4431](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4431) - -*** - -### bravomining - -> **bravomining**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4454](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4454) - -*** - -### btcc - -> **btcc**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4442](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4442) - -*** - -### btccom - -> **btccom**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4394](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4394) - -*** - -### btcdig - -> **btcdig**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4516](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4516) - -*** - -### btcguild - -> **btcguild**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4409](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4409) - -*** - -### btclab - -> **btclab**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4544](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4544) - -*** - -### btcmp - -> **btcmp**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4518](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4518) - -*** - -### btcnuggets - -> **btcnuggets**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4509](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4509) - -*** - -### btcpoolparty - -> **btcpoolparty**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4513](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4513) - -*** - -### btcserv - -> **btcserv**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4407](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4407) - -*** - -### btctop - -> **btctop**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4399](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4399) - -*** - -### btpool - -> **btpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4467](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4467) - -*** - -### bwpool - -> **bwpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4443](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4443) - -*** - -### bytepool - -> **bytepool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4489](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4489) - -*** - -### canoe - -> **canoe**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4524](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4524) - -*** - -### canoepool - -> **canoepool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4398](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4398) - -*** - -### carbonnegative - -> **carbonnegative**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4533](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4533) - -*** - -### ckpool - -> **ckpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4438](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4438) - -*** - -### cloudhashing - -> **cloudhashing**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4510](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4510) - -*** - -### coinlab - -> **coinlab**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4415](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4415) - -*** - -### cointerra - -> **cointerra**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4435](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4435) - -*** - -### connectbtc - -> **connectbtc**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4462](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4462) - -*** - -### dcex - -> **dcex**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4466](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4466) - -*** - -### dcexploration - -> **dcexploration**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4465](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4465) - -*** - -### digitalbtc - -> **digitalbtc**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4448](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4448) - -*** - -### digitalxmintsy - -> **digitalxmintsy**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4511](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4511) - -*** - -### dpool - -> **dpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4477](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4477) - -*** - -### eclipsemc - -> **eclipsemc**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4412](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4412) - -*** - -### eightbaochi - -> **eightbaochi**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4449](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4449) - -*** - -### ekanembtc - -> **ekanembtc**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4523](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4523) - -*** - -### eligius - -> **eligius**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4410](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4410) - -*** - -### emcdpool - -> **emcdpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4498](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4498) - -*** - -### entrustcharitypool - -> **entrustcharitypool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4505](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4505) - -*** - -### eobot - -> **eobot**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4519](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4519) - -*** - -### exxbw - -> **exxbw**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4444](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4444) - -*** - -### f2pool - -> **f2pool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4424](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4424) - -*** - -### fiftyeightcoin - -> **fiftyeightcoin**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4468](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4468) - -*** - -### foundryusa - -> **foundryusa**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4499](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4499) - -*** - -### futurebitapollosolo - -> **futurebitapollosolo**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4532](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4532) - -*** - -### gbminers - -> **gbminers**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4402](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4402) - -*** - -### ghashio - -> **ghashio**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4417](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4417) - -*** - -### givemecoins - -> **givemecoins**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4430](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4430) - -*** - -### gogreenlight - -> **gogreenlight**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4522](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4522) - -*** - -### haominer - -> **haominer**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4479](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4479) - -*** - -### haozhuzhu - -> **haozhuzhu**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4473](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4473) - -*** - -### hashbx - -> **hashbx**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4476](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4476) - -*** - -### hashpool - -> **hashpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4452](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4452) - -*** - -### helix - -> **helix**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4480](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4480) - -*** - -### hhtt - -> **hhtt**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4425](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4425) - -*** - -### hotpool - -> **hotpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4455](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4455) - -*** - -### hummerpool - -> **hummerpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4487](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4487) - -*** - -### huobipool - -> **huobipool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4396](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4396) - -*** - -### innopolistech - -> **innopolistech**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4543](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4543) - -*** - -### kanopool - -> **kanopool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4436](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4436) - -*** - -### kncminer - -> **kncminer**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4422](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4422) - -*** - -### kucoinpool - -> **kucoinpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4504](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4504) - -*** - -### lubiancom - -> **lubiancom**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4495](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4495) - -*** - -### luckypool - -> **luckypool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4539](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4539) - -*** - -### luxor - -> **luxor**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4392](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4392) - -*** - -### marapool - -> **marapool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4503](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4503) - -*** - -### maxbtc - -> **maxbtc**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4413](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4413) - -*** - -### maxipool - -> **maxipool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4537](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4537) - -*** - -### megabigpower - -> **megabigpower**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4426](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4426) - -*** - -### minerium - -> **minerium**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4494](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4494) - -*** - -### miningcity - -> **miningcity**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4492](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4492) - -*** - -### miningdutch - -> **miningdutch**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4540](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4540) - -*** - -### miningkings - -> **miningkings**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4475](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4475) - -*** - -### miningsquared - -> **miningsquared**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4542](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4542) - -*** - -### mmpool - -> **mmpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4420](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4420) - -*** - -### mtred - -> **mtred**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4427](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4427) - -*** - -### multicoinco - -> **multicoinco**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4433](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4433) - -*** - -### multipool - -> **multipool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4514](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4514) - -*** - -### mybtccoinpool - -> **mybtccoinpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4450](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4450) - -*** - -### neopool - -> **neopool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4536](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4536) - -*** - -### nexious - -> **nexious**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4453](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4453) - -*** - -### nicehash - -> **nicehash**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4439](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4439) - -*** - -### nmcbit - -> **nmcbit**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4428](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4428) - -*** - -### novablock - -> **novablock**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4491](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4491) - -*** - -### ocean - -> **ocean**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4529](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4529) - -*** - -### okexpool - -> **okexpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4456](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4456) - -*** - -### okkong - -> **okkong**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4496](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4496) - -*** - -### okminer - -> **okminer**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4506](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4506) - -*** - -### okpooltop - -> **okpooltop**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4486](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4486) - -*** - -### onehash - -> **onehash**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4458](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4458) - -*** - -### onem1x - -> **onem1x**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4526](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4526) - -*** - -### onethash - -> **onethash**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4393](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4393) - -*** - -### ozcoin - -> **ozcoin**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4411](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4411) - -*** - -### parasite - -> **parasite**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4545](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4545) - -*** - -### patels - -> **patels**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4521](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4521) - -*** - -### pegapool - -> **pegapool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4508](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4508) - -*** - -### phashio - -> **phashio**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4471](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4471) - -*** - -### phoenix - -> **phoenix**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4535](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4535) - -*** - -### polmine - -> **polmine**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4421](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4421) - -*** - -### pool175btc - -> **pool175btc**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4401](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4401) - -*** - -### pool50btc - -> **pool50btc**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4416](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4416) - -*** - -### poolin - -> **poolin**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4482](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4482) - -*** - -### portlandhodl - -> **portlandhodl**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4534](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4534) - -*** - -### publicpool - -> **publicpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4541](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4541) - -*** - -### purebtccom - -> **purebtccom**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4502](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4502) - -*** - -### rawpool - -> **rawpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4478](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4478) - -*** - -### rigpool - -> **rigpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4472](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4472) - -*** - -### sbicrypto - -> **sbicrypto**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4500](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4500) - -*** - -### secpool - -> **secpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4528](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4528) - -*** - -### secretsuperstar - -> **secretsuperstar**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4483](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4483) - -*** - -### sevenpool - -> **sevenpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4474](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4474) - -*** - -### shawnp0wers - -> **shawnp0wers**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4470](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4470) - -*** - -### sigmapoolcom - -> **sigmapoolcom**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4485](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4485) - -*** - -### simplecoinus - -> **simplecoinus**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4408](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4408) - -*** - -### solock - -> **solock**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4437](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4437) - -*** - -### spiderpool - -> **spiderpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4490](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4490) - -*** - -### stminingcorp - -> **stminingcorp**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4418](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4418) - -*** - -### tangpool - -> **tangpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4488](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4488) - -*** - -### tatmaspool - -> **tatmaspool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4460](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4460) - -*** - -### tbdice - -> **tbdice**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4451](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4451) - -*** - -### telco214 - -> **telco214**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4512](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4512) - -*** - -### terrapool - -> **terrapool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4391](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4391) - -*** - -### tiger - -> **tiger**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4525](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4525) - -*** - -### tigerpoolnet - -> **tigerpoolnet**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4484](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4484) - -*** - -### titan - -> **titan**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4507](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4507) - -*** - -### transactioncoinmining - -> **transactioncoinmining**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4515](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4515) - -*** - -### trickysbtcpool - -> **trickysbtcpool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4517](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4517) - -*** - -### triplemining - -> **triplemining**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4414](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4414) - -*** - -### twentyoneinc - -> **twentyoneinc**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4447](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4447) - -*** - -### ultimuspool - -> **ultimuspool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4390](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4390) - -*** - -### unknown - -> **unknown**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4388](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4388) - -*** - -### unomp - -> **unomp**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4520](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4520) - -*** - -### viabtc - -> **viabtc**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4461](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4461) - -*** - -### waterhole - -> **waterhole**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4464](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4464) - -*** - -### wayicn - -> **wayicn**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4397](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4397) - -*** - -### whitepool - -> **whitepool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4530](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4530) - -*** - -### wk057 - -> **wk057**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4531](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4531) - -*** - -### yourbtcnet - -> **yourbtcnet**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4429](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4429) - -*** - -### zulupool - -> **zulupool**: [`_1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern`](1m1w1y24hBlocksCoinbaseDaysDominanceFeeSubsidyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4527](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4527) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Positions.md b/modules/brk-client/docs/interfaces/MetricsTree_Positions.md deleted file mode 100644 index ac8fa0ff8..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Positions.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Positions - -# Interface: MetricsTree\_Positions - -Defined in: [Developer/brk/modules/brk-client/index.js:3793](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3793) - -## Properties - -### blockPosition - -> **blockPosition**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3794](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3794) - -*** - -### txPosition - -> **txPosition**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3795](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3795) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Price.md b/modules/brk-client/docs/interfaces/MetricsTree_Price.md deleted file mode 100644 index be382b4bc..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Price.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Price - -# Interface: MetricsTree\_Price - -Defined in: [Developer/brk/modules/brk-client/index.js:4549](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4549) - -## Properties - -### cents - -> **cents**: [`MetricsTree_Price_Cents`](MetricsTree_Price_Cents.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4550](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4550) - -*** - -### oracle - -> **oracle**: [`MetricsTree_Price_Oracle`](MetricsTree_Price_Oracle.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4553](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4553) - -*** - -### sats - -> **sats**: [`OhlcSplitPattern2`](OhlcSplitPattern2.md)\<[`OHLCSats`](OHLCSats.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4552](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4552) - -*** - -### usd - -> **usd**: [`MetricsTree_Price_Usd`](MetricsTree_Price_Usd.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4551](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4551) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents.md b/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents.md deleted file mode 100644 index f6782572b..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Price\_Cents - -# Interface: MetricsTree\_Price\_Cents - -Defined in: [Developer/brk/modules/brk-client/index.js:4557](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4557) - -## Properties - -### ohlc - -> **ohlc**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<[`OHLCCentsUnsigned`](OHLCCentsUnsigned.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4559](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4559) - -*** - -### split - -> **split**: [`MetricsTree_Price_Cents_Split`](MetricsTree_Price_Cents_Split.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4558](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4558) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents_Split.md b/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents_Split.md deleted file mode 100644 index e81092054..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents_Split.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Price\_Cents\_Split - -# Interface: MetricsTree\_Price\_Cents\_Split - -Defined in: [Developer/brk/modules/brk-client/index.js:4563](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4563) - -## Properties - -### close - -> **close**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4567](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4567) - -*** - -### high - -> **high**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4565](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4565) - -*** - -### low - -> **low**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4566](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4566) - -*** - -### open - -> **open**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4564](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4564) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Price_Oracle.md b/modules/brk-client/docs/interfaces/MetricsTree_Price_Oracle.md deleted file mode 100644 index 746110146..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Price_Oracle.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Price\_Oracle - -# Interface: MetricsTree\_Price\_Oracle - -Defined in: [Developer/brk/modules/brk-client/index.js:4577](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4577) - -## Properties - -### ohlc - -> **ohlc**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<[`OHLCCentsUnsigned`](OHLCCentsUnsigned.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4581](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4581) - -*** - -### ohlcCents - -> **ohlcCents**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<[`OHLCCentsUnsigned`](OHLCCentsUnsigned.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4579](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4579) - -*** - -### ohlcDollars - -> **ohlcDollars**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<[`OHLCDollars`](OHLCDollars.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4582](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4582) - -*** - -### priceCents - -> **priceCents**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4578](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4578) - -*** - -### split - -> **split**: [`CloseHighLowOpenPattern2`](CloseHighLowOpenPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4580](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4580) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Price_Usd.md b/modules/brk-client/docs/interfaces/MetricsTree_Price_Usd.md deleted file mode 100644 index 0981efd92..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Price_Usd.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Price\_Usd - -# Interface: MetricsTree\_Price\_Usd - -Defined in: [Developer/brk/modules/brk-client/index.js:4571](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4571) - -## Properties - -### ohlc - -> **ohlc**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<[`OHLCDollars`](OHLCDollars.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4573](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4573) - -*** - -### split - -> **split**: [`CloseHighLowOpenPattern2`](CloseHighLowOpenPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4572](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4572) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Scripts.md b/modules/brk-client/docs/interfaces/MetricsTree_Scripts.md deleted file mode 100644 index 3ff649056..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Scripts.md +++ /dev/null @@ -1,89 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Scripts - -# Interface: MetricsTree\_Scripts - -Defined in: [Developer/brk/modules/brk-client/index.js:3755](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3755) - -## Properties - -### count - -> **count**: [`MetricsTree_Scripts_Count`](MetricsTree_Scripts_Count.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3764](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3764) - -*** - -### emptyToTxindex - -> **emptyToTxindex**: [`MetricPattern9`](../type-aliases/MetricPattern9.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3760](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3760) - -*** - -### firstEmptyoutputindex - -> **firstEmptyoutputindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3756](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3756) - -*** - -### firstOpreturnindex - -> **firstOpreturnindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3757](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3757) - -*** - -### firstP2msoutputindex - -> **firstP2msoutputindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3758](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3758) - -*** - -### firstUnknownoutputindex - -> **firstUnknownoutputindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3759](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3759) - -*** - -### opreturnToTxindex - -> **opreturnToTxindex**: [`MetricPattern14`](../type-aliases/MetricPattern14.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3761](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3761) - -*** - -### p2msToTxindex - -> **p2msToTxindex**: [`MetricPattern17`](../type-aliases/MetricPattern17.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3762](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3762) - -*** - -### unknownToTxindex - -> **unknownToTxindex**: [`MetricPattern28`](../type-aliases/MetricPattern28.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3763](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3763) - -*** - -### value - -> **value**: [`MetricsTree_Scripts_Value`](MetricsTree_Scripts_Value.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3765](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3765) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Count.md b/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Count.md deleted file mode 100644 index f588a5fdb..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Count.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Scripts\_Count - -# Interface: MetricsTree\_Scripts\_Count - -Defined in: [Developer/brk/modules/brk-client/index.js:3769](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3769) - -## Properties - -### emptyoutput - -> **emptyoutput**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3780](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3780) - -*** - -### opreturn - -> **opreturn**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3779](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3779) - -*** - -### p2a - -> **p2a**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3770](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3770) - -*** - -### p2ms - -> **p2ms**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3771](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3771) - -*** - -### p2pk33 - -> **p2pk33**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3772](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3772) - -*** - -### p2pk65 - -> **p2pk65**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3773](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3773) - -*** - -### p2pkh - -> **p2pkh**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3774](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3774) - -*** - -### p2sh - -> **p2sh**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3775](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3775) - -*** - -### p2tr - -> **p2tr**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3776](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3776) - -*** - -### p2wpkh - -> **p2wpkh**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3777](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3777) - -*** - -### p2wsh - -> **p2wsh**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3778](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3778) - -*** - -### segwit - -> **segwit**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3782](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3782) - -*** - -### segwitAdoption - -> **segwitAdoption**: [`BaseCumulativeSumPattern`](BaseCumulativeSumPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3784](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3784) - -*** - -### taprootAdoption - -> **taprootAdoption**: [`BaseCumulativeSumPattern`](BaseCumulativeSumPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3783](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3783) - -*** - -### unknownoutput - -> **unknownoutput**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3781](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3781) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Value.md b/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Value.md deleted file mode 100644 index 3ad5874c8..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Value.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Scripts\_Value - -# Interface: MetricsTree\_Scripts\_Value - -Defined in: [Developer/brk/modules/brk-client/index.js:3788](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3788) - -## Properties - -### opreturn - -> **opreturn**: [`BitcoinDollarsSatsPattern2`](BitcoinDollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3789](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3789) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Supply.md b/modules/brk-client/docs/interfaces/MetricsTree_Supply.md deleted file mode 100644 index 05f7cd9e4..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Supply.md +++ /dev/null @@ -1,73 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Supply - -# Interface: MetricsTree\_Supply - -Defined in: [Developer/brk/modules/brk-client/index.js:4973](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4973) - -## Properties - -### burned - -> **burned**: [`MetricsTree_Supply_Burned`](MetricsTree_Supply_Burned.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4975](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4975) - -*** - -### capGrowthRateDiff - -> **capGrowthRateDiff**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4981](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4981) - -*** - -### circulating - -> **circulating**: [`MetricsTree_Supply_Circulating`](MetricsTree_Supply_Circulating.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4974](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4974) - -*** - -### inflation - -> **inflation**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4976](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4976) - -*** - -### marketCap - -> **marketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4978](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4978) - -*** - -### marketCapGrowthRate - -> **marketCapGrowthRate**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4979](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4979) - -*** - -### realizedCapGrowthRate - -> **realizedCapGrowthRate**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4980](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4980) - -*** - -### velocity - -> **velocity**: [`MetricsTree_Supply_Velocity`](MetricsTree_Supply_Velocity.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4977](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4977) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Supply_Burned.md b/modules/brk-client/docs/interfaces/MetricsTree_Supply_Burned.md deleted file mode 100644 index b59abe49d..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Supply_Burned.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Supply\_Burned - -# Interface: MetricsTree\_Supply\_Burned - -Defined in: [Developer/brk/modules/brk-client/index.js:4992](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4992) - -## Properties - -### opreturn - -> **opreturn**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4993](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4993) - -*** - -### unspendable - -> **unspendable**: [`BitcoinDollarsSatsPattern3`](BitcoinDollarsSatsPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4994](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4994) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Supply_Circulating.md b/modules/brk-client/docs/interfaces/MetricsTree_Supply_Circulating.md deleted file mode 100644 index 24b55aece..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Supply_Circulating.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Supply\_Circulating - -# Interface: MetricsTree\_Supply\_Circulating - -Defined in: [Developer/brk/modules/brk-client/index.js:4985](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4985) - -## Properties - -### bitcoin - -> **bitcoin**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4987](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4987) - -*** - -### dollars - -> **dollars**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4988](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4988) - -*** - -### sats - -> **sats**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4986](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4986) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Supply_Velocity.md b/modules/brk-client/docs/interfaces/MetricsTree_Supply_Velocity.md deleted file mode 100644 index a9a661003..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Supply_Velocity.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Supply\_Velocity - -# Interface: MetricsTree\_Supply\_Velocity - -Defined in: [Developer/brk/modules/brk-client/index.js:4998](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4998) - -## Properties - -### btc - -> **btc**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4999](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L4999) - -*** - -### usd - -> **usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5000](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L5000) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions.md deleted file mode 100644 index a81af8d63..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Transactions.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Transactions - -# Interface: MetricsTree\_Transactions - -Defined in: [Developer/brk/modules/brk-client/index.js:3632](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3632) - -## Properties - -### baseSize - -> **baseSize**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3638](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3638) - -*** - -### count - -> **count**: [`MetricsTree_Transactions_Count`](MetricsTree_Transactions_Count.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3643](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3643) - -*** - -### fees - -> **fees**: [`MetricsTree_Transactions_Fees`](MetricsTree_Transactions_Fees.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3645](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3645) - -*** - -### firstTxindex - -> **firstTxindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3633](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3633) - -*** - -### firstTxinindex - -> **firstTxinindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3641](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3641) - -*** - -### firstTxoutindex - -> **firstTxoutindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3642](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3642) - -*** - -### height - -> **height**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3634](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3634) - -*** - -### isExplicitlyRbf - -> **isExplicitlyRbf**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3640](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3640) - -*** - -### rawlocktime - -> **rawlocktime**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3637](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3637) - -*** - -### size - -> **size**: [`MetricsTree_Transactions_Size`](MetricsTree_Transactions_Size.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3644](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3644) - -*** - -### totalSize - -> **totalSize**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3639](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3639) - -*** - -### txid - -> **txid**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3635](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3635) - -*** - -### txversion - -> **txversion**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3636](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3636) - -*** - -### versions - -> **versions**: [`MetricsTree_Transactions_Versions`](MetricsTree_Transactions_Versions.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3646](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3646) - -*** - -### volume - -> **volume**: [`MetricsTree_Transactions_Volume`](MetricsTree_Transactions_Volume.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3647](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3647) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Count.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Count.md deleted file mode 100644 index e5adbb551..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Count.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Transactions\_Count - -# Interface: MetricsTree\_Transactions\_Count - -Defined in: [Developer/brk/modules/brk-client/index.js:3651](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3651) - -## Properties - -### isCoinbase - -> **isCoinbase**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3653](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3653) - -*** - -### txCount - -> **txCount**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3652](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3652) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees.md deleted file mode 100644 index cc98bfb0e..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Transactions\_Fees - -# Interface: MetricsTree\_Transactions\_Fees - -Defined in: [Developer/brk/modules/brk-client/index.js:3663](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3663) - -## Properties - -### fee - -> **fee**: [`MetricsTree_Transactions_Fees_Fee`](MetricsTree_Transactions_Fees_Fee.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3666](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3666) - -*** - -### feeRate - -> **feeRate**: [`AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern`](AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3667](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3667) - -*** - -### inputValue - -> **inputValue**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3664](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3664) - -*** - -### outputValue - -> **outputValue**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3665](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3665) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees_Fee.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees_Fee.md deleted file mode 100644 index 383721f04..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees_Fee.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Transactions\_Fees\_Fee - -# Interface: MetricsTree\_Transactions\_Fees\_Fee - -Defined in: [Developer/brk/modules/brk-client/index.js:3671](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3671) - -## Properties - -### bitcoin - -> **bitcoin**: [`AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3674](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3674) - -*** - -### dollars - -> **dollars**: [`AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3675](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3675) - -*** - -### sats - -> **sats**: [`AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2`](AverageCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3673](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3673) - -*** - -### txindex - -> **txindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3672](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3672) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Size.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Size.md deleted file mode 100644 index f71b275a0..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Size.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Transactions\_Size - -# Interface: MetricsTree\_Transactions\_Size - -Defined in: [Developer/brk/modules/brk-client/index.js:3657](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3657) - -## Properties - -### vsize - -> **vsize**: [`AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern`](AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3658](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3658) - -*** - -### weight - -> **weight**: [`AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern`](AverageMaxMedianMinPct10Pct25Pct75Pct90TxindexPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3659](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3659) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Versions.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Versions.md deleted file mode 100644 index 56a424e57..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Versions.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Transactions\_Versions - -# Interface: MetricsTree\_Transactions\_Versions - -Defined in: [Developer/brk/modules/brk-client/index.js:3679](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3679) - -## Properties - -### v1 - -> **v1**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3680](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3680) - -*** - -### v2 - -> **v2**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3681](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3681) - -*** - -### v3 - -> **v3**: [`CumulativeSumPattern`](CumulativeSumPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3682](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3682) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Volume.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Volume.md deleted file mode 100644 index 2008ea0cb..000000000 --- a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Volume.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricsTree\_Transactions\_Volume - -# Interface: MetricsTree\_Transactions\_Volume - -Defined in: [Developer/brk/modules/brk-client/index.js:3686](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3686) - -## Properties - -### annualizedVolume - -> **annualizedVolume**: [`BitcoinDollarsSatsPattern5`](BitcoinDollarsSatsPattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3689](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3689) - -*** - -### inputsPerSec - -> **inputsPerSec**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3692](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3692) - -*** - -### outputsPerSec - -> **outputsPerSec**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3691](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3691) - -*** - -### receivedSum - -> **receivedSum**: [`BitcoinDollarsSatsPattern4`](BitcoinDollarsSatsPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3688](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3688) - -*** - -### sentSum - -> **sentSum**: [`BitcoinDollarsSatsPattern4`](BitcoinDollarsSatsPattern4.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3687](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3687) - -*** - -### txPerSec - -> **txPerSec**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3690](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3690) diff --git a/modules/brk-client/docs/interfaces/NuplPattern.md b/modules/brk-client/docs/interfaces/NuplPattern.md new file mode 100644 index 000000000..4b6950833 --- /dev/null +++ b/modules/brk-client/docs/interfaces/NuplPattern.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / NuplPattern + +# Interface: NuplPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:4083](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4083) + +## Properties + +### nupl + +> **nupl**: [`BpsRatioPattern`](BpsRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4084](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4084) diff --git a/modules/brk-client/docs/interfaces/NuplRealizedSupplyUnrealizedPattern.md b/modules/brk-client/docs/interfaces/NuplRealizedSupplyUnrealizedPattern.md new file mode 100644 index 000000000..552e11c98 --- /dev/null +++ b/modules/brk-client/docs/interfaces/NuplRealizedSupplyUnrealizedPattern.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / NuplRealizedSupplyUnrealizedPattern + +# Interface: NuplRealizedSupplyUnrealizedPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3183](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3183) + +## Properties + +### nupl + +> **nupl**: [`BpsRatioPattern`](BpsRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3184](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3184) + +*** + +### realizedCap + +> **realizedCap**: [`AllSthPattern`](AllSthPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3185](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3185) + +*** + +### supply + +> **supply**: [`AllSthPattern2`](AllSthPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3186](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3186) + +*** + +### unrealizedPnl + +> **unrealizedPnl**: [`AllSthPattern`](AllSthPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3187](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3187) diff --git a/modules/brk-client/docs/interfaces/OHLCCents.md b/modules/brk-client/docs/interfaces/OHLCCents.md new file mode 100644 index 000000000..1898e436b --- /dev/null +++ b/modules/brk-client/docs/interfaces/OHLCCents.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / OHLCCents + +# Interface: OHLCCents + +Defined in: [Developer/brk/modules/brk-client/index.js:502](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L502) + +## Properties + +### close + +> **close**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:506](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L506) + +*** + +### high + +> **high**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:504](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L504) + +*** + +### low + +> **low**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:505](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L505) + +*** + +### open + +> **open**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:503](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L503) diff --git a/modules/brk-client/docs/interfaces/OHLCCentsUnsigned.md b/modules/brk-client/docs/interfaces/OHLCCentsUnsigned.md deleted file mode 100644 index 361803b5c..000000000 --- a/modules/brk-client/docs/interfaces/OHLCCentsUnsigned.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / OHLCCentsUnsigned - -# Interface: OHLCCentsUnsigned - -Defined in: [Developer/brk/modules/brk-client/index.js:485](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L485) - -## Properties - -### close - -> **close**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:489](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L489) - -*** - -### high - -> **high**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:487](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L487) - -*** - -### low - -> **low**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:488](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L488) - -*** - -### open - -> **open**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:486](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L486) diff --git a/modules/brk-client/docs/interfaces/OHLCDollars.md b/modules/brk-client/docs/interfaces/OHLCDollars.md index 3bcd80c59..d79e14cc3 100644 --- a/modules/brk-client/docs/interfaces/OHLCDollars.md +++ b/modules/brk-client/docs/interfaces/OHLCDollars.md @@ -6,7 +6,7 @@ # Interface: OHLCDollars -Defined in: [Developer/brk/modules/brk-client/index.js:494](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L494) +Defined in: [Developer/brk/modules/brk-client/index.js:511](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L511) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:494](https://github.com/b > **close**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:498](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L498) +Defined in: [Developer/brk/modules/brk-client/index.js:515](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L515) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:498](https://github.com/b > **high**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:496](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L496) +Defined in: [Developer/brk/modules/brk-client/index.js:513](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L513) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:496](https://github.com/b > **low**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:497](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L497) +Defined in: [Developer/brk/modules/brk-client/index.js:514](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L514) *** @@ -38,4 +38,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:497](https://github.com/b > **open**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:495](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L495) +Defined in: [Developer/brk/modules/brk-client/index.js:512](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L512) diff --git a/modules/brk-client/docs/interfaces/OHLCSats.md b/modules/brk-client/docs/interfaces/OHLCSats.md index 74f20e794..3fb13d625 100644 --- a/modules/brk-client/docs/interfaces/OHLCSats.md +++ b/modules/brk-client/docs/interfaces/OHLCSats.md @@ -6,7 +6,7 @@ # Interface: OHLCSats -Defined in: [Developer/brk/modules/brk-client/index.js:503](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L503) +Defined in: [Developer/brk/modules/brk-client/index.js:520](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L520) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:503](https://github.com/b > **close**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:507](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L507) +Defined in: [Developer/brk/modules/brk-client/index.js:524](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L524) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:507](https://github.com/b > **high**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:505](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L505) +Defined in: [Developer/brk/modules/brk-client/index.js:522](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L522) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:505](https://github.com/b > **low**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:506](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L506) +Defined in: [Developer/brk/modules/brk-client/index.js:523](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L523) *** @@ -38,4 +38,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:506](https://github.com/b > **open**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:504](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L504) +Defined in: [Developer/brk/modules/brk-client/index.js:521](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L521) diff --git a/modules/brk-client/docs/interfaces/OhlcSplitPattern2.md b/modules/brk-client/docs/interfaces/OhlcSplitPattern2.md deleted file mode 100644 index de771aad7..000000000 --- a/modules/brk-client/docs/interfaces/OhlcSplitPattern2.md +++ /dev/null @@ -1,31 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / OhlcSplitPattern2 - -# Interface: OhlcSplitPattern2\ - -Defined in: [Developer/brk/modules/brk-client/index.js:3466](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3466) - -## Type Parameters - -### T - -`T` - -## Properties - -### ohlc - -> **ohlc**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3467](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3467) - -*** - -### split - -> **split**: [`CloseHighLowOpenPattern2`](CloseHighLowOpenPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3468](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3468) diff --git a/modules/brk-client/docs/interfaces/PaginatedMetrics.md b/modules/brk-client/docs/interfaces/PaginatedMetrics.md deleted file mode 100644 index 4837fa3ff..000000000 --- a/modules/brk-client/docs/interfaces/PaginatedMetrics.md +++ /dev/null @@ -1,39 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / PaginatedMetrics - -# Interface: PaginatedMetrics - -Defined in: [Developer/brk/modules/brk-client/index.js:541](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L541) - -## Properties - -### currentPage - -> **currentPage**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:542](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L542) - -Current page number (0-indexed) - -*** - -### maxPage - -> **maxPage**: `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:543](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L543) - -Maximum valid page index (0-indexed) - -*** - -### metrics - -> **metrics**: `string`[] - -Defined in: [Developer/brk/modules/brk-client/index.js:544](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L544) - -List of metric names (max 1000 per page) diff --git a/modules/brk-client/docs/interfaces/PaginatedSeries.md b/modules/brk-client/docs/interfaces/PaginatedSeries.md new file mode 100644 index 000000000..ea7909dde --- /dev/null +++ b/modules/brk-client/docs/interfaces/PaginatedSeries.md @@ -0,0 +1,69 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / PaginatedSeries + +# Interface: PaginatedSeries + +Defined in: [Developer/brk/modules/brk-client/index.js:558](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L558) + +## Properties + +### currentPage + +> **currentPage**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:559](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L559) + +Current page number (0-indexed) + +*** + +### hasMore + +> **hasMore**: `boolean` + +Defined in: [Developer/brk/modules/brk-client/index.js:563](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L563) + +Whether more pages are available after the current one + +*** + +### maxPage + +> **maxPage**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:560](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L560) + +Maximum valid page index (0-indexed) + +*** + +### perPage + +> **perPage**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:562](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L562) + +Results per page + +*** + +### series + +> **series**: `string`[] + +Defined in: [Developer/brk/modules/brk-client/index.js:564](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L564) + +List of series names + +*** + +### totalCount + +> **totalCount**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:561](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L561) + +Total number of series diff --git a/modules/brk-client/docs/interfaces/Pagination.md b/modules/brk-client/docs/interfaces/Pagination.md index 900ccee92..3e1110db0 100644 --- a/modules/brk-client/docs/interfaces/Pagination.md +++ b/modules/brk-client/docs/interfaces/Pagination.md @@ -6,14 +6,24 @@ # Interface: Pagination -Defined in: [Developer/brk/modules/brk-client/index.js:549](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L549) +Defined in: [Developer/brk/modules/brk-client/index.js:569](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L569) ## Properties ### page? -> `optional` **page**: `number` \| `null` +> `optional` **page?**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:550](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L550) +Defined in: [Developer/brk/modules/brk-client/index.js:570](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L570) Pagination index + +*** + +### perPage? + +> `optional` **perPage?**: `number` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:571](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L571) + +Results per page (default: 1000, max: 1000) diff --git a/modules/brk-client/docs/interfaces/Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md b/modules/brk-client/docs/interfaces/Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md index 683039c0b..183b02734 100644 --- a/modules/brk-client/docs/interfaces/Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md +++ b/modules/brk-client/docs/interfaces/Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md @@ -6,156 +6,156 @@ # Interface: Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern -Defined in: [Developer/brk/modules/brk-client/index.js:2096](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2096) +Defined in: [Developer/brk/modules/brk-client/index.js:1632](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1632) ## Properties ### pct05 -> **pct05**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct05**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2097](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2097) +Defined in: [Developer/brk/modules/brk-client/index.js:1633](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1633) *** ### pct10 -> **pct10**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct10**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2098](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2098) +Defined in: [Developer/brk/modules/brk-client/index.js:1634](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1634) *** ### pct15 -> **pct15**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct15**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2099](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2099) +Defined in: [Developer/brk/modules/brk-client/index.js:1635](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1635) *** ### pct20 -> **pct20**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct20**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2100](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2100) +Defined in: [Developer/brk/modules/brk-client/index.js:1636](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1636) *** ### pct25 -> **pct25**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct25**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2101](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2101) +Defined in: [Developer/brk/modules/brk-client/index.js:1637](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1637) *** ### pct30 -> **pct30**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct30**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2102](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2102) +Defined in: [Developer/brk/modules/brk-client/index.js:1638](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1638) *** ### pct35 -> **pct35**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct35**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2103](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2103) +Defined in: [Developer/brk/modules/brk-client/index.js:1639](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1639) *** ### pct40 -> **pct40**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct40**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2104](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2104) +Defined in: [Developer/brk/modules/brk-client/index.js:1640](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1640) *** ### pct45 -> **pct45**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct45**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2105](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2105) +Defined in: [Developer/brk/modules/brk-client/index.js:1641](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1641) *** ### pct50 -> **pct50**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct50**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2106](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2106) +Defined in: [Developer/brk/modules/brk-client/index.js:1642](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1642) *** ### pct55 -> **pct55**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct55**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2107](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2107) +Defined in: [Developer/brk/modules/brk-client/index.js:1643](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1643) *** ### pct60 -> **pct60**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct60**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2108](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2108) +Defined in: [Developer/brk/modules/brk-client/index.js:1644](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1644) *** ### pct65 -> **pct65**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct65**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2109](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2109) +Defined in: [Developer/brk/modules/brk-client/index.js:1645](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1645) *** ### pct70 -> **pct70**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct70**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2110](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2110) +Defined in: [Developer/brk/modules/brk-client/index.js:1646](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1646) *** ### pct75 -> **pct75**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct75**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2111](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2111) +Defined in: [Developer/brk/modules/brk-client/index.js:1647](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1647) *** ### pct80 -> **pct80**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct80**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2112](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2112) +Defined in: [Developer/brk/modules/brk-client/index.js:1648](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1648) *** ### pct85 -> **pct85**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct85**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2113](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2113) +Defined in: [Developer/brk/modules/brk-client/index.js:1649](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1649) *** ### pct90 -> **pct90**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct90**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2114](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2114) +Defined in: [Developer/brk/modules/brk-client/index.js:1650](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1650) *** ### pct95 -> **pct95**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **pct95**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2115](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2115) +Defined in: [Developer/brk/modules/brk-client/index.js:1651](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1651) diff --git a/modules/brk-client/docs/interfaces/Pct1Pct2Pct5Pct95Pct98Pct99Pattern.md b/modules/brk-client/docs/interfaces/Pct1Pct2Pct5Pct95Pct98Pct99Pattern.md new file mode 100644 index 000000000..bc001f584 --- /dev/null +++ b/modules/brk-client/docs/interfaces/Pct1Pct2Pct5Pct95Pct98Pct99Pattern.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Pct1Pct2Pct5Pct95Pct98Pct99Pattern + +# Interface: Pct1Pct2Pct5Pct95Pct98Pct99Pattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2377](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2377) + +## Properties + +### pct1 + +> **pct1**: [`BpsPriceRatioPattern`](BpsPriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2378](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2378) + +*** + +### pct2 + +> **pct2**: [`BpsPriceRatioPattern`](BpsPriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2379](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2379) + +*** + +### pct5 + +> **pct5**: [`BpsPriceRatioPattern`](BpsPriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2380](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2380) + +*** + +### pct95 + +> **pct95**: [`BpsPriceRatioPattern`](BpsPriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2381](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2381) + +*** + +### pct98 + +> **pct98**: [`BpsPriceRatioPattern`](BpsPriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2382](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2382) + +*** + +### pct99 + +> **pct99**: [`BpsPriceRatioPattern`](BpsPriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2383](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2383) diff --git a/modules/brk-client/docs/interfaces/PerPattern.md b/modules/brk-client/docs/interfaces/PerPattern.md new file mode 100644 index 000000000..e507fb020 --- /dev/null +++ b/modules/brk-client/docs/interfaces/PerPattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / PerPattern + +# Interface: PerPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3983](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3983) + +## Properties + +### perCoin + +> **perCoin**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3984](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3984) + +*** + +### perDollar + +> **perDollar**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3985](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3985) diff --git a/modules/brk-client/docs/interfaces/PhsReboundThsPattern.md b/modules/brk-client/docs/interfaces/PhsReboundThsPattern.md new file mode 100644 index 000000000..bdd966b7a --- /dev/null +++ b/modules/brk-client/docs/interfaces/PhsReboundThsPattern.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / PhsReboundThsPattern + +# Interface: PhsReboundThsPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:2713](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2713) + +## Properties + +### phs + +> **phs**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2714](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2714) + +*** + +### phsMin + +> **phsMin**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2715](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2715) + +*** + +### rebound + +> **rebound**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2716](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2716) + +*** + +### ths + +> **ths**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2717](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2717) + +*** + +### thsMin + +> **thsMin**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2718](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L2718) diff --git a/modules/brk-client/docs/interfaces/PoolBlockCounts.md b/modules/brk-client/docs/interfaces/PoolBlockCounts.md index dc0e5ad6a..d6e0b1f19 100644 --- a/modules/brk-client/docs/interfaces/PoolBlockCounts.md +++ b/modules/brk-client/docs/interfaces/PoolBlockCounts.md @@ -6,7 +6,7 @@ # Interface: PoolBlockCounts -Defined in: [Developer/brk/modules/brk-client/index.js:555](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L555) +Defined in: [Developer/brk/modules/brk-client/index.js:576](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L576) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:555](https://github.com/b > **\_1w**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:558](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L558) +Defined in: [Developer/brk/modules/brk-client/index.js:579](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L579) Blocks mined in last week @@ -24,7 +24,7 @@ Blocks mined in last week > **\_24h**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:557](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L557) +Defined in: [Developer/brk/modules/brk-client/index.js:578](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L578) Blocks mined in last 24 hours @@ -34,6 +34,6 @@ Blocks mined in last 24 hours > **all**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:556](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L556) +Defined in: [Developer/brk/modules/brk-client/index.js:577](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L577) Total blocks mined (all time) diff --git a/modules/brk-client/docs/interfaces/PoolBlockShares.md b/modules/brk-client/docs/interfaces/PoolBlockShares.md index 9bbd70a58..b0e1d15bb 100644 --- a/modules/brk-client/docs/interfaces/PoolBlockShares.md +++ b/modules/brk-client/docs/interfaces/PoolBlockShares.md @@ -6,7 +6,7 @@ # Interface: PoolBlockShares -Defined in: [Developer/brk/modules/brk-client/index.js:563](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L563) +Defined in: [Developer/brk/modules/brk-client/index.js:584](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L584) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:563](https://github.com/b > **\_1w**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:566](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L566) +Defined in: [Developer/brk/modules/brk-client/index.js:587](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L587) Share of blocks in last week @@ -24,7 +24,7 @@ Share of blocks in last week > **\_24h**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:565](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L565) +Defined in: [Developer/brk/modules/brk-client/index.js:586](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L586) Share of blocks in last 24 hours @@ -34,6 +34,6 @@ Share of blocks in last 24 hours > **all**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:564](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L564) +Defined in: [Developer/brk/modules/brk-client/index.js:585](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L585) Share of all blocks (0.0 - 1.0) diff --git a/modules/brk-client/docs/interfaces/PoolDetail.md b/modules/brk-client/docs/interfaces/PoolDetail.md index 3c0a5cb20..03377bc97 100644 --- a/modules/brk-client/docs/interfaces/PoolDetail.md +++ b/modules/brk-client/docs/interfaces/PoolDetail.md @@ -6,7 +6,7 @@ # Interface: PoolDetail -Defined in: [Developer/brk/modules/brk-client/index.js:571](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L571) +Defined in: [Developer/brk/modules/brk-client/index.js:592](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L592) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:571](https://github.com/b > **blockCount**: [`PoolBlockCounts`](PoolBlockCounts.md) -Defined in: [Developer/brk/modules/brk-client/index.js:573](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L573) +Defined in: [Developer/brk/modules/brk-client/index.js:594](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L594) Block counts for different time periods @@ -24,7 +24,7 @@ Block counts for different time periods > **blockShare**: [`PoolBlockShares`](PoolBlockShares.md) -Defined in: [Developer/brk/modules/brk-client/index.js:574](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L574) +Defined in: [Developer/brk/modules/brk-client/index.js:595](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L595) Pool's share of total blocks for different time periods @@ -34,7 +34,7 @@ Pool's share of total blocks for different time periods > **estimatedHashrate**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:575](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L575) +Defined in: [Developer/brk/modules/brk-client/index.js:596](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L596) Estimated hashrate based on blocks mined @@ -44,7 +44,7 @@ Estimated hashrate based on blocks mined > **pool**: [`PoolDetailInfo`](PoolDetailInfo.md) -Defined in: [Developer/brk/modules/brk-client/index.js:572](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L572) +Defined in: [Developer/brk/modules/brk-client/index.js:593](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L593) Pool information @@ -52,8 +52,8 @@ Pool information ### reportedHashrate? -> `optional` **reportedHashrate**: `number` \| `null` +> `optional` **reportedHashrate?**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:576](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L576) +Defined in: [Developer/brk/modules/brk-client/index.js:597](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L597) Self-reported hashrate (if available) diff --git a/modules/brk-client/docs/interfaces/PoolDetailInfo.md b/modules/brk-client/docs/interfaces/PoolDetailInfo.md index 5e8153357..f7b88c27f 100644 --- a/modules/brk-client/docs/interfaces/PoolDetailInfo.md +++ b/modules/brk-client/docs/interfaces/PoolDetailInfo.md @@ -6,15 +6,15 @@ # Interface: PoolDetailInfo -Defined in: [Developer/brk/modules/brk-client/index.js:581](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L581) +Defined in: [Developer/brk/modules/brk-client/index.js:602](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L602) ## Properties -### addresses +### addrs -> **addresses**: `string`[] +> **addrs**: `string`[] -Defined in: [Developer/brk/modules/brk-client/index.js:585](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L585) +Defined in: [Developer/brk/modules/brk-client/index.js:606](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L606) Known payout addresses @@ -24,7 +24,7 @@ Known payout addresses > **id**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:582](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L582) +Defined in: [Developer/brk/modules/brk-client/index.js:603](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L603) Unique pool identifier @@ -34,7 +34,7 @@ Unique pool identifier > **link**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:584](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L584) +Defined in: [Developer/brk/modules/brk-client/index.js:605](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L605) Pool website URL @@ -44,7 +44,7 @@ Pool website URL > **name**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:583](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L583) +Defined in: [Developer/brk/modules/brk-client/index.js:604](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L604) Pool name @@ -54,7 +54,7 @@ Pool name > **regexes**: `string`[] -Defined in: [Developer/brk/modules/brk-client/index.js:586](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L586) +Defined in: [Developer/brk/modules/brk-client/index.js:607](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L607) Coinbase tag patterns (regexes) @@ -64,6 +64,6 @@ Coinbase tag patterns (regexes) > **slug**: [`PoolSlug`](../type-aliases/PoolSlug.md) -Defined in: [Developer/brk/modules/brk-client/index.js:587](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L587) +Defined in: [Developer/brk/modules/brk-client/index.js:608](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L608) URL-friendly pool identifier diff --git a/modules/brk-client/docs/interfaces/PoolInfo.md b/modules/brk-client/docs/interfaces/PoolInfo.md index 3e2448e7c..a43e66a0b 100644 --- a/modules/brk-client/docs/interfaces/PoolInfo.md +++ b/modules/brk-client/docs/interfaces/PoolInfo.md @@ -6,7 +6,7 @@ # Interface: PoolInfo -Defined in: [Developer/brk/modules/brk-client/index.js:592](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L592) +Defined in: [Developer/brk/modules/brk-client/index.js:613](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L613) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:592](https://github.com/b > **name**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:593](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L593) +Defined in: [Developer/brk/modules/brk-client/index.js:614](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L614) Pool name @@ -24,7 +24,7 @@ Pool name > **slug**: [`PoolSlug`](../type-aliases/PoolSlug.md) -Defined in: [Developer/brk/modules/brk-client/index.js:594](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L594) +Defined in: [Developer/brk/modules/brk-client/index.js:615](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L615) URL-friendly pool identifier @@ -34,6 +34,6 @@ URL-friendly pool identifier > **uniqueId**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:595](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L595) +Defined in: [Developer/brk/modules/brk-client/index.js:616](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L616) Unique numeric pool identifier diff --git a/modules/brk-client/docs/interfaces/PoolSlugParam.md b/modules/brk-client/docs/interfaces/PoolSlugParam.md index 10cad5d8a..3c1896d72 100644 --- a/modules/brk-client/docs/interfaces/PoolSlugParam.md +++ b/modules/brk-client/docs/interfaces/PoolSlugParam.md @@ -6,7 +6,7 @@ # Interface: PoolSlugParam -Defined in: [Developer/brk/modules/brk-client/index.js:599](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L599) +Defined in: [Developer/brk/modules/brk-client/index.js:620](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L620) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:599](https://github.com/b > **slug**: [`PoolSlug`](../type-aliases/PoolSlug.md) -Defined in: [Developer/brk/modules/brk-client/index.js:600](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L600) +Defined in: [Developer/brk/modules/brk-client/index.js:621](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L621) diff --git a/modules/brk-client/docs/interfaces/PoolStats.md b/modules/brk-client/docs/interfaces/PoolStats.md index 345d2e641..6d1f995a7 100644 --- a/modules/brk-client/docs/interfaces/PoolStats.md +++ b/modules/brk-client/docs/interfaces/PoolStats.md @@ -6,7 +6,7 @@ # Interface: PoolStats -Defined in: [Developer/brk/modules/brk-client/index.js:605](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L605) +Defined in: [Developer/brk/modules/brk-client/index.js:626](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L626) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:605](https://github.com/b > **blockCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:609](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L609) +Defined in: [Developer/brk/modules/brk-client/index.js:630](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L630) Number of blocks mined in the time period @@ -24,7 +24,7 @@ Number of blocks mined in the time period > **emptyBlocks**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:611](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L611) +Defined in: [Developer/brk/modules/brk-client/index.js:632](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L632) Number of empty blocks mined @@ -34,7 +34,7 @@ Number of empty blocks mined > **link**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:608](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L608) +Defined in: [Developer/brk/modules/brk-client/index.js:629](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L629) Pool website URL @@ -44,7 +44,7 @@ Pool website URL > **name**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:607](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L607) +Defined in: [Developer/brk/modules/brk-client/index.js:628](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L628) Pool name @@ -54,7 +54,7 @@ Pool name > **poolId**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:606](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L606) +Defined in: [Developer/brk/modules/brk-client/index.js:627](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L627) Unique pool identifier @@ -64,7 +64,7 @@ Unique pool identifier > **rank**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:610](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L610) +Defined in: [Developer/brk/modules/brk-client/index.js:631](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L631) Pool ranking by block count (1 = most blocks) @@ -74,7 +74,7 @@ Pool ranking by block count (1 = most blocks) > **share**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:613](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L613) +Defined in: [Developer/brk/modules/brk-client/index.js:634](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L634) Pool's share of total blocks (0.0 - 1.0) @@ -84,6 +84,6 @@ Pool's share of total blocks (0.0 - 1.0) > **slug**: [`PoolSlug`](../type-aliases/PoolSlug.md) -Defined in: [Developer/brk/modules/brk-client/index.js:612](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L612) +Defined in: [Developer/brk/modules/brk-client/index.js:633](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L633) URL-friendly pool identifier diff --git a/modules/brk-client/docs/interfaces/PoolsSummary.md b/modules/brk-client/docs/interfaces/PoolsSummary.md index c52f42c92..a8a494d77 100644 --- a/modules/brk-client/docs/interfaces/PoolsSummary.md +++ b/modules/brk-client/docs/interfaces/PoolsSummary.md @@ -6,7 +6,7 @@ # Interface: PoolsSummary -Defined in: [Developer/brk/modules/brk-client/index.js:618](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L618) +Defined in: [Developer/brk/modules/brk-client/index.js:639](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L639) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:618](https://github.com/b > **blockCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:620](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L620) +Defined in: [Developer/brk/modules/brk-client/index.js:641](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L641) Total blocks in the time period @@ -24,7 +24,7 @@ Total blocks in the time period > **lastEstimatedHashrate**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:621](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L621) +Defined in: [Developer/brk/modules/brk-client/index.js:642](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L642) Estimated network hashrate (hashes per second) @@ -34,6 +34,6 @@ Estimated network hashrate (hashes per second) > **pools**: [`PoolStats`](PoolStats.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:619](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L619) +Defined in: [Developer/brk/modules/brk-client/index.js:640](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L640) List of pools sorted by block count descending diff --git a/modules/brk-client/docs/interfaces/PricePattern.md b/modules/brk-client/docs/interfaces/PricePattern.md new file mode 100644 index 000000000..b2c01801f --- /dev/null +++ b/modules/brk-client/docs/interfaces/PricePattern.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / PricePattern + +# Interface: PricePattern + +Defined in: [Developer/brk/modules/brk-client/index.js:4100](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4100) + +## Properties + +### price + +> **price**: [`BpsCentsPercentilesRatioSatsUsdPattern`](BpsCentsPercentilesRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4101](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4101) diff --git a/modules/brk-client/docs/interfaces/PriceRatioPattern.md b/modules/brk-client/docs/interfaces/PriceRatioPattern.md index 397e324fe..d2252a722 100644 --- a/modules/brk-client/docs/interfaces/PriceRatioPattern.md +++ b/modules/brk-client/docs/interfaces/PriceRatioPattern.md @@ -6,164 +6,20 @@ # Interface: PriceRatioPattern -Defined in: [Developer/brk/modules/brk-client/index.js:2041](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2041) +Defined in: [Developer/brk/modules/brk-client/index.js:4002](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4002) ## Properties ### price -> **price**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) +> **price**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2042](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2042) +Defined in: [Developer/brk/modules/brk-client/index.js:4003](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4003) *** ### ratio -> **ratio**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2043](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2043) - -*** - -### ratio1mSma - -> **ratio1mSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2044](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2044) - -*** - -### ratio1wSma - -> **ratio1wSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2045](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2045) - -*** - -### ratio1ySd - -> **ratio1ySd**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2046](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2046) - -*** - -### ratio2ySd - -> **ratio2ySd**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2047](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2047) - -*** - -### ratio4ySd - -> **ratio4ySd**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2048](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2048) - -*** - -### ratioPct1 - -> **ratioPct1**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2049](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2049) - -*** - -### ratioPct1Usd - -> **ratioPct1Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2050](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2050) - -*** - -### ratioPct2 - -> **ratioPct2**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2051](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2051) - -*** - -### ratioPct2Usd - -> **ratioPct2Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2052](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2052) - -*** - -### ratioPct5 - -> **ratioPct5**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2053](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2053) - -*** - -### ratioPct5Usd - -> **ratioPct5Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2054](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2054) - -*** - -### ratioPct95 - -> **ratioPct95**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2055](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2055) - -*** - -### ratioPct95Usd - -> **ratioPct95Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2056](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2056) - -*** - -### ratioPct98 - -> **ratioPct98**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2057](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2057) - -*** - -### ratioPct98Usd - -> **ratioPct98Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2058](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2058) - -*** - -### ratioPct99 - -> **ratioPct99**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2059](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2059) - -*** - -### ratioPct99Usd - -> **ratioPct99Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2060](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2060) - -*** - -### ratioSd - -> **ratioSd**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2061](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2061) +Defined in: [Developer/brk/modules/brk-client/index.js:4004](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4004) diff --git a/modules/brk-client/docs/interfaces/RangeBuilder.md b/modules/brk-client/docs/interfaces/RangeBuilder.md index 94833c479..423d4cd1b 100644 --- a/modules/brk-client/docs/interfaces/RangeBuilder.md +++ b/modules/brk-client/docs/interfaces/RangeBuilder.md @@ -6,7 +6,7 @@ # Interface: RangeBuilder\ -Defined in: [Developer/brk/modules/brk-client/index.js:1062](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1062) +Defined in: [Developer/brk/modules/brk-client/index.js:1231](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1231) ## Type Parameters @@ -16,11 +16,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1062](https://github.com/ ## Properties -### fetch() +### fetch -> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> +> **fetch**: (`onUpdate?`) => `Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\> -Defined in: [Developer/brk/modules/brk-client/index.js:1063](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1063) +Defined in: [Developer/brk/modules/brk-client/index.js:1232](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1232) Fetch the range @@ -32,15 +32,15 @@ Fetch the range #### Returns -`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> +`Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\> *** -### fetchCsv() +### fetchCsv > **fetchCsv**: () => `Promise`\<`string`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1064](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1064) +Defined in: [Developer/brk/modules/brk-client/index.js:1233](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1233) Fetch as CSV @@ -54,6 +54,6 @@ Fetch as CSV > **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1065](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1065) +Defined in: [Developer/brk/modules/brk-client/index.js:1234](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1234) Thenable diff --git a/modules/brk-client/docs/interfaces/RatioPattern.md b/modules/brk-client/docs/interfaces/RatioPattern.md deleted file mode 100644 index a51439a7c..000000000 --- a/modules/brk-client/docs/interfaces/RatioPattern.md +++ /dev/null @@ -1,161 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / RatioPattern - -# Interface: RatioPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:2149](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2149) - -## Properties - -### ratio - -> **ratio**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2150](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2150) - -*** - -### ratio1mSma - -> **ratio1mSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2151](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2151) - -*** - -### ratio1wSma - -> **ratio1wSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2152](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2152) - -*** - -### ratio1ySd - -> **ratio1ySd**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2153](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2153) - -*** - -### ratio2ySd - -> **ratio2ySd**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2154](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2154) - -*** - -### ratio4ySd - -> **ratio4ySd**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2155](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2155) - -*** - -### ratioPct1 - -> **ratioPct1**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2156](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2156) - -*** - -### ratioPct1Usd - -> **ratioPct1Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2157](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2157) - -*** - -### ratioPct2 - -> **ratioPct2**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2158](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2158) - -*** - -### ratioPct2Usd - -> **ratioPct2Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2159](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2159) - -*** - -### ratioPct5 - -> **ratioPct5**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2160](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2160) - -*** - -### ratioPct5Usd - -> **ratioPct5Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2161](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2161) - -*** - -### ratioPct95 - -> **ratioPct95**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2162](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2162) - -*** - -### ratioPct95Usd - -> **ratioPct95Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2163](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2163) - -*** - -### ratioPct98 - -> **ratioPct98**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2164](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2164) - -*** - -### ratioPct98Usd - -> **ratioPct98Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2165](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2165) - -*** - -### ratioPct99 - -> **ratioPct99**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2166](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2166) - -*** - -### ratioPct99Usd - -> **ratioPct99Usd**: [`DollarsSatsPattern2`](DollarsSatsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2167](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2167) - -*** - -### ratioSd - -> **ratioSd**: [`_0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern`](0sdM0M1M1sdM2M2sdM3sdP0P1P1sdP2P2sdP3sdSdSmaZscorePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:2168](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L2168) diff --git a/modules/brk-client/docs/interfaces/RatioPattern2.md b/modules/brk-client/docs/interfaces/RatioPattern2.md deleted file mode 100644 index 177a8e625..000000000 --- a/modules/brk-client/docs/interfaces/RatioPattern2.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / RatioPattern2 - -# Interface: RatioPattern2 - -Defined in: [Developer/brk/modules/brk-client/index.js:3486](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3486) - -## Properties - -### ratio - -> **ratio**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3487](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3487) diff --git a/modules/brk-client/docs/interfaces/RatioTransferValuePattern.md b/modules/brk-client/docs/interfaces/RatioTransferValuePattern.md new file mode 100644 index 000000000..65aa8dd0a --- /dev/null +++ b/modules/brk-client/docs/interfaces/RatioTransferValuePattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / RatioTransferValuePattern + +# Interface: RatioTransferValuePattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3572](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3572) + +## Properties + +### ratio + +> **ratio**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3573](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3573) + +*** + +### transferVolume + +> **transferVolume**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3574](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3574) + +*** + +### valueDestroyed + +> **valueDestroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3575](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3575) diff --git a/modules/brk-client/docs/interfaces/RatioValuePattern.md b/modules/brk-client/docs/interfaces/RatioValuePattern.md new file mode 100644 index 000000000..ed955edad --- /dev/null +++ b/modules/brk-client/docs/interfaces/RatioValuePattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / RatioValuePattern + +# Interface: RatioValuePattern + +Defined in: [Developer/brk/modules/brk-client/index.js:4022](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4022) + +## Properties + +### ratio + +> **ratio**: [`_24hPattern`](24hPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4023](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4023) + +*** + +### valueDestroyed + +> **valueDestroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4024](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4024) diff --git a/modules/brk-client/docs/interfaces/RecommendedFees.md b/modules/brk-client/docs/interfaces/RecommendedFees.md index 0cf786e68..80d300832 100644 --- a/modules/brk-client/docs/interfaces/RecommendedFees.md +++ b/modules/brk-client/docs/interfaces/RecommendedFees.md @@ -6,7 +6,7 @@ # Interface: RecommendedFees -Defined in: [Developer/brk/modules/brk-client/index.js:632](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L632) +Defined in: [Developer/brk/modules/brk-client/index.js:657](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L657) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:632](https://github.com/b > **economyFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:636](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L636) +Defined in: [Developer/brk/modules/brk-client/index.js:661](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L661) Fee rate for economical confirmation @@ -24,7 +24,7 @@ Fee rate for economical confirmation > **fastestFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:633](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L633) +Defined in: [Developer/brk/modules/brk-client/index.js:658](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L658) Fee rate for fastest confirmation (next block) @@ -34,7 +34,7 @@ Fee rate for fastest confirmation (next block) > **halfHourFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:634](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L634) +Defined in: [Developer/brk/modules/brk-client/index.js:659](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L659) Fee rate for confirmation within ~30 minutes (3 blocks) @@ -44,7 +44,7 @@ Fee rate for confirmation within ~30 minutes (3 blocks) > **hourFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:635](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L635) +Defined in: [Developer/brk/modules/brk-client/index.js:660](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L660) Fee rate for confirmation within ~1 hour (6 blocks) @@ -54,6 +54,6 @@ Fee rate for confirmation within ~1 hour (6 blocks) > **minimumFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:637](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L637) +Defined in: [Developer/brk/modules/brk-client/index.js:662](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L662) Minimum relay fee rate diff --git a/modules/brk-client/docs/interfaces/RewardStats.md b/modules/brk-client/docs/interfaces/RewardStats.md index 8a212264c..3a88a2016 100644 --- a/modules/brk-client/docs/interfaces/RewardStats.md +++ b/modules/brk-client/docs/interfaces/RewardStats.md @@ -6,7 +6,7 @@ # Interface: RewardStats -Defined in: [Developer/brk/modules/brk-client/index.js:642](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L642) +Defined in: [Developer/brk/modules/brk-client/index.js:667](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L667) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:642](https://github.com/b > **endBlock**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:644](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L644) +Defined in: [Developer/brk/modules/brk-client/index.js:669](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L669) Last block in the range @@ -24,7 +24,7 @@ Last block in the range > **startBlock**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:643](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L643) +Defined in: [Developer/brk/modules/brk-client/index.js:668](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L668) First block in the range @@ -34,7 +34,7 @@ First block in the range > **totalFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:646](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L646) +Defined in: [Developer/brk/modules/brk-client/index.js:671](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L671) *** @@ -42,7 +42,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:646](https://github.com/b > **totalReward**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:645](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L645) +Defined in: [Developer/brk/modules/brk-client/index.js:670](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L670) *** @@ -50,4 +50,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:645](https://github.com/b > **totalTx**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:647](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L647) +Defined in: [Developer/brk/modules/brk-client/index.js:672](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L672) diff --git a/modules/brk-client/docs/interfaces/RsiStochPattern.md b/modules/brk-client/docs/interfaces/RsiStochPattern.md new file mode 100644 index 000000000..01e482cd5 --- /dev/null +++ b/modules/brk-client/docs/interfaces/RsiStochPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / RsiStochPattern + +# Interface: RsiStochPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3593](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3593) + +## Properties + +### rsi + +> **rsi**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3594](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3594) + +*** + +### stochRsiD + +> **stochRsiD**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3595](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3595) + +*** + +### stochRsiK + +> **stochRsiK**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3596](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3596) diff --git a/modules/brk-client/docs/interfaces/SdSmaPattern.md b/modules/brk-client/docs/interfaces/SdSmaPattern.md index 3e810d6a5..375f88180 100644 --- a/modules/brk-client/docs/interfaces/SdSmaPattern.md +++ b/modules/brk-client/docs/interfaces/SdSmaPattern.md @@ -6,20 +6,20 @@ # Interface: SdSmaPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3385](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3385) +Defined in: [Developer/brk/modules/brk-client/index.js:4041](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4041) ## Properties ### sd -> **sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3386](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3386) +Defined in: [Developer/brk/modules/brk-client/index.js:4042](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4042) *** ### sma -> **sma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **sma**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3387](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3387) +Defined in: [Developer/brk/modules/brk-client/index.js:4043](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4043) diff --git a/modules/brk-client/docs/interfaces/SearchQuery.md b/modules/brk-client/docs/interfaces/SearchQuery.md new file mode 100644 index 000000000..ef2145964 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SearchQuery.md @@ -0,0 +1,29 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SearchQuery + +# Interface: SearchQuery + +Defined in: [Developer/brk/modules/brk-client/index.js:698](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L698) + +## Properties + +### limit? + +> `optional` **limit?**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:700](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L700) + +Maximum number of results + +*** + +### q + +> **q**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:699](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L699) + +Search query string diff --git a/modules/brk-client/docs/interfaces/SeriesCount.md b/modules/brk-client/docs/interfaces/SeriesCount.md new file mode 100644 index 000000000..f88fcf375 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesCount.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesCount + +# Interface: SeriesCount + +Defined in: [Developer/brk/modules/brk-client/index.js:705](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L705) + +## Properties + +### distinctSeries + +> **distinctSeries**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:706](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L706) + +Number of unique series available (e.g., realized_price, market_cap) + +*** + +### lazyEndpoints + +> **lazyEndpoints**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:708](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L708) + +Number of lazy (computed on-the-fly) series-index combinations + +*** + +### storedEndpoints + +> **storedEndpoints**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:709](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L709) + +Number of eager (stored on disk) series-index combinations + +*** + +### totalEndpoints + +> **totalEndpoints**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:707](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L707) + +Total number of series-index combinations across all timeframes diff --git a/modules/brk-client/docs/interfaces/SeriesDataBase.md b/modules/brk-client/docs/interfaces/SeriesDataBase.md new file mode 100644 index 000000000..439f1196d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesDataBase.md @@ -0,0 +1,161 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesDataBase + +# Interface: SeriesDataBase\ + +Defined in: [Developer/brk/modules/brk-client/index.js:1143](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1143) + +## Type Parameters + +### T + +`T` + +## Properties + +### data + +> **data**: `T`[] + +Defined in: [Developer/brk/modules/brk-client/index.js:1151](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1151) + +The series data + +*** + +### end + +> **end**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:1149](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1149) + +End index (exclusive) + +*** + +### entries + +> **entries**: () => \[`number`, `T`\][] + +Defined in: [Developer/brk/modules/brk-client/index.js:1155](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1155) + +Get [index, value] pairs + +#### Returns + +\[`number`, `T`\][] + +*** + +### index + +> **index**: [`Index`](../type-aliases/Index.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:1145](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1145) + +The index type used for this query + +*** + +### indexes + +> **indexes**: () => `number`[] + +Defined in: [Developer/brk/modules/brk-client/index.js:1153](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1153) + +Get index numbers + +#### Returns + +`number`[] + +*** + +### isDateBased + +> **isDateBased**: `boolean` + +Defined in: [Developer/brk/modules/brk-client/index.js:1152](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1152) + +Whether this series uses a date-based index + +*** + +### keys + +> **keys**: () => `number`[] + +Defined in: [Developer/brk/modules/brk-client/index.js:1154](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1154) + +Get keys as index numbers (alias for indexes) + +#### Returns + +`number`[] + +*** + +### stamp + +> **stamp**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:1150](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1150) + +ISO 8601 timestamp of when the response was generated + +*** + +### start + +> **start**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:1148](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1148) + +Start index (inclusive) + +*** + +### toMap + +> **toMap**: () => `Map`\<`number`, `T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1156](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1156) + +Convert to Map + +#### Returns + +`Map`\<`number`, `T`\> + +*** + +### total + +> **total**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:1147](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1147) + +Total number of data points + +*** + +### type + +> **type**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:1146](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1146) + +Value type (e.g. "f32", "u64", "Sats") + +*** + +### version + +> **version**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:1144](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1144) + +Version of the series data diff --git a/modules/brk-client/docs/interfaces/SeriesEndpoint.md b/modules/brk-client/docs/interfaces/SeriesEndpoint.md new file mode 100644 index 000000000..438283dba --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesEndpoint.md @@ -0,0 +1,173 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesEndpoint + +# Interface: SeriesEndpoint\ + +Defined in: [Developer/brk/modules/brk-client/index.js:1177](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1177) + +## Type Parameters + +### T + +`T` + +## Properties + +### fetch + +> **fetch**: (`onUpdate?`) => `Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1183](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1183) + +Fetch all data + +#### Parameters + +##### onUpdate? + +(`value`) => `void` + +#### Returns + +`Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\> + +*** + +### fetchCsv + +> **fetchCsv**: () => `Promise`\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1184](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1184) + +Fetch all data as CSV + +#### Returns + +`Promise`\<`string`\> + +*** + +### first + +> **first**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1180](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1180) + +Get first n items + +#### Parameters + +##### n + +`number` + +#### Returns + +[`RangeBuilder`](RangeBuilder.md)\<`T`\> + +*** + +### get + +> **get**: (`index`) => [`SingleItemBuilder`](SingleItemBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1178](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1178) + +Get single item at index + +#### Parameters + +##### index + +`number` + +#### Returns + +[`SingleItemBuilder`](SingleItemBuilder.md)\<`T`\> + +*** + +### last + +> **last**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1181](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1181) + +Get last n items + +#### Parameters + +##### n + +`number` + +#### Returns + +[`RangeBuilder`](RangeBuilder.md)\<`T`\> + +*** + +### path + +> **path**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:1186](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1186) + +The endpoint path + +*** + +### skip + +> **skip**: (`n`) => [`SkippedBuilder`](SkippedBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1182](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1182) + +Skip first n items, chain with take() + +#### Parameters + +##### n + +`number` + +#### Returns + +[`SkippedBuilder`](SkippedBuilder.md)\<`T`\> + +*** + +### slice + +> **slice**: (`start?`, `end?`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1179](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1179) + +Slice by index + +#### Parameters + +##### start? + +`number` + +##### end? + +`number` + +#### Returns + +[`RangeBuilder`](RangeBuilder.md)\<`T`\> + +*** + +### then + +> **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1185](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1185) + +Thenable (await endpoint) diff --git a/modules/brk-client/docs/interfaces/SeriesInfo.md b/modules/brk-client/docs/interfaces/SeriesInfo.md new file mode 100644 index 000000000..9732e424b --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesInfo.md @@ -0,0 +1,29 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesInfo + +# Interface: SeriesInfo + +Defined in: [Developer/brk/modules/brk-client/index.js:714](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L714) + +## Properties + +### indexes + +> **indexes**: [`Index`](../type-aliases/Index.md)[] + +Defined in: [Developer/brk/modules/brk-client/index.js:715](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L715) + +Available indexes + +*** + +### type + +> **type**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:716](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L716) + +Value type (e.g. "f32", "u64", "Sats") diff --git a/modules/brk-client/docs/interfaces/SeriesLeafWithSchema.md b/modules/brk-client/docs/interfaces/SeriesLeafWithSchema.md new file mode 100644 index 000000000..b6ba1aab1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesLeafWithSchema.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesLeafWithSchema + +# Interface: SeriesLeafWithSchema + +Defined in: [Developer/brk/modules/brk-client/index.js:721](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L721) + +## Properties + +### indexes + +> **indexes**: [`Index`](../type-aliases/Index.md)[] + +Defined in: [Developer/brk/modules/brk-client/index.js:724](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L724) + +Available indexes for this series + +*** + +### kind + +> **kind**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:723](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L723) + +The Rust type (e.g., "Sats", "StoredF64") + +*** + +### name + +> **name**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:722](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L722) + +The series name/identifier + +*** + +### type + +> **type**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:725](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L725) + +JSON Schema type (e.g., "integer", "number", "string", "boolean", "array", "object") diff --git a/modules/brk-client/docs/interfaces/SeriesNameWithIndex.md b/modules/brk-client/docs/interfaces/SeriesNameWithIndex.md new file mode 100644 index 000000000..1e4ebbe9d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesNameWithIndex.md @@ -0,0 +1,29 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesNameWithIndex + +# Interface: SeriesNameWithIndex + +Defined in: [Developer/brk/modules/brk-client/index.js:738](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L738) + +## Properties + +### index + +> **index**: [`Index`](../type-aliases/Index.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:740](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L740) + +Aggregation index + +*** + +### series + +> **series**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:739](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L739) + +Series name diff --git a/modules/brk-client/docs/interfaces/SeriesParam.md b/modules/brk-client/docs/interfaces/SeriesParam.md new file mode 100644 index 000000000..e64e0b436 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesParam.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesParam + +# Interface: SeriesParam + +Defined in: [Developer/brk/modules/brk-client/index.js:743](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L743) + +## Properties + +### series + +> **series**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:744](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L744) diff --git a/modules/brk-client/docs/interfaces/SeriesPattern.md b/modules/brk-client/docs/interfaces/SeriesPattern.md new file mode 100644 index 000000000..3613c188b --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesPattern.md @@ -0,0 +1,69 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern + +# Interface: SeriesPattern\ + +Defined in: [Developer/brk/modules/brk-client/index.js:1245](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1245) + +## Type Parameters + +### T + +`T` + +## Properties + +### by + +> **by**: `Readonly`\<`Partial`\<`Record`\<[`Index`](../type-aliases/Index.md), [`SeriesEndpoint`](SeriesEndpoint.md)\<`T`\>\>\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1247](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1247) + +Index endpoints as lazy getters + +*** + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](SeriesEndpoint.md)\<`T`\> \| `undefined` + +Defined in: [Developer/brk/modules/brk-client/index.js:1249](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1249) + +Get an endpoint for a specific index + +#### Parameters + +##### index + +[`Index`](../type-aliases/Index.md) + +#### Returns + +[`SeriesEndpoint`](SeriesEndpoint.md)\<`T`\> \| `undefined` + +*** + +### indexes + +> **indexes**: () => readonly [`Index`](../type-aliases/Index.md)[] + +Defined in: [Developer/brk/modules/brk-client/index.js:1248](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1248) + +Get the list of available indexes + +#### Returns + +readonly [`Index`](../type-aliases/Index.md)[] + +*** + +### name + +> **name**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:1246](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1246) + +The series name diff --git a/modules/brk-client/docs/interfaces/SeriesSelection.md b/modules/brk-client/docs/interfaces/SeriesSelection.md new file mode 100644 index 000000000..fe5943e17 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesSelection.md @@ -0,0 +1,69 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesSelection + +# Interface: SeriesSelection + +Defined in: [Developer/brk/modules/brk-client/index.js:749](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L749) + +## Properties + +### end? + +> `optional` **end?**: `number` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:753](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L753) + +Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `to`, `t`, `e` + +*** + +### format? + +> `optional` **format?**: [`Format`](../type-aliases/Format.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:755](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L755) + +Format of the output + +*** + +### index + +> **index**: [`Index`](../type-aliases/Index.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:751](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L751) + +Index to query + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:754](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L754) + +Maximum number of values to return (ignored if `end` is set). Aliases: `count`, `c`, `l` + +*** + +### series + +> **series**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:750](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L750) + +Requested series + +*** + +### start? + +> `optional` **start?**: `number` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:752](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L752) + +Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s` diff --git a/modules/brk-client/docs/interfaces/SeriesSelectionLegacy.md b/modules/brk-client/docs/interfaces/SeriesSelectionLegacy.md new file mode 100644 index 000000000..ee2340828 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesSelectionLegacy.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesSelectionLegacy + +# Interface: SeriesSelectionLegacy + +Defined in: [Developer/brk/modules/brk-client/index.js:760](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L760) + +## Properties + +### end? + +> `optional` **end?**: `number` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:764](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L764) + +Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `to`, `t`, `e` + +*** + +### format? + +> `optional` **format?**: [`Format`](../type-aliases/Format.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:766](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L766) + +Format of the output + +*** + +### ids + +> **ids**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:762](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L762) + +*** + +### index + +> **index**: [`Index`](../type-aliases/Index.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:761](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L761) + +*** + +### limit? + +> `optional` **limit?**: `number` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:765](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L765) + +Maximum number of values to return (ignored if `end` is set). Aliases: `count`, `c`, `l` + +*** + +### start? + +> `optional` **start?**: `number` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:763](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L763) + +Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s` diff --git a/modules/brk-client/docs/interfaces/SeriesTree.md b/modules/brk-client/docs/interfaces/SeriesTree.md new file mode 100644 index 000000000..3613f46a9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree.md @@ -0,0 +1,145 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree + +# Interface: SeriesTree + +Defined in: [Developer/brk/modules/brk-client/index.js:4136](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4136) + +## Properties + +### addrs + +> **addrs**: [`SeriesTree_Addrs`](SeriesTree_Addrs.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4141](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4141) + +*** + +### blocks + +> **blocks**: [`SeriesTree_Blocks`](SeriesTree_Blocks.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4137](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4137) + +*** + +### cohorts + +> **cohorts**: [`SeriesTree_Cohorts`](SeriesTree_Cohorts.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4153](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4153) + +*** + +### cointime + +> **cointime**: [`SeriesTree_Cointime`](SeriesTree_Cointime.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4145](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4145) + +*** + +### constants + +> **constants**: [`SeriesTree_Constants`](SeriesTree_Constants.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4146](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4146) + +*** + +### indexes + +> **indexes**: [`SeriesTree_Indexes`](SeriesTree_Indexes.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4147](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4147) + +*** + +### indicators + +> **indicators**: [`SeriesTree_Indicators`](SeriesTree_Indicators.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4148](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4148) + +*** + +### inputs + +> **inputs**: [`SeriesTree_Inputs`](SeriesTree_Inputs.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4139](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4139) + +*** + +### market + +> **market**: [`SeriesTree_Market`](SeriesTree_Market.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4149](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4149) + +*** + +### mining + +> **mining**: [`SeriesTree_Mining`](SeriesTree_Mining.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4143](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4143) + +*** + +### outputs + +> **outputs**: [`SeriesTree_Outputs`](SeriesTree_Outputs.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4140](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4140) + +*** + +### pools + +> **pools**: [`SeriesTree_Pools`](SeriesTree_Pools.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4150](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4150) + +*** + +### positions + +> **positions**: `Object` + +Defined in: [Developer/brk/modules/brk-client/index.js:4144](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4144) + +*** + +### prices + +> **prices**: [`SeriesTree_Prices`](SeriesTree_Prices.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4151](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4151) + +*** + +### scripts + +> **scripts**: [`SeriesTree_Scripts`](SeriesTree_Scripts.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4142](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4142) + +*** + +### supply + +> **supply**: [`SeriesTree_Supply`](SeriesTree_Supply.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4152](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4152) + +*** + +### transactions + +> **transactions**: [`SeriesTree_Transactions`](SeriesTree_Transactions.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4138](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4138) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs.md new file mode 100644 index 000000000..be80bde66 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs + +# Interface: SeriesTree\_Addrs + +Defined in: [Developer/brk/modules/brk-client/index.js:4395](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4395) + +## Properties + +### activity + +> **activity**: [`SeriesTree_Addrs_Activity`](SeriesTree_Addrs_Activity.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4401](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4401) + +*** + +### data + +> **data**: [`SeriesTree_Addrs_Data`](SeriesTree_Addrs_Data.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4398](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4398) + +*** + +### delta + +> **delta**: [`SeriesTree_Addrs_Delta`](SeriesTree_Addrs_Delta.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4404](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4404) + +*** + +### empty + +> **empty**: [`AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3`](AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4400](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4400) + +*** + +### funded + +> **funded**: [`AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3`](AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4399](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4399) + +*** + +### indexes + +> **indexes**: [`SeriesTree_Addrs_Indexes`](SeriesTree_Addrs_Indexes.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4397](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4397) + +*** + +### new + +> **new**: [`SeriesTree_Addrs_New`](SeriesTree_Addrs_New.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4403](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4403) + +*** + +### raw + +> **raw**: [`SeriesTree_Addrs_Raw`](SeriesTree_Addrs_Raw.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4396](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4396) + +*** + +### total + +> **total**: [`AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3`](AllP2aP2pk33P2pk65P2pkhP2shP2trP2wpkhP2wshPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4402](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4402) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Activity.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Activity.md new file mode 100644 index 000000000..855459262 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Activity.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Activity + +# Interface: SeriesTree\_Addrs\_Activity + +Defined in: [Developer/brk/modules/brk-client/index.js:4488](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4488) + +## Properties + +### all + +> **all**: [`BothReactivatedReceivingSendingPattern`](BothReactivatedReceivingSendingPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4489](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4489) + +*** + +### p2a + +> **p2a**: [`BothReactivatedReceivingSendingPattern`](BothReactivatedReceivingSendingPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4497](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4497) + +*** + +### p2pk33 + +> **p2pk33**: [`BothReactivatedReceivingSendingPattern`](BothReactivatedReceivingSendingPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4491](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4491) + +*** + +### p2pk65 + +> **p2pk65**: [`BothReactivatedReceivingSendingPattern`](BothReactivatedReceivingSendingPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4490](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4490) + +*** + +### p2pkh + +> **p2pkh**: [`BothReactivatedReceivingSendingPattern`](BothReactivatedReceivingSendingPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4492](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4492) + +*** + +### p2sh + +> **p2sh**: [`BothReactivatedReceivingSendingPattern`](BothReactivatedReceivingSendingPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4493](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4493) + +*** + +### p2tr + +> **p2tr**: [`BothReactivatedReceivingSendingPattern`](BothReactivatedReceivingSendingPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4496](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4496) + +*** + +### p2wpkh + +> **p2wpkh**: [`BothReactivatedReceivingSendingPattern`](BothReactivatedReceivingSendingPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4494](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4494) + +*** + +### p2wsh + +> **p2wsh**: [`BothReactivatedReceivingSendingPattern`](BothReactivatedReceivingSendingPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4495](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4495) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Data.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Data.md new file mode 100644 index 000000000..fe7f31c03 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Data.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Data + +# Interface: SeriesTree\_Addrs\_Data + +Defined in: [Developer/brk/modules/brk-client/index.js:4482](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4482) + +## Properties + +### empty + +> **empty**: [`SeriesPattern35`](../type-aliases/SeriesPattern35.md)\<[`EmptyAddrData`](EmptyAddrData.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4484](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4484) + +*** + +### funded + +> **funded**: [`SeriesPattern34`](../type-aliases/SeriesPattern34.md)\<[`FundedAddrData`](FundedAddrData.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4483](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4483) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Delta.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Delta.md new file mode 100644 index 000000000..c7cc2bf17 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Delta.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Delta + +# Interface: SeriesTree\_Addrs\_Delta + +Defined in: [Developer/brk/modules/brk-client/index.js:4514](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4514) + +## Properties + +### all + +> **all**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4515](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4515) + +*** + +### p2a + +> **p2a**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4523](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4523) + +*** + +### p2pk33 + +> **p2pk33**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4517](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4517) + +*** + +### p2pk65 + +> **p2pk65**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4516](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4516) + +*** + +### p2pkh + +> **p2pkh**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4518](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4518) + +*** + +### p2sh + +> **p2sh**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4519](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4519) + +*** + +### p2tr + +> **p2tr**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4522](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4522) + +*** + +### p2wpkh + +> **p2wpkh**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4520](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4520) + +*** + +### p2wsh + +> **p2wsh**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4521](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4521) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Indexes.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Indexes.md new file mode 100644 index 000000000..a79eb88dc --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Indexes.md @@ -0,0 +1,89 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Indexes + +# Interface: SeriesTree\_Addrs\_Indexes + +Defined in: [Developer/brk/modules/brk-client/index.js:4468](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4468) + +## Properties + +### empty + +> **empty**: [`SeriesPattern35`](../type-aliases/SeriesPattern35.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4478](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4478) + +*** + +### funded + +> **funded**: [`SeriesPattern34`](../type-aliases/SeriesPattern34.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4477](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4477) + +*** + +### p2a + +> **p2a**: [`SeriesPattern24`](../type-aliases/SeriesPattern24.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4469](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4469) + +*** + +### p2pk33 + +> **p2pk33**: [`SeriesPattern26`](../type-aliases/SeriesPattern26.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4470](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4470) + +*** + +### p2pk65 + +> **p2pk65**: [`SeriesPattern27`](../type-aliases/SeriesPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4471](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4471) + +*** + +### p2pkh + +> **p2pkh**: [`SeriesPattern28`](../type-aliases/SeriesPattern28.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4472](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4472) + +*** + +### p2sh + +> **p2sh**: [`SeriesPattern29`](../type-aliases/SeriesPattern29.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4473](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4473) + +*** + +### p2tr + +> **p2tr**: [`SeriesPattern30`](../type-aliases/SeriesPattern30.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4474](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4474) + +*** + +### p2wpkh + +> **p2wpkh**: [`SeriesPattern31`](../type-aliases/SeriesPattern31.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4475](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4475) + +*** + +### p2wsh + +> **p2wsh**: [`SeriesPattern32`](../type-aliases/SeriesPattern32.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4476](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4476) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_New.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_New.md new file mode 100644 index 000000000..355392ce3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_New.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_New + +# Interface: SeriesTree\_Addrs\_New + +Defined in: [Developer/brk/modules/brk-client/index.js:4501](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4501) + +## Properties + +### all + +> **all**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4502](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4502) + +*** + +### p2a + +> **p2a**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4510](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4510) + +*** + +### p2pk33 + +> **p2pk33**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4504](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4504) + +*** + +### p2pk65 + +> **p2pk65**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4503](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4503) + +*** + +### p2pkh + +> **p2pkh**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4505](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4505) + +*** + +### p2sh + +> **p2sh**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4506](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4506) + +*** + +### p2tr + +> **p2tr**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4509](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4509) + +*** + +### p2wpkh + +> **p2wpkh**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4507](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4507) + +*** + +### p2wsh + +> **p2wsh**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4508](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4508) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw.md new file mode 100644 index 000000000..e20eee92b --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Raw + +# Interface: SeriesTree\_Addrs\_Raw + +Defined in: [Developer/brk/modules/brk-client/index.js:4408](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4408) + +## Properties + +### p2a + +> **p2a**: [`SeriesTree_Addrs_Raw_P2a`](SeriesTree_Addrs_Raw_P2a.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4416](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4416) + +*** + +### p2pk33 + +> **p2pk33**: [`SeriesTree_Addrs_Raw_P2pk33`](SeriesTree_Addrs_Raw_P2pk33.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4410](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4410) + +*** + +### p2pk65 + +> **p2pk65**: [`SeriesTree_Addrs_Raw_P2pk65`](SeriesTree_Addrs_Raw_P2pk65.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4409](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4409) + +*** + +### p2pkh + +> **p2pkh**: [`SeriesTree_Addrs_Raw_P2pkh`](SeriesTree_Addrs_Raw_P2pkh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4411](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4411) + +*** + +### p2sh + +> **p2sh**: [`SeriesTree_Addrs_Raw_P2sh`](SeriesTree_Addrs_Raw_P2sh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4412](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4412) + +*** + +### p2tr + +> **p2tr**: [`SeriesTree_Addrs_Raw_P2tr`](SeriesTree_Addrs_Raw_P2tr.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4415](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4415) + +*** + +### p2wpkh + +> **p2wpkh**: [`SeriesTree_Addrs_Raw_P2wpkh`](SeriesTree_Addrs_Raw_P2wpkh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4413](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4413) + +*** + +### p2wsh + +> **p2wsh**: [`SeriesTree_Addrs_Raw_P2wsh`](SeriesTree_Addrs_Raw_P2wsh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4414](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4414) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2a.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2a.md new file mode 100644 index 000000000..964185805 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2a.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Raw\_P2a + +# Interface: SeriesTree\_Addrs\_Raw\_P2a + +Defined in: [Developer/brk/modules/brk-client/index.js:4462](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4462) + +## Properties + +### bytes + +> **bytes**: [`SeriesPattern24`](../type-aliases/SeriesPattern24.md)\<[`U8x2`](../type-aliases/U8x2.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4464](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4464) + +*** + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4463](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4463) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2pk33.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2pk33.md new file mode 100644 index 000000000..1f78de29c --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2pk33.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Raw\_P2pk33 + +# Interface: SeriesTree\_Addrs\_Raw\_P2pk33 + +Defined in: [Developer/brk/modules/brk-client/index.js:4426](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4426) + +## Properties + +### bytes + +> **bytes**: [`SeriesPattern26`](../type-aliases/SeriesPattern26.md)\<[`U8x33`](../type-aliases/U8x33.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4428](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4428) + +*** + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4427](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4427) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2pk65.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2pk65.md new file mode 100644 index 000000000..67f709afb --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2pk65.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Raw\_P2pk65 + +# Interface: SeriesTree\_Addrs\_Raw\_P2pk65 + +Defined in: [Developer/brk/modules/brk-client/index.js:4420](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4420) + +## Properties + +### bytes + +> **bytes**: [`SeriesPattern27`](../type-aliases/SeriesPattern27.md)\<[`U8x65`](../type-aliases/U8x65.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4422](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4422) + +*** + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4421](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4421) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2pkh.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2pkh.md new file mode 100644 index 000000000..f2cb114f1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2pkh.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Raw\_P2pkh + +# Interface: SeriesTree\_Addrs\_Raw\_P2pkh + +Defined in: [Developer/brk/modules/brk-client/index.js:4432](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4432) + +## Properties + +### bytes + +> **bytes**: [`SeriesPattern28`](../type-aliases/SeriesPattern28.md)\<[`U8x20`](../type-aliases/U8x20.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4434](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4434) + +*** + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4433](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4433) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2sh.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2sh.md new file mode 100644 index 000000000..02b9807ef --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2sh.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Raw\_P2sh + +# Interface: SeriesTree\_Addrs\_Raw\_P2sh + +Defined in: [Developer/brk/modules/brk-client/index.js:4438](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4438) + +## Properties + +### bytes + +> **bytes**: [`SeriesPattern29`](../type-aliases/SeriesPattern29.md)\<[`U8x20`](../type-aliases/U8x20.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4440](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4440) + +*** + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4439](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4439) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2tr.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2tr.md new file mode 100644 index 000000000..c0ec4403c --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2tr.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Raw\_P2tr + +# Interface: SeriesTree\_Addrs\_Raw\_P2tr + +Defined in: [Developer/brk/modules/brk-client/index.js:4456](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4456) + +## Properties + +### bytes + +> **bytes**: [`SeriesPattern30`](../type-aliases/SeriesPattern30.md)\<[`U8x32`](../type-aliases/U8x32.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4458](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4458) + +*** + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4457](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4457) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2wpkh.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2wpkh.md new file mode 100644 index 000000000..96f6ab304 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2wpkh.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Raw\_P2wpkh + +# Interface: SeriesTree\_Addrs\_Raw\_P2wpkh + +Defined in: [Developer/brk/modules/brk-client/index.js:4444](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4444) + +## Properties + +### bytes + +> **bytes**: [`SeriesPattern31`](../type-aliases/SeriesPattern31.md)\<[`U8x20`](../type-aliases/U8x20.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4446](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4446) + +*** + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4445](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4445) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2wsh.md b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2wsh.md new file mode 100644 index 000000000..3a93c79c6 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Addrs_Raw_P2wsh.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Addrs\_Raw\_P2wsh + +# Interface: SeriesTree\_Addrs\_Raw\_P2wsh + +Defined in: [Developer/brk/modules/brk-client/index.js:4450](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4450) + +## Properties + +### bytes + +> **bytes**: [`SeriesPattern32`](../type-aliases/SeriesPattern32.md)\<[`U8x32`](../type-aliases/U8x32.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4452](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4452) + +*** + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4451](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4451) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Blocks.md b/modules/brk-client/docs/interfaces/SeriesTree_Blocks.md new file mode 100644 index 000000000..b8903ba5f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Blocks.md @@ -0,0 +1,97 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Blocks + +# Interface: SeriesTree\_Blocks + +Defined in: [Developer/brk/modules/brk-client/index.js:4157](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4157) + +## Properties + +### blockhash + +> **blockhash**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4158](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4158) + +*** + +### count + +> **count**: [`SeriesTree_Blocks_Count`](SeriesTree_Blocks_Count.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4163](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4163) + +*** + +### difficulty + +> **difficulty**: [`SeriesTree_Blocks_Difficulty`](SeriesTree_Blocks_Difficulty.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4159](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4159) + +*** + +### fullness + +> **fullness**: [`SeriesTree_Blocks_Fullness`](SeriesTree_Blocks_Fullness.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4167](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4167) + +*** + +### halving + +> **halving**: [`SeriesTree_Blocks_Halving`](SeriesTree_Blocks_Halving.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4168](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4168) + +*** + +### interval + +> **interval**: [`SeriesTree_Blocks_Interval`](SeriesTree_Blocks_Interval.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4165](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4165) + +*** + +### lookback + +> **lookback**: [`SeriesTree_Blocks_Lookback`](SeriesTree_Blocks_Lookback.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4164](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4164) + +*** + +### size + +> **size**: [`SeriesTree_Blocks_Size`](SeriesTree_Blocks_Size.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4161](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4161) + +*** + +### time + +> **time**: [`SeriesTree_Blocks_Time`](SeriesTree_Blocks_Time.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4160](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4160) + +*** + +### vbytes + +> **vbytes**: [`AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern`](AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4166](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4166) + +*** + +### weight + +> **weight**: [`AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern`](AverageBaseCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4162](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4162) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Count.md b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Count.md new file mode 100644 index 000000000..61360c0b4 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Count.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Blocks\_Count + +# Interface: SeriesTree\_Blocks\_Count + +Defined in: [Developer/brk/modules/brk-client/index.js:4204](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4204) + +## Properties + +### target + +> **target**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4205](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4205) + +*** + +### total + +> **total**: [`AverageBlockCumulativeSumPattern2`](AverageBlockCumulativeSumPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4206](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4206) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Difficulty.md b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Difficulty.md new file mode 100644 index 000000000..1a82cc8da --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Difficulty.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Blocks\_Difficulty + +# Interface: SeriesTree\_Blocks\_Difficulty + +Defined in: [Developer/brk/modules/brk-client/index.js:4172](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4172) + +## Properties + +### adjustment + +> **adjustment**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4175](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4175) + +*** + +### blocksToRetarget + +> **blocksToRetarget**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4177](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4177) + +*** + +### daysToRetarget + +> **daysToRetarget**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4178](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4178) + +*** + +### epoch + +> **epoch**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4176](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4176) + +*** + +### hashrate + +> **hashrate**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4174](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4174) + +*** + +### value + +> **value**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4173](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4173) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Fullness.md b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Fullness.md new file mode 100644 index 000000000..8ff251576 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Fullness.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Blocks\_Fullness + +# Interface: SeriesTree\_Blocks\_Fullness + +Defined in: [Developer/brk/modules/brk-client/index.js:4266](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4266) + +## Properties + +### bps + +> **bps**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4267](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4267) + +*** + +### percent + +> **percent**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4269](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4269) + +*** + +### ratio + +> **ratio**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4268](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4268) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Halving.md b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Halving.md new file mode 100644 index 000000000..42bb3a37f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Halving.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Blocks\_Halving + +# Interface: SeriesTree\_Blocks\_Halving + +Defined in: [Developer/brk/modules/brk-client/index.js:4273](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4273) + +## Properties + +### blocksToHalving + +> **blocksToHalving**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4275](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4275) + +*** + +### daysToHalving + +> **daysToHalving**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4276](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4276) + +*** + +### epoch + +> **epoch**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4274](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4274) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Interval.md b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Interval.md new file mode 100644 index 000000000..4bee09a25 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Interval.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Blocks\_Interval + +# Interface: SeriesTree\_Blocks\_Interval + +Defined in: [Developer/brk/modules/brk-client/index.js:4257](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4257) + +## Properties + +### \_1m + +> **\_1m**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4261](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4261) + +*** + +### \_1w + +> **\_1w**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4260](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4260) + +*** + +### \_1y + +> **\_1y**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4262](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4262) + +*** + +### \_24h + +> **\_24h**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4259](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4259) + +*** + +### block + +> **block**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4258](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4258) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Lookback.md b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Lookback.md new file mode 100644 index 000000000..67140c993 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Lookback.md @@ -0,0 +1,353 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Blocks\_Lookback + +# Interface: SeriesTree\_Blocks\_Lookback + +Defined in: [Developer/brk/modules/brk-client/index.js:4210](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4210) + +## Properties + +### \_10y + +> **\_10y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4250](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4250) + +*** + +### \_111d + +> **\_111d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4231](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4231) + +*** + +### \_12d + +> **\_12d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4217](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4217) + +*** + +### \_12m + +> **\_12m**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4238](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4238) + +*** + +### \_12w + +> **\_12w**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4227](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4227) + +*** + +### \_12y + +> **\_12y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4251](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4251) + +*** + +### \_13d + +> **\_13d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4218](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4218) + +*** + +### \_144d + +> **\_144d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4232](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4232) + +*** + +### \_14m + +> **\_14m**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4240](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4240) + +*** + +### \_14w + +> **\_14w**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4230](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4230) + +*** + +### \_14y + +> **\_14y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4252](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4252) + +*** + +### \_1h + +> **\_1h**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4211](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4211) + +*** + +### \_1m + +> **\_1m**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4222](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4222) + +*** + +### \_1w + +> **\_1w**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4214](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4214) + +*** + +### \_1y + +> **\_1y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4239](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4239) + +*** + +### \_200d + +> **\_200d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4235](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4235) + +*** + +### \_200w + +> **\_200w**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4244](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4244) + +*** + +### \_21d + +> **\_21d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4220](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4220) + +*** + +### \_24h + +> **\_24h**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4212](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4212) + +*** + +### \_26d + +> **\_26d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4221](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4221) + +*** + +### \_26m + +> **\_26m**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4242](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4242) + +*** + +### \_26w + +> **\_26w**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4234](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4234) + +*** + +### \_26y + +> **\_26y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4253](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4253) + +*** + +### \_2m + +> **\_2m**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4225](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4225) + +*** + +### \_2w + +> **\_2w**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4219](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4219) + +*** + +### \_2y + +> **\_2y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4241](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4241) + +*** + +### \_34d + +> **\_34d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4223](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4223) + +*** + +### \_350d + +> **\_350d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4237](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4237) + +*** + +### \_3d + +> **\_3d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4213](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4213) + +*** + +### \_3m + +> **\_3m**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4229](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4229) + +*** + +### \_3y + +> **\_3y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4243](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4243) + +*** + +### \_4y + +> **\_4y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4245](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4245) + +*** + +### \_55d + +> **\_55d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4224](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4224) + +*** + +### \_5y + +> **\_5y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4246](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4246) + +*** + +### \_6m + +> **\_6m**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4233](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4233) + +*** + +### \_6y + +> **\_6y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4247](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4247) + +*** + +### \_89d + +> **\_89d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4228](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4228) + +*** + +### \_8d + +> **\_8d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4215](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4215) + +*** + +### \_8y + +> **\_8y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4248](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4248) + +*** + +### \_9d + +> **\_9d**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4216](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4216) + +*** + +### \_9m + +> **\_9m**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4236](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4236) + +*** + +### \_9w + +> **\_9w**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4226](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4226) + +*** + +### \_9y + +> **\_9y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4249](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4249) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Size.md b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Size.md new file mode 100644 index 000000000..1c0d1fde5 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Size.md @@ -0,0 +1,97 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Blocks\_Size + +# Interface: SeriesTree\_Blocks\_Size + +Defined in: [Developer/brk/modules/brk-client/index.js:4189](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4189) + +## Properties + +### average + +> **average**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4193](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4193) + +*** + +### base + +> **base**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4190](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4190) + +*** + +### cumulative + +> **cumulative**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4191](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4191) + +*** + +### max + +> **max**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4195](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4195) + +*** + +### median + +> **median**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4198](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4198) + +*** + +### min + +> **min**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4194](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4194) + +*** + +### pct10 + +> **pct10**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4196](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4196) + +*** + +### pct25 + +> **pct25**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4197](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4197) + +*** + +### pct75 + +> **pct75**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4199](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4199) + +*** + +### pct90 + +> **pct90**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4200](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4200) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4192](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4192) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Time.md b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Time.md new file mode 100644 index 000000000..91836b1b1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Blocks_Time.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Blocks\_Time + +# Interface: SeriesTree\_Blocks\_Time + +Defined in: [Developer/brk/modules/brk-client/index.js:4182](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4182) + +## Properties + +### date + +> **date**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4184](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4184) + +*** + +### timestamp + +> **timestamp**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4183](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4183) + +*** + +### timestampMonotonic + +> **timestampMonotonic**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4185](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4185) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts.md new file mode 100644 index 000000000..42c2d0276 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts + +# Interface: SeriesTree\_Cohorts + +Defined in: [Developer/brk/modules/brk-client/index.js:5547](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5547) + +## Properties + +### addr + +> **addr**: [`SeriesTree_Cohorts_Addr`](SeriesTree_Cohorts_Addr.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5549](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5549) + +*** + +### utxo + +> **utxo**: [`SeriesTree_Cohorts_Utxo`](SeriesTree_Cohorts_Utxo.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5548](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5548) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr.md new file mode 100644 index 000000000..300a78c62 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Addr + +# Interface: SeriesTree\_Cohorts\_Addr + +Defined in: [Developer/brk/modules/brk-client/index.js:6296](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6296) + +## Properties + +### amountRange + +> **amountRange**: [`SeriesTree_Cohorts_Addr_AmountRange`](SeriesTree_Cohorts_Addr_AmountRange.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6298](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6298) + +*** + +### overAmount + +> **overAmount**: [`SeriesTree_Cohorts_Addr_OverAmount`](SeriesTree_Cohorts_Addr_OverAmount.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6297](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6297) + +*** + +### underAmount + +> **underAmount**: [`SeriesTree_Cohorts_Addr_UnderAmount`](SeriesTree_Cohorts_Addr_UnderAmount.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6299](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6299) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr_AmountRange.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr_AmountRange.md new file mode 100644 index 000000000..4071c187e --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr_AmountRange.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Addr\_AmountRange + +# Interface: SeriesTree\_Cohorts\_Addr\_AmountRange + +Defined in: [Developer/brk/modules/brk-client/index.js:6320](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6320) + +## Properties + +### \_0sats + +> **\_0sats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6321](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6321) + +*** + +### \_100btcTo1kBtc + +> **\_100btcTo1kBtc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6332](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6332) + +*** + +### \_100kSatsTo1mSats + +> **\_100kSatsTo1mSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6327](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6327) + +*** + +### \_100satsTo1kSats + +> **\_100satsTo1kSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6324](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6324) + +*** + +### \_10btcTo100btc + +> **\_10btcTo100btc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6331](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6331) + +*** + +### \_10kBtcTo100kBtc + +> **\_10kBtcTo100kBtc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6334](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6334) + +*** + +### \_10kSatsTo100kSats + +> **\_10kSatsTo100kSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6326](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6326) + +*** + +### \_10mSatsTo1btc + +> **\_10mSatsTo1btc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6329](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6329) + +*** + +### \_10satsTo100sats + +> **\_10satsTo100sats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6323](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6323) + +*** + +### \_1btcTo10btc + +> **\_1btcTo10btc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6330](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6330) + +*** + +### \_1kBtcTo10kBtc + +> **\_1kBtcTo10kBtc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6333](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6333) + +*** + +### \_1kSatsTo10kSats + +> **\_1kSatsTo10kSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6325](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6325) + +*** + +### \_1mSatsTo10mSats + +> **\_1mSatsTo10mSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6328](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6328) + +*** + +### \_1satTo10sats + +> **\_1satTo10sats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6322](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6322) + +*** + +### over100kBtc + +> **over100kBtc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6335](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6335) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr_OverAmount.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr_OverAmount.md new file mode 100644 index 000000000..0af9f761b --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr_OverAmount.md @@ -0,0 +1,113 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Addr\_OverAmount + +# Interface: SeriesTree\_Cohorts\_Addr\_OverAmount + +Defined in: [Developer/brk/modules/brk-client/index.js:6303](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6303) + +## Properties + +### \_100btc + +> **\_100btc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6314](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6314) + +*** + +### \_100kSats + +> **\_100kSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6309](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6309) + +*** + +### \_100sats + +> **\_100sats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6306](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6306) + +*** + +### \_10btc + +> **\_10btc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6313](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6313) + +*** + +### \_10kBtc + +> **\_10kBtc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6316](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6316) + +*** + +### \_10kSats + +> **\_10kSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6308](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6308) + +*** + +### \_10mSats + +> **\_10mSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6311](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6311) + +*** + +### \_10sats + +> **\_10sats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6305](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6305) + +*** + +### \_1btc + +> **\_1btc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6312](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6312) + +*** + +### \_1kBtc + +> **\_1kBtc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6315](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6315) + +*** + +### \_1kSats + +> **\_1kSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6307](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6307) + +*** + +### \_1mSats + +> **\_1mSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6310](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6310) + +*** + +### \_1sat + +> **\_1sat**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6304](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6304) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr_UnderAmount.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr_UnderAmount.md new file mode 100644 index 000000000..243cf3546 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Addr_UnderAmount.md @@ -0,0 +1,113 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Addr\_UnderAmount + +# Interface: SeriesTree\_Cohorts\_Addr\_UnderAmount + +Defined in: [Developer/brk/modules/brk-client/index.js:6339](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6339) + +## Properties + +### \_100btc + +> **\_100btc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6349](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6349) + +*** + +### \_100kBtc + +> **\_100kBtc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6352](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6352) + +*** + +### \_100kSats + +> **\_100kSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6344](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6344) + +*** + +### \_100sats + +> **\_100sats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6341](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6341) + +*** + +### \_10btc + +> **\_10btc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6348](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6348) + +*** + +### \_10kBtc + +> **\_10kBtc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6351](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6351) + +*** + +### \_10kSats + +> **\_10kSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6343](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6343) + +*** + +### \_10mSats + +> **\_10mSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6346](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6346) + +*** + +### \_10sats + +> **\_10sats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6340](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6340) + +*** + +### \_1btc + +> **\_1btc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6347](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6347) + +*** + +### \_1kBtc + +> **\_1kBtc**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6350](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6350) + +*** + +### \_1kSats + +> **\_1kSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6342](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6342) + +*** + +### \_1mSats + +> **\_1mSats**: [`ActivityAddrOutputsRealizedSupplyUnrealizedPattern`](ActivityAddrOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6345](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6345) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo.md new file mode 100644 index 000000000..a98388abe --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo.md @@ -0,0 +1,121 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo + +# Interface: SeriesTree\_Cohorts\_Utxo + +Defined in: [Developer/brk/modules/brk-client/index.js:5553](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5553) + +## Properties + +### ageRange + +> **ageRange**: [`SeriesTree_Cohorts_Utxo_AgeRange`](SeriesTree_Cohorts_Utxo_AgeRange.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5557](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5557) + +*** + +### all + +> **all**: [`SeriesTree_Cohorts_Utxo_All`](SeriesTree_Cohorts_Utxo_All.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5554](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5554) + +*** + +### amountRange + +> **amountRange**: [`SeriesTree_Cohorts_Utxo_AmountRange`](SeriesTree_Cohorts_Utxo_AmountRange.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5563](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5563) + +*** + +### class + +> **class**: [`SeriesTree_Cohorts_Utxo_Class`](SeriesTree_Cohorts_Utxo_Class.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5561](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5561) + +*** + +### epoch + +> **epoch**: [`SeriesTree_Cohorts_Utxo_Epoch`](SeriesTree_Cohorts_Utxo_Epoch.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5560](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5560) + +*** + +### lth + +> **lth**: [`SeriesTree_Cohorts_Utxo_Lth`](SeriesTree_Cohorts_Utxo_Lth.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5556](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5556) + +*** + +### matured + +> **matured**: [`SeriesTree_Cohorts_Utxo_Matured`](SeriesTree_Cohorts_Utxo_Matured.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5567](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5567) + +*** + +### overAge + +> **overAge**: [`SeriesTree_Cohorts_Utxo_OverAge`](SeriesTree_Cohorts_Utxo_OverAge.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5559](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5559) + +*** + +### overAmount + +> **overAmount**: [`SeriesTree_Cohorts_Utxo_OverAmount`](SeriesTree_Cohorts_Utxo_OverAmount.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5562](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5562) + +*** + +### profitability + +> **profitability**: [`SeriesTree_Cohorts_Utxo_Profitability`](SeriesTree_Cohorts_Utxo_Profitability.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5566](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5566) + +*** + +### sth + +> **sth**: [`SeriesTree_Cohorts_Utxo_Sth`](SeriesTree_Cohorts_Utxo_Sth.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5555](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5555) + +*** + +### type + +> **type**: [`SeriesTree_Cohorts_Utxo_Type`](SeriesTree_Cohorts_Utxo_Type.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5565](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5565) + +*** + +### underAge + +> **underAge**: [`SeriesTree_Cohorts_Utxo_UnderAge`](SeriesTree_Cohorts_Utxo_UnderAge.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5558](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5558) + +*** + +### underAmount + +> **underAmount**: [`SeriesTree_Cohorts_Utxo_UnderAmount`](SeriesTree_Cohorts_Utxo_UnderAmount.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5564](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5564) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_AgeRange.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_AgeRange.md new file mode 100644 index 000000000..82959bbdd --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_AgeRange.md @@ -0,0 +1,177 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_AgeRange + +# Interface: SeriesTree\_Cohorts\_Utxo\_AgeRange + +Defined in: [Developer/brk/modules/brk-client/index.js:6036](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6036) + +## Properties + +### \_10yTo12y + +> **\_10yTo12y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6055](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6055) + +*** + +### \_12yTo15y + +> **\_12yTo15y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6056](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6056) + +*** + +### \_1dTo1w + +> **\_1dTo1w**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6039](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6039) + +*** + +### \_1hTo1d + +> **\_1hTo1d**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6038](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6038) + +*** + +### \_1mTo2m + +> **\_1mTo2m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6041](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6041) + +*** + +### \_1wTo1m + +> **\_1wTo1m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6040](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6040) + +*** + +### \_1yTo2y + +> **\_1yTo2y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6047](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6047) + +*** + +### \_2mTo3m + +> **\_2mTo3m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6042](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6042) + +*** + +### \_2yTo3y + +> **\_2yTo3y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6048](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6048) + +*** + +### \_3mTo4m + +> **\_3mTo4m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6043](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6043) + +*** + +### \_3yTo4y + +> **\_3yTo4y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6049](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6049) + +*** + +### \_4mTo5m + +> **\_4mTo5m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6044](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6044) + +*** + +### \_4yTo5y + +> **\_4yTo5y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6050](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6050) + +*** + +### \_5mTo6m + +> **\_5mTo6m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6045](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6045) + +*** + +### \_5yTo6y + +> **\_5yTo6y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6051](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6051) + +*** + +### \_6mTo1y + +> **\_6mTo1y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6046](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6046) + +*** + +### \_6yTo7y + +> **\_6yTo7y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6052](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6052) + +*** + +### \_7yTo8y + +> **\_7yTo8y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6053](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6053) + +*** + +### \_8yTo10y + +> **\_8yTo10y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6054](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6054) + +*** + +### over15y + +> **over15y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6057](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6057) + +*** + +### under1h + +> **under1h**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6037](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6037) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All.md new file mode 100644 index 000000000..88b2270b0 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All + +# Interface: SeriesTree\_Cohorts\_Utxo\_All + +Defined in: [Developer/brk/modules/brk-client/index.js:5571](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5571) + +## Properties + +### activity + +> **activity**: [`SeriesTree_Cohorts_Utxo_All_Activity`](SeriesTree_Cohorts_Utxo_All_Activity.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5574](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5574) + +*** + +### costBasis + +> **costBasis**: [`SeriesTree_Cohorts_Utxo_All_CostBasis`](SeriesTree_Cohorts_Utxo_All_CostBasis.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5576](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5576) + +*** + +### outputs + +> **outputs**: [`SeriesTree_Cohorts_Utxo_All_Outputs`](SeriesTree_Cohorts_Utxo_All_Outputs.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5573](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5573) + +*** + +### realized + +> **realized**: [`SeriesTree_Cohorts_Utxo_All_Realized`](SeriesTree_Cohorts_Utxo_All_Realized.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5575](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5575) + +*** + +### supply + +> **supply**: [`SeriesTree_Cohorts_Utxo_All_Supply`](SeriesTree_Cohorts_Utxo_All_Supply.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5572](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5572) + +*** + +### unrealized + +> **unrealized**: [`SeriesTree_Cohorts_Utxo_All_Unrealized`](SeriesTree_Cohorts_Utxo_All_Unrealized.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5577](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5577) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Activity.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Activity.md new file mode 100644 index 000000000..4de1a7f02 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Activity.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Activity + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Activity + +Defined in: [Developer/brk/modules/brk-client/index.js:5597](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5597) + +## Properties + +### coindaysDestroyed + +> **coindaysDestroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5599](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5599) + +*** + +### coinyearsDestroyed + +> **coinyearsDestroyed**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5600](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5600) + +*** + +### dormancy + +> **dormancy**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5601](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5601) + +*** + +### transferVolume + +> **transferVolume**: [`AverageBlockCumulativeInSumPattern`](AverageBlockCumulativeInSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5598](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5598) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_CostBasis.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_CostBasis.md new file mode 100644 index 000000000..78bd45ab9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_CostBasis.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_CostBasis + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_CostBasis + +Defined in: [Developer/brk/modules/brk-client/index.js:5731](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5731) + +## Properties + +### inLoss + +> **inLoss**: [`PerPattern`](PerPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5733](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5733) + +*** + +### inProfit + +> **inProfit**: [`PerPattern`](PerPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5732](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5732) + +*** + +### max + +> **max**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5735](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5735) + +*** + +### min + +> **min**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5734](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5734) + +*** + +### perCoin + +> **perCoin**: [`Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern`](Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5736](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5736) + +*** + +### perDollar + +> **perDollar**: [`Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern`](Pct05Pct10Pct15Pct20Pct25Pct30Pct35Pct40Pct45Pct50Pct55Pct60Pct65Pct70Pct75Pct80Pct85Pct90Pct95Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5737](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5737) + +*** + +### supplyDensity + +> **supplyDensity**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5738](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5738) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Outputs.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Outputs.md new file mode 100644 index 000000000..65e1b5e96 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Outputs.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Outputs + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Outputs + +Defined in: [Developer/brk/modules/brk-client/index.js:5590](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5590) + +## Properties + +### spendingRate + +> **spendingRate**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5593](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5593) + +*** + +### spentCount + +> **spentCount**: [`AverageBlockCumulativeSumPattern2`](AverageBlockCumulativeSumPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5592](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5592) + +*** + +### unspentCount + +> **unspentCount**: [`BaseDeltaPattern`](BaseDeltaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5591](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5591) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized.md new file mode 100644 index 000000000..c25185820 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Realized + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Realized + +Defined in: [Developer/brk/modules/brk-client/index.js:5605](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5605) + +## Properties + +### cap + +> **cap**: [`CentsDeltaToUsdPattern`](CentsDeltaToUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5606](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5606) + +*** + +### grossPnl + +> **grossPnl**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5613](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5613) + +*** + +### investor + +> **investor**: [`PricePattern`](PricePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5616](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5616) + +*** + +### loss + +> **loss**: [`BlockCumulativeNegativeSumPattern`](BlockCumulativeNegativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5608](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5608) + +*** + +### mvrv + +> **mvrv**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5610](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5610) + +*** + +### netPnl + +> **netPnl**: [`BlockChangeCumulativeDeltaSumPattern`](BlockChangeCumulativeDeltaSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5611](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5611) + +*** + +### peakRegret + +> **peakRegret**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5615](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5615) + +*** + +### price + +> **price**: [`SeriesTree_Cohorts_Utxo_All_Realized_Price`](SeriesTree_Cohorts_Utxo_All_Realized_Price.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5609](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5609) + +*** + +### profit + +> **profit**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5607](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5607) + +*** + +### profitToLossRatio + +> **profitToLossRatio**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5617](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5617) + +*** + +### sellSideRiskRatio + +> **sellSideRiskRatio**: [`_1m1w1y24hPattern7`](1m1w1y24hPattern7.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5614](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5614) + +*** + +### sopr + +> **sopr**: [`SeriesTree_Cohorts_Utxo_All_Realized_Sopr`](SeriesTree_Cohorts_Utxo_All_Realized_Sopr.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5612](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5612) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price.md new file mode 100644 index 000000000..2b562dfef --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price + +Defined in: [Developer/brk/modules/brk-client/index.js:5621](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5621) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5625](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5625) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5623](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5623) + +*** + +### percentiles + +> **percentiles**: [`Pct1Pct2Pct5Pct95Pct98Pct99Pattern`](Pct1Pct2Pct5Pct95Pct98Pct99Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5627](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5627) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5626](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5626) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5624](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5624) + +*** + +### sma + +> **sma**: [`_1m1w1y2y4yAllPattern`](1m1w1y2y4yAllPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5628](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5628) + +*** + +### stdDev + +> **stdDev**: [`SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev`](SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5629](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5629) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5622](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5622) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev.md new file mode 100644 index 000000000..c9f340167 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev + +Defined in: [Developer/brk/modules/brk-client/index.js:5633](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5633) + +## Properties + +### \_1y + +> **\_1y**: [`SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_1y`](SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_1y.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5637](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5637) + +*** + +### \_2y + +> **\_2y**: [`SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_2y`](SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_2y.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5636](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5636) + +*** + +### \_4y + +> **\_4y**: [`SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_4y`](SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_4y.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5635](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5635) + +*** + +### all + +> **all**: [`SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_All`](SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_All.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5634](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5634) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_1y.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_1y.md new file mode 100644 index 000000000..ae33db93f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_1y.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_1y + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_1y + +Defined in: [Developer/brk/modules/brk-client/index.js:5698](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5698) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5701](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5701) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5708](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5708) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5710](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5710) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5709](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5709) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5712](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5712) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5711](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5711) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5713](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5713) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5702](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5702) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5704](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5704) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5703](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5703) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5706](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5706) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5705](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5705) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5707](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5707) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5699](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5699) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5700](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5700) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_2y.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_2y.md new file mode 100644 index 000000000..979f9e49e --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_2y.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_2y + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_2y + +Defined in: [Developer/brk/modules/brk-client/index.js:5679](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5679) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5682](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5682) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5689](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5689) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5691](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5691) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5690](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5690) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5693](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5693) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5692](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5692) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5694](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5694) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5683](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5683) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5685](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5685) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5684](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5684) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5687](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5687) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5686](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5686) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5688](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5688) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5680](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5680) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5681](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5681) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_4y.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_4y.md new file mode 100644 index 000000000..22dec5e2a --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_4y.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_4y + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_4y + +Defined in: [Developer/brk/modules/brk-client/index.js:5660](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5660) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5663](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5663) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5670](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5670) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5672](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5672) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5671](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5671) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5674](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5674) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5673](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5673) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5675](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5675) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5664](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5664) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5666](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5666) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5665](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5665) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5668](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5668) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5667](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5667) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5669](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5669) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5661](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5661) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5662](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5662) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_All.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_All.md new file mode 100644 index 000000000..bf695ce69 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Price_StdDev_All.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_All + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Price\_StdDev\_All + +Defined in: [Developer/brk/modules/brk-client/index.js:5641](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5641) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5644](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5644) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5651](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5651) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5653](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5653) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5652](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5652) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5655](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5655) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5654](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5654) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5656](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5656) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5645](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5645) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5647](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5647) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5646](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5646) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5649](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5649) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5648](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5648) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5650](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5650) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5642](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5642) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5643](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5643) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Sopr.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Sopr.md new file mode 100644 index 000000000..8a5b1b76e --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Sopr.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Sopr + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Sopr + +Defined in: [Developer/brk/modules/brk-client/index.js:5717](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5717) + +## Properties + +### adjusted + +> **adjusted**: [`SeriesTree_Cohorts_Utxo_All_Realized_Sopr_Adjusted`](SeriesTree_Cohorts_Utxo_All_Realized_Sopr_Adjusted.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5720](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5720) + +*** + +### ratio + +> **ratio**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5719](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5719) + +*** + +### valueDestroyed + +> **valueDestroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5718](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5718) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Sopr_Adjusted.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Sopr_Adjusted.md new file mode 100644 index 000000000..cb8b9f3d5 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Realized_Sopr_Adjusted.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Sopr\_Adjusted + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Realized\_Sopr\_Adjusted + +Defined in: [Developer/brk/modules/brk-client/index.js:5724](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5724) + +## Properties + +### ratio + +> **ratio**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5725](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5725) + +*** + +### transferVolume + +> **transferVolume**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5726](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5726) + +*** + +### valueDestroyed + +> **valueDestroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5727](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5727) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Supply.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Supply.md new file mode 100644 index 000000000..855bb82b6 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Supply.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Supply + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Supply + +Defined in: [Developer/brk/modules/brk-client/index.js:5581](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5581) + +## Properties + +### delta + +> **delta**: [`AbsoluteRatePattern`](AbsoluteRatePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5583](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5583) + +*** + +### half + +> **half**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5584](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5584) + +*** + +### inLoss + +> **inLoss**: [`BtcCentsSatsToUsdPattern2`](BtcCentsSatsToUsdPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5586](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5586) + +*** + +### inProfit + +> **inProfit**: [`BtcCentsSatsToUsdPattern2`](BtcCentsSatsToUsdPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5585](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5585) + +*** + +### total + +> **total**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5582](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5582) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized.md new file mode 100644 index 000000000..a8c9a3504 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Unrealized + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Unrealized + +Defined in: [Developer/brk/modules/brk-client/index.js:5742](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5742) + +## Properties + +### grossPnl + +> **grossPnl**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5747](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5747) + +*** + +### investedCapital + +> **investedCapital**: [`InPattern`](InPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5748](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5748) + +*** + +### investorCapInLossRaw + +> **investorCapInLossRaw**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5750](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5750) + +*** + +### investorCapInProfitRaw + +> **investorCapInProfitRaw**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5749](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5749) + +*** + +### loss + +> **loss**: [`SeriesTree_Cohorts_Utxo_All_Unrealized_Loss`](SeriesTree_Cohorts_Utxo_All_Unrealized_Loss.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5745](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5745) + +*** + +### netPnl + +> **netPnl**: [`SeriesTree_Cohorts_Utxo_All_Unrealized_NetPnl`](SeriesTree_Cohorts_Utxo_All_Unrealized_NetPnl.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5746](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5746) + +*** + +### nupl + +> **nupl**: [`BpsRatioPattern`](BpsRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5743](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5743) + +*** + +### profit + +> **profit**: [`SeriesTree_Cohorts_Utxo_All_Unrealized_Profit`](SeriesTree_Cohorts_Utxo_All_Unrealized_Profit.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5744](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5744) + +*** + +### sentiment + +> **sentiment**: [`SeriesTree_Cohorts_Utxo_All_Unrealized_Sentiment`](SeriesTree_Cohorts_Utxo_All_Unrealized_Sentiment.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5751](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5751) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Loss.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Loss.md new file mode 100644 index 000000000..f4e3b7830 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Loss.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_Loss + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_Loss + +Defined in: [Developer/brk/modules/brk-client/index.js:5763](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5763) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5765](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5765) + +*** + +### negative + +> **negative**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5766](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5766) + +*** + +### toMcap + +> **toMcap**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5767](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5767) + +*** + +### toOwnGrossPnl + +> **toOwnGrossPnl**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5768](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5768) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5764](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5764) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_NetPnl.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_NetPnl.md new file mode 100644 index 000000000..6ddf31d99 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_NetPnl.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_NetPnl + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_NetPnl + +Defined in: [Developer/brk/modules/brk-client/index.js:5772](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5772) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5774](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5774) + +*** + +### toOwnGrossPnl + +> **toOwnGrossPnl**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5775](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5775) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5773](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5773) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Profit.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Profit.md new file mode 100644 index 000000000..7350840cb --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Profit.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_Profit + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_Profit + +Defined in: [Developer/brk/modules/brk-client/index.js:5755](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5755) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5757](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5757) + +*** + +### toMcap + +> **toMcap**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5758](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5758) + +*** + +### toOwnGrossPnl + +> **toOwnGrossPnl**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5759](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5759) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5756](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5756) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Sentiment.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Sentiment.md new file mode 100644 index 000000000..fea9fc6ae --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_All_Unrealized_Sentiment.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_Sentiment + +# Interface: SeriesTree\_Cohorts\_Utxo\_All\_Unrealized\_Sentiment + +Defined in: [Developer/brk/modules/brk-client/index.js:5779](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5779) + +## Properties + +### greedIndex + +> **greedIndex**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5781](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5781) + +*** + +### net + +> **net**: [`CentsUsdPattern`](CentsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5782](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5782) + +*** + +### painIndex + +> **painIndex**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5780](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5780) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_AmountRange.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_AmountRange.md new file mode 100644 index 000000000..e2600bbfb --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_AmountRange.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_AmountRange + +# Interface: SeriesTree\_Cohorts\_Utxo\_AmountRange + +Defined in: [Developer/brk/modules/brk-client/index.js:6153](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6153) + +## Properties + +### \_0sats + +> **\_0sats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6154](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6154) + +*** + +### \_100btcTo1kBtc + +> **\_100btcTo1kBtc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6165](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6165) + +*** + +### \_100kSatsTo1mSats + +> **\_100kSatsTo1mSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6160](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6160) + +*** + +### \_100satsTo1kSats + +> **\_100satsTo1kSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6157](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6157) + +*** + +### \_10btcTo100btc + +> **\_10btcTo100btc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6164](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6164) + +*** + +### \_10kBtcTo100kBtc + +> **\_10kBtcTo100kBtc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6167](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6167) + +*** + +### \_10kSatsTo100kSats + +> **\_10kSatsTo100kSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6159](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6159) + +*** + +### \_10mSatsTo1btc + +> **\_10mSatsTo1btc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6162](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6162) + +*** + +### \_10satsTo100sats + +> **\_10satsTo100sats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6156](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6156) + +*** + +### \_1btcTo10btc + +> **\_1btcTo10btc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6163](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6163) + +*** + +### \_1kBtcTo10kBtc + +> **\_1kBtcTo10kBtc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6166](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6166) + +*** + +### \_1kSatsTo10kSats + +> **\_1kSatsTo10kSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6158](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6158) + +*** + +### \_1mSatsTo10mSats + +> **\_1mSatsTo10mSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6161](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6161) + +*** + +### \_1satTo10sats + +> **\_1satTo10sats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6155](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6155) + +*** + +### over100kBtc + +> **over100kBtc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6168](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6168) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Class.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Class.md new file mode 100644 index 000000000..e62d22197 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Class.md @@ -0,0 +1,153 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Class + +# Interface: SeriesTree\_Cohorts\_Utxo\_Class + +Defined in: [Developer/brk/modules/brk-client/index.js:6114](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6114) + +## Properties + +### \_2009 + +> **\_2009**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6115](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6115) + +*** + +### \_2010 + +> **\_2010**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6116](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6116) + +*** + +### \_2011 + +> **\_2011**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6117](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6117) + +*** + +### \_2012 + +> **\_2012**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6118](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6118) + +*** + +### \_2013 + +> **\_2013**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6119](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6119) + +*** + +### \_2014 + +> **\_2014**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6120](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6120) + +*** + +### \_2015 + +> **\_2015**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6121](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6121) + +*** + +### \_2016 + +> **\_2016**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6122](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6122) + +*** + +### \_2017 + +> **\_2017**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6123](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6123) + +*** + +### \_2018 + +> **\_2018**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6124](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6124) + +*** + +### \_2019 + +> **\_2019**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6125](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6125) + +*** + +### \_2020 + +> **\_2020**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6126](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6126) + +*** + +### \_2021 + +> **\_2021**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6127](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6127) + +*** + +### \_2022 + +> **\_2022**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6128](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6128) + +*** + +### \_2023 + +> **\_2023**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6129](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6129) + +*** + +### \_2024 + +> **\_2024**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6130](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6130) + +*** + +### \_2025 + +> **\_2025**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6131](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6131) + +*** + +### \_2026 + +> **\_2026**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6132](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6132) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Epoch.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Epoch.md new file mode 100644 index 000000000..74ab2f3b8 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Epoch.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Epoch + +# Interface: SeriesTree\_Cohorts\_Utxo\_Epoch + +Defined in: [Developer/brk/modules/brk-client/index.js:6105](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6105) + +## Properties + +### \_0 + +> **\_0**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6106](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6106) + +*** + +### \_1 + +> **\_1**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6107](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6107) + +*** + +### \_2 + +> **\_2**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6108](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6108) + +*** + +### \_3 + +> **\_3**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6109](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6109) + +*** + +### \_4 + +> **\_4**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6110](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6110) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth.md new file mode 100644 index 000000000..731eda8a6 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Lth + +# Interface: SeriesTree\_Cohorts\_Utxo\_Lth + +Defined in: [Developer/brk/modules/brk-client/index.js:5908](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5908) + +## Properties + +### activity + +> **activity**: [`CoindaysCoinyearsDormancyTransferPattern`](CoindaysCoinyearsDormancyTransferPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5911](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5911) + +*** + +### costBasis + +> **costBasis**: [`InMaxMinPerSupplyPattern`](InMaxMinPerSupplyPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5913](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5913) + +*** + +### outputs + +> **outputs**: [`SpendingSpentUnspentPattern`](SpendingSpentUnspentPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5910](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5910) + +*** + +### realized + +> **realized**: [`SeriesTree_Cohorts_Utxo_Lth_Realized`](SeriesTree_Cohorts_Utxo_Lth_Realized.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5912](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5912) + +*** + +### supply + +> **supply**: [`DeltaHalfInToTotalPattern2`](DeltaHalfInToTotalPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5909](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5909) + +*** + +### unrealized + +> **unrealized**: [`GrossInvestedInvestorLossNetNuplProfitSentimentPattern2`](GrossInvestedInvestorLossNetNuplProfitSentimentPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5914](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5914) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized.md new file mode 100644 index 000000000..bfbcaaf29 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Lth\_Realized + +# Interface: SeriesTree\_Cohorts\_Utxo\_Lth\_Realized + +Defined in: [Developer/brk/modules/brk-client/index.js:5918](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5918) + +## Properties + +### cap + +> **cap**: [`CentsDeltaToUsdPattern`](CentsDeltaToUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5919](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5919) + +*** + +### grossPnl + +> **grossPnl**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5926](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5926) + +*** + +### investor + +> **investor**: [`PricePattern`](PricePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5929](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5929) + +*** + +### loss + +> **loss**: [`BlockCumulativeNegativeSumPattern`](BlockCumulativeNegativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5921](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5921) + +*** + +### mvrv + +> **mvrv**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5923](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5923) + +*** + +### netPnl + +> **netPnl**: [`BlockChangeCumulativeDeltaSumPattern`](BlockChangeCumulativeDeltaSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5924](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5924) + +*** + +### peakRegret + +> **peakRegret**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5928](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5928) + +*** + +### price + +> **price**: [`SeriesTree_Cohorts_Utxo_Lth_Realized_Price`](SeriesTree_Cohorts_Utxo_Lth_Realized_Price.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5922](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5922) + +*** + +### profit + +> **profit**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5920](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5920) + +*** + +### profitToLossRatio + +> **profitToLossRatio**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5930](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5930) + +*** + +### sellSideRiskRatio + +> **sellSideRiskRatio**: [`_1m1w1y24hPattern7`](1m1w1y24hPattern7.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5927](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5927) + +*** + +### sopr + +> **sopr**: [`SeriesTree_Cohorts_Utxo_Lth_Realized_Sopr`](SeriesTree_Cohorts_Utxo_Lth_Realized_Sopr.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5925](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5925) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price.md new file mode 100644 index 000000000..7d007764b --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price + +# Interface: SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price + +Defined in: [Developer/brk/modules/brk-client/index.js:5934](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5934) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5938](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5938) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5936](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5936) + +*** + +### percentiles + +> **percentiles**: [`Pct1Pct2Pct5Pct95Pct98Pct99Pattern`](Pct1Pct2Pct5Pct95Pct98Pct99Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5940](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5940) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5939](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5939) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5937](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5937) + +*** + +### sma + +> **sma**: [`_1m1w1y2y4yAllPattern`](1m1w1y2y4yAllPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5941](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5941) + +*** + +### stdDev + +> **stdDev**: [`SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev`](SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5942](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5942) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5935](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5935) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev.md new file mode 100644 index 000000000..2fb83f9b3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev + +# Interface: SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev + +Defined in: [Developer/brk/modules/brk-client/index.js:5946](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5946) + +## Properties + +### \_1y + +> **\_1y**: [`SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_1y`](SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_1y.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5950](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5950) + +*** + +### \_2y + +> **\_2y**: [`SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_2y`](SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_2y.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5949](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5949) + +*** + +### \_4y + +> **\_4y**: [`SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_4y`](SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_4y.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5948](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5948) + +*** + +### all + +> **all**: [`SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_All`](SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_All.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5947](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5947) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_1y.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_1y.md new file mode 100644 index 000000000..90581f518 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_1y.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_1y + +# Interface: SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_1y + +Defined in: [Developer/brk/modules/brk-client/index.js:6011](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6011) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6014](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6014) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6021](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6021) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6023](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6023) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6022](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6022) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6025](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6025) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6024](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6024) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6026](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6026) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6015](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6015) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6017](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6017) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6016](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6016) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6019](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6019) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6018](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6018) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6020](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6020) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6012](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6012) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6013](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6013) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_2y.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_2y.md new file mode 100644 index 000000000..73bada95f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_2y.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_2y + +# Interface: SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_2y + +Defined in: [Developer/brk/modules/brk-client/index.js:5992](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5992) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5995](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5995) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6002](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6002) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6004](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6004) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6003](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6003) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6006](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6006) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6005](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6005) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6007](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6007) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5996](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5996) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5998](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5998) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5997](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5997) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6000](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6000) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5999](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5999) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6001](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6001) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5993](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5993) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5994](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5994) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_4y.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_4y.md new file mode 100644 index 000000000..1e9d97875 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_4y.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_4y + +# Interface: SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_4y + +Defined in: [Developer/brk/modules/brk-client/index.js:5973](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5973) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5976](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5976) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5983](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5983) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5985](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5985) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5984](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5984) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5987](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5987) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5986](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5986) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5988](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5988) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5977](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5977) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5979](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5979) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5978](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5978) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5981](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5981) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5980](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5980) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5982](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5982) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5974](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5974) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5975](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5975) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_All.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_All.md new file mode 100644 index 000000000..23baf4d41 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Price_StdDev_All.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_All + +# Interface: SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Price\_StdDev\_All + +Defined in: [Developer/brk/modules/brk-client/index.js:5954](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5954) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5957](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5957) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5964](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5964) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5966](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5966) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5965](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5965) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5968](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5968) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5967](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5967) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5969](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5969) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5958](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5958) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5960](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5960) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5959](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5959) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5962](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5962) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5961](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5961) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5963](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5963) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5955](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5955) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5956](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5956) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Sopr.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Sopr.md new file mode 100644 index 000000000..5a90d997b --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Lth_Realized_Sopr.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Sopr + +# Interface: SeriesTree\_Cohorts\_Utxo\_Lth\_Realized\_Sopr + +Defined in: [Developer/brk/modules/brk-client/index.js:6030](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6030) + +## Properties + +### ratio + +> **ratio**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6032](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6032) + +*** + +### valueDestroyed + +> **valueDestroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6031](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6031) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Matured.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Matured.md new file mode 100644 index 000000000..cbe83a42d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Matured.md @@ -0,0 +1,177 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Matured + +# Interface: SeriesTree\_Cohorts\_Utxo\_Matured + +Defined in: [Developer/brk/modules/brk-client/index.js:6271](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6271) + +## Properties + +### \_10yTo12y + +> **\_10yTo12y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6290](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6290) + +*** + +### \_12yTo15y + +> **\_12yTo15y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6291](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6291) + +*** + +### \_1dTo1w + +> **\_1dTo1w**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6274](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6274) + +*** + +### \_1hTo1d + +> **\_1hTo1d**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6273](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6273) + +*** + +### \_1mTo2m + +> **\_1mTo2m**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6276](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6276) + +*** + +### \_1wTo1m + +> **\_1wTo1m**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6275](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6275) + +*** + +### \_1yTo2y + +> **\_1yTo2y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6282](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6282) + +*** + +### \_2mTo3m + +> **\_2mTo3m**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6277](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6277) + +*** + +### \_2yTo3y + +> **\_2yTo3y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6283](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6283) + +*** + +### \_3mTo4m + +> **\_3mTo4m**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6278](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6278) + +*** + +### \_3yTo4y + +> **\_3yTo4y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6284](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6284) + +*** + +### \_4mTo5m + +> **\_4mTo5m**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6279](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6279) + +*** + +### \_4yTo5y + +> **\_4yTo5y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6285](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6285) + +*** + +### \_5mTo6m + +> **\_5mTo6m**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6280](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6280) + +*** + +### \_5yTo6y + +> **\_5yTo6y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6286](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6286) + +*** + +### \_6mTo1y + +> **\_6mTo1y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6281](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6281) + +*** + +### \_6yTo7y + +> **\_6yTo7y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6287](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6287) + +*** + +### \_7yTo8y + +> **\_7yTo8y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6288](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6288) + +*** + +### \_8yTo10y + +> **\_8yTo10y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6289](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6289) + +*** + +### over15y + +> **over15y**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6292](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6292) + +*** + +### under1h + +> **under1h**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6272](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6272) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_OverAge.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_OverAge.md new file mode 100644 index 000000000..234b29259 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_OverAge.md @@ -0,0 +1,153 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_OverAge + +# Interface: SeriesTree\_Cohorts\_Utxo\_OverAge + +Defined in: [Developer/brk/modules/brk-client/index.js:6083](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6083) + +## Properties + +### \_10y + +> **\_10y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6100](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6100) + +*** + +### \_12y + +> **\_12y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6101](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6101) + +*** + +### \_1d + +> **\_1d**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6084](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6084) + +*** + +### \_1m + +> **\_1m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6086](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6086) + +*** + +### \_1w + +> **\_1w**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6085](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6085) + +*** + +### \_1y + +> **\_1y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6092](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6092) + +*** + +### \_2m + +> **\_2m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6087](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6087) + +*** + +### \_2y + +> **\_2y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6093](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6093) + +*** + +### \_3m + +> **\_3m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6088](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6088) + +*** + +### \_3y + +> **\_3y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6094](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6094) + +*** + +### \_4m + +> **\_4m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6089](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6089) + +*** + +### \_4y + +> **\_4y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6095](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6095) + +*** + +### \_5m + +> **\_5m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6090](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6090) + +*** + +### \_5y + +> **\_5y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6096](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6096) + +*** + +### \_6m + +> **\_6m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6091](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6091) + +*** + +### \_6y + +> **\_6y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6097](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6097) + +*** + +### \_7y + +> **\_7y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6098](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6098) + +*** + +### \_8y + +> **\_8y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6099](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6099) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_OverAmount.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_OverAmount.md new file mode 100644 index 000000000..f3f7b0c17 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_OverAmount.md @@ -0,0 +1,113 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_OverAmount + +# Interface: SeriesTree\_Cohorts\_Utxo\_OverAmount + +Defined in: [Developer/brk/modules/brk-client/index.js:6136](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6136) + +## Properties + +### \_100btc + +> **\_100btc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6147](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6147) + +*** + +### \_100kSats + +> **\_100kSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6142](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6142) + +*** + +### \_100sats + +> **\_100sats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6139](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6139) + +*** + +### \_10btc + +> **\_10btc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6146](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6146) + +*** + +### \_10kBtc + +> **\_10kBtc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6149](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6149) + +*** + +### \_10kSats + +> **\_10kSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6141](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6141) + +*** + +### \_10mSats + +> **\_10mSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6144](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6144) + +*** + +### \_10sats + +> **\_10sats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6138](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6138) + +*** + +### \_1btc + +> **\_1btc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6145](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6145) + +*** + +### \_1kBtc + +> **\_1kBtc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6148](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6148) + +*** + +### \_1kSats + +> **\_1kSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6140](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6140) + +*** + +### \_1mSats + +> **\_1mSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6143](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6143) + +*** + +### \_1sat + +> **\_1sat**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6137](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6137) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability.md new file mode 100644 index 000000000..e39f43839 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Profitability + +# Interface: SeriesTree\_Cohorts\_Utxo\_Profitability + +Defined in: [Developer/brk/modules/brk-client/index.js:6204](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6204) + +## Properties + +### loss + +> **loss**: [`SeriesTree_Cohorts_Utxo_Profitability_Loss`](SeriesTree_Cohorts_Utxo_Profitability_Loss.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6207](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6207) + +*** + +### profit + +> **profit**: [`SeriesTree_Cohorts_Utxo_Profitability_Profit`](SeriesTree_Cohorts_Utxo_Profitability_Profit.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6206](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6206) + +*** + +### range + +> **range**: [`SeriesTree_Cohorts_Utxo_Profitability_Range`](SeriesTree_Cohorts_Utxo_Profitability_Range.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6205](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6205) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability_Loss.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability_Loss.md new file mode 100644 index 000000000..b69374c65 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability_Loss.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Profitability\_Loss + +# Interface: SeriesTree\_Cohorts\_Utxo\_Profitability\_Loss + +Defined in: [Developer/brk/modules/brk-client/index.js:6258](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6258) + +## Properties + +### \_10pct + +> **\_10pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6260](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6260) + +*** + +### \_20pct + +> **\_20pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6261](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6261) + +*** + +### \_30pct + +> **\_30pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6262](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6262) + +*** + +### \_40pct + +> **\_40pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6263](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6263) + +*** + +### \_50pct + +> **\_50pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6264](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6264) + +*** + +### \_60pct + +> **\_60pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6265](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6265) + +*** + +### \_70pct + +> **\_70pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6266](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6266) + +*** + +### \_80pct + +> **\_80pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6267](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6267) + +*** + +### all + +> **all**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6259](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6259) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability_Profit.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability_Profit.md new file mode 100644 index 000000000..7830b2cb9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability_Profit.md @@ -0,0 +1,121 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Profitability\_Profit + +# Interface: SeriesTree\_Cohorts\_Utxo\_Profitability\_Profit + +Defined in: [Developer/brk/modules/brk-client/index.js:6240](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6240) + +## Properties + +### \_100pct + +> **\_100pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6251](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6251) + +*** + +### \_10pct + +> **\_10pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6242](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6242) + +*** + +### \_200pct + +> **\_200pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6252](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6252) + +*** + +### \_20pct + +> **\_20pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6243](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6243) + +*** + +### \_300pct + +> **\_300pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6253](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6253) + +*** + +### \_30pct + +> **\_30pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6244](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6244) + +*** + +### \_40pct + +> **\_40pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6245](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6245) + +*** + +### \_500pct + +> **\_500pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6254](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6254) + +*** + +### \_50pct + +> **\_50pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6246](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6246) + +*** + +### \_60pct + +> **\_60pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6247](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6247) + +*** + +### \_70pct + +> **\_70pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6248](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6248) + +*** + +### \_80pct + +> **\_80pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6249](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6249) + +*** + +### \_90pct + +> **\_90pct**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6250](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6250) + +*** + +### all + +> **all**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6241](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6241) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability_Range.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability_Range.md new file mode 100644 index 000000000..3eb73d3ad --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Profitability_Range.md @@ -0,0 +1,209 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Profitability\_Range + +# Interface: SeriesTree\_Cohorts\_Utxo\_Profitability\_Range + +Defined in: [Developer/brk/modules/brk-client/index.js:6211](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6211) + +## Properties + +### \_0pctTo10pctInLoss + +> **\_0pctTo10pctInLoss**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6227](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6227) + +*** + +### \_0pctTo10pctInProfit + +> **\_0pctTo10pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6226](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6226) + +*** + +### \_100pctTo200pctInProfit + +> **\_100pctTo200pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6216](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6216) + +*** + +### \_10pctTo20pctInLoss + +> **\_10pctTo20pctInLoss**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6228](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6228) + +*** + +### \_10pctTo20pctInProfit + +> **\_10pctTo20pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6225](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6225) + +*** + +### \_200pctTo300pctInProfit + +> **\_200pctTo300pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6215](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6215) + +*** + +### \_20pctTo30pctInLoss + +> **\_20pctTo30pctInLoss**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6229](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6229) + +*** + +### \_20pctTo30pctInProfit + +> **\_20pctTo30pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6224](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6224) + +*** + +### \_300pctTo500pctInProfit + +> **\_300pctTo500pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6214](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6214) + +*** + +### \_30pctTo40pctInLoss + +> **\_30pctTo40pctInLoss**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6230](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6230) + +*** + +### \_30pctTo40pctInProfit + +> **\_30pctTo40pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6223](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6223) + +*** + +### \_40pctTo50pctInLoss + +> **\_40pctTo50pctInLoss**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6231](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6231) + +*** + +### \_40pctTo50pctInProfit + +> **\_40pctTo50pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6222](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6222) + +*** + +### \_500pctTo1000pctInProfit + +> **\_500pctTo1000pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6213](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6213) + +*** + +### \_50pctTo60pctInLoss + +> **\_50pctTo60pctInLoss**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6232](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6232) + +*** + +### \_50pctTo60pctInProfit + +> **\_50pctTo60pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6221](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6221) + +*** + +### \_60pctTo70pctInLoss + +> **\_60pctTo70pctInLoss**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6233](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6233) + +*** + +### \_60pctTo70pctInProfit + +> **\_60pctTo70pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6220](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6220) + +*** + +### \_70pctTo80pctInLoss + +> **\_70pctTo80pctInLoss**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6234](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6234) + +*** + +### \_70pctTo80pctInProfit + +> **\_70pctTo80pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6219](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6219) + +*** + +### \_80pctTo90pctInLoss + +> **\_80pctTo90pctInLoss**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6235](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6235) + +*** + +### \_80pctTo90pctInProfit + +> **\_80pctTo90pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6218](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6218) + +*** + +### \_90pctTo100pctInLoss + +> **\_90pctTo100pctInLoss**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6236](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6236) + +*** + +### \_90pctTo100pctInProfit + +> **\_90pctTo100pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6217](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6217) + +*** + +### over1000pctInProfit + +> **over1000pctInProfit**: [`NuplRealizedSupplyUnrealizedPattern`](NuplRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6212](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6212) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth.md new file mode 100644 index 000000000..284d091ea --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Sth + +# Interface: SeriesTree\_Cohorts\_Utxo\_Sth + +Defined in: [Developer/brk/modules/brk-client/index.js:5786](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5786) + +## Properties + +### activity + +> **activity**: [`CoindaysCoinyearsDormancyTransferPattern`](CoindaysCoinyearsDormancyTransferPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5789](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5789) + +*** + +### costBasis + +> **costBasis**: [`InMaxMinPerSupplyPattern`](InMaxMinPerSupplyPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5791](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5791) + +*** + +### outputs + +> **outputs**: [`SpendingSpentUnspentPattern`](SpendingSpentUnspentPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5788](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5788) + +*** + +### realized + +> **realized**: [`SeriesTree_Cohorts_Utxo_Sth_Realized`](SeriesTree_Cohorts_Utxo_Sth_Realized.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5790](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5790) + +*** + +### supply + +> **supply**: [`DeltaHalfInToTotalPattern2`](DeltaHalfInToTotalPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5787](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5787) + +*** + +### unrealized + +> **unrealized**: [`GrossInvestedInvestorLossNetNuplProfitSentimentPattern2`](GrossInvestedInvestorLossNetNuplProfitSentimentPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5792](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5792) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized.md new file mode 100644 index 000000000..57d30cf2a --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Sth\_Realized + +# Interface: SeriesTree\_Cohorts\_Utxo\_Sth\_Realized + +Defined in: [Developer/brk/modules/brk-client/index.js:5796](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5796) + +## Properties + +### cap + +> **cap**: [`CentsDeltaToUsdPattern`](CentsDeltaToUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5797](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5797) + +*** + +### grossPnl + +> **grossPnl**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5804](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5804) + +*** + +### investor + +> **investor**: [`PricePattern`](PricePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5807](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5807) + +*** + +### loss + +> **loss**: [`BlockCumulativeNegativeSumPattern`](BlockCumulativeNegativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5799](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5799) + +*** + +### mvrv + +> **mvrv**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5801](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5801) + +*** + +### netPnl + +> **netPnl**: [`BlockChangeCumulativeDeltaSumPattern`](BlockChangeCumulativeDeltaSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5802](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5802) + +*** + +### peakRegret + +> **peakRegret**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5806](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5806) + +*** + +### price + +> **price**: [`SeriesTree_Cohorts_Utxo_Sth_Realized_Price`](SeriesTree_Cohorts_Utxo_Sth_Realized_Price.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5800](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5800) + +*** + +### profit + +> **profit**: [`BlockCumulativeSumPattern`](BlockCumulativeSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5798](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5798) + +*** + +### profitToLossRatio + +> **profitToLossRatio**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5808](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5808) + +*** + +### sellSideRiskRatio + +> **sellSideRiskRatio**: [`_1m1w1y24hPattern7`](1m1w1y24hPattern7.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5805](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5805) + +*** + +### sopr + +> **sopr**: [`AdjustedRatioValuePattern`](AdjustedRatioValuePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5803](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5803) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price.md new file mode 100644 index 000000000..0237db752 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price + +# Interface: SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price + +Defined in: [Developer/brk/modules/brk-client/index.js:5812](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5812) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5816](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5816) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5814](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5814) + +*** + +### percentiles + +> **percentiles**: [`Pct1Pct2Pct5Pct95Pct98Pct99Pattern`](Pct1Pct2Pct5Pct95Pct98Pct99Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5818](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5818) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5817](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5817) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5815](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5815) + +*** + +### sma + +> **sma**: [`_1m1w1y2y4yAllPattern`](1m1w1y2y4yAllPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5819](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5819) + +*** + +### stdDev + +> **stdDev**: [`SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev`](SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5820](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5820) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5813](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5813) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev.md new file mode 100644 index 000000000..b4b4d229f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev + +# Interface: SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev + +Defined in: [Developer/brk/modules/brk-client/index.js:5824](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5824) + +## Properties + +### \_1y + +> **\_1y**: [`SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_1y`](SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_1y.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5828](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5828) + +*** + +### \_2y + +> **\_2y**: [`SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_2y`](SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_2y.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5827](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5827) + +*** + +### \_4y + +> **\_4y**: [`SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_4y`](SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_4y.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5826](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5826) + +*** + +### all + +> **all**: [`SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_All`](SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_All.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5825](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5825) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_1y.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_1y.md new file mode 100644 index 000000000..5a722afed --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_1y.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_1y + +# Interface: SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_1y + +Defined in: [Developer/brk/modules/brk-client/index.js:5889](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5889) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5892](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5892) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5899](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5899) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5901](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5901) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5900](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5900) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5903](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5903) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5902](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5902) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5904](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5904) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5893](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5893) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5895](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5895) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5894](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5894) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5897](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5897) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5896](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5896) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5898](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5898) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5890](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5890) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5891](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5891) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_2y.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_2y.md new file mode 100644 index 000000000..8f48b0fc7 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_2y.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_2y + +# Interface: SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_2y + +Defined in: [Developer/brk/modules/brk-client/index.js:5870](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5870) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5873](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5873) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5880](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5880) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5882](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5882) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5881](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5881) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5884](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5884) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5883](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5883) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5885](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5885) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5874](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5874) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5876](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5876) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5875](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5875) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5878](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5878) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5877](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5877) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5879](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5879) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5871](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5871) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5872](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5872) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_4y.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_4y.md new file mode 100644 index 000000000..509dbeb63 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_4y.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_4y + +# Interface: SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_4y + +Defined in: [Developer/brk/modules/brk-client/index.js:5851](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5851) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5854](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5854) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5861](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5861) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5863](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5863) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5862](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5862) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5865](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5865) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5864](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5864) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5866](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5866) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5855](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5855) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5857](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5857) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5856](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5856) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5859](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5859) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5858](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5858) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5860](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5860) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5852](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5852) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5853](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5853) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_All.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_All.md new file mode 100644 index 000000000..d27f9cd38 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Sth_Realized_Price_StdDev_All.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_All + +# Interface: SeriesTree\_Cohorts\_Utxo\_Sth\_Realized\_Price\_StdDev\_All + +Defined in: [Developer/brk/modules/brk-client/index.js:5832](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5832) + +## Properties + +### \_0sd + +> **\_0sd**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5835](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5835) + +*** + +### m05sd + +> **m05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5842](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5842) + +*** + +### m15sd + +> **m15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5844](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5844) + +*** + +### m1sd + +> **m1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5843](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5843) + +*** + +### m25sd + +> **m25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5846](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5846) + +*** + +### m2sd + +> **m2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5845](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5845) + +*** + +### m3sd + +> **m3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5847](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5847) + +*** + +### p05sd + +> **p05sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5836](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5836) + +*** + +### p15sd + +> **p15sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5838](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5838) + +*** + +### p1sd + +> **p1sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5837](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5837) + +*** + +### p25sd + +> **p25sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5840](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5840) + +*** + +### p2sd + +> **p2sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5839](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5839) + +*** + +### p3sd + +> **p3sd**: [`PriceRatioPattern`](PriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5841](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5841) + +*** + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5833](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5833) + +*** + +### zscore + +> **zscore**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5834](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5834) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Type.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Type.md new file mode 100644 index 000000000..82c487ce1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_Type.md @@ -0,0 +1,97 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_Type + +# Interface: SeriesTree\_Cohorts\_Utxo\_Type + +Defined in: [Developer/brk/modules/brk-client/index.js:6189](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6189) + +## Properties + +### empty + +> **empty**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6200](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6200) + +*** + +### p2a + +> **p2a**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6198](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6198) + +*** + +### p2ms + +> **p2ms**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6193](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6193) + +*** + +### p2pk33 + +> **p2pk33**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6191](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6191) + +*** + +### p2pk65 + +> **p2pk65**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6190](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6190) + +*** + +### p2pkh + +> **p2pkh**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6192](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6192) + +*** + +### p2sh + +> **p2sh**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6194](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6194) + +*** + +### p2tr + +> **p2tr**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6197](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6197) + +*** + +### p2wpkh + +> **p2wpkh**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6195](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6195) + +*** + +### p2wsh + +> **p2wsh**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6196](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6196) + +*** + +### unknown + +> **unknown**: [`ActivityOutputsRealizedSupplyUnrealizedPattern3`](ActivityOutputsRealizedSupplyUnrealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6199](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6199) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_UnderAge.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_UnderAge.md new file mode 100644 index 000000000..30734670a --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_UnderAge.md @@ -0,0 +1,153 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_UnderAge + +# Interface: SeriesTree\_Cohorts\_Utxo\_UnderAge + +Defined in: [Developer/brk/modules/brk-client/index.js:6061](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6061) + +## Properties + +### \_10y + +> **\_10y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6077](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6077) + +*** + +### \_12y + +> **\_12y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6078](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6078) + +*** + +### \_15y + +> **\_15y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6079](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6079) + +*** + +### \_1m + +> **\_1m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6063](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6063) + +*** + +### \_1w + +> **\_1w**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6062](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6062) + +*** + +### \_1y + +> **\_1y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6069](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6069) + +*** + +### \_2m + +> **\_2m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6064](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6064) + +*** + +### \_2y + +> **\_2y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6070](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6070) + +*** + +### \_3m + +> **\_3m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6065](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6065) + +*** + +### \_3y + +> **\_3y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6071](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6071) + +*** + +### \_4m + +> **\_4m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6066](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6066) + +*** + +### \_4y + +> **\_4y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6072](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6072) + +*** + +### \_5m + +> **\_5m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6067](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6067) + +*** + +### \_5y + +> **\_5y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6073](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6073) + +*** + +### \_6m + +> **\_6m**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6068](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6068) + +*** + +### \_6y + +> **\_6y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6074](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6074) + +*** + +### \_7y + +> **\_7y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6075](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6075) + +*** + +### \_8y + +> **\_8y**: [`ActivityOutputsRealizedSupplyUnrealizedPattern`](ActivityOutputsRealizedSupplyUnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6076](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6076) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_UnderAmount.md b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_UnderAmount.md new file mode 100644 index 000000000..381328e13 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cohorts_Utxo_UnderAmount.md @@ -0,0 +1,113 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cohorts\_Utxo\_UnderAmount + +# Interface: SeriesTree\_Cohorts\_Utxo\_UnderAmount + +Defined in: [Developer/brk/modules/brk-client/index.js:6172](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6172) + +## Properties + +### \_100btc + +> **\_100btc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6182](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6182) + +*** + +### \_100kBtc + +> **\_100kBtc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6185](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6185) + +*** + +### \_100kSats + +> **\_100kSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6177](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6177) + +*** + +### \_100sats + +> **\_100sats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6174](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6174) + +*** + +### \_10btc + +> **\_10btc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6181](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6181) + +*** + +### \_10kBtc + +> **\_10kBtc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6184](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6184) + +*** + +### \_10kSats + +> **\_10kSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6176](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6176) + +*** + +### \_10mSats + +> **\_10mSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6179](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6179) + +*** + +### \_10sats + +> **\_10sats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6173](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6173) + +*** + +### \_1btc + +> **\_1btc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6180](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6180) + +*** + +### \_1kBtc + +> **\_1kBtc**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6183](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6183) + +*** + +### \_1kSats + +> **\_1kSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6175](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6175) + +*** + +### \_1mSats + +> **\_1mSats**: [`ActivityOutputsRealizedSupplyUnrealizedPattern2`](ActivityOutputsRealizedSupplyUnrealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:6178](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L6178) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cointime.md b/modules/brk-client/docs/interfaces/SeriesTree_Cointime.md new file mode 100644 index 000000000..aafdddf39 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cointime.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cointime + +# Interface: SeriesTree\_Cointime + +Defined in: [Developer/brk/modules/brk-client/index.js:4662](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4662) + +## Properties + +### activity + +> **activity**: [`SeriesTree_Cointime_Activity`](SeriesTree_Cointime_Activity.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4663](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4663) + +*** + +### adjusted + +> **adjusted**: [`SeriesTree_Cointime_Adjusted`](SeriesTree_Cointime_Adjusted.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4668](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4668) + +*** + +### cap + +> **cap**: [`SeriesTree_Cointime_Cap`](SeriesTree_Cointime_Cap.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4666](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4666) + +*** + +### prices + +> **prices**: [`SeriesTree_Cointime_Prices`](SeriesTree_Cointime_Prices.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4667](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4667) + +*** + +### reserveRisk + +> **reserveRisk**: [`SeriesTree_Cointime_ReserveRisk`](SeriesTree_Cointime_ReserveRisk.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4669](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4669) + +*** + +### supply + +> **supply**: [`SeriesTree_Cointime_Supply`](SeriesTree_Cointime_Supply.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4664](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4664) + +*** + +### value + +> **value**: [`SeriesTree_Cointime_Value`](SeriesTree_Cointime_Value.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4665](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4665) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Activity.md b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Activity.md new file mode 100644 index 000000000..0a70f66e4 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Activity.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cointime\_Activity + +# Interface: SeriesTree\_Cointime\_Activity + +Defined in: [Developer/brk/modules/brk-client/index.js:4673](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4673) + +## Properties + +### coinblocksCreated + +> **coinblocksCreated**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4674](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4674) + +*** + +### coinblocksDestroyed + +> **coinblocksDestroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4679](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4679) + +*** + +### coinblocksStored + +> **coinblocksStored**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4675](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4675) + +*** + +### liveliness + +> **liveliness**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4676](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4676) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4678](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4678) + +*** + +### vaultedness + +> **vaultedness**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4677](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4677) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Adjusted.md b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Adjusted.md new file mode 100644 index 000000000..19bdd85b4 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Adjusted.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cointime\_Adjusted + +# Interface: SeriesTree\_Cointime\_Adjusted + +Defined in: [Developer/brk/modules/brk-client/index.js:4715](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4715) + +## Properties + +### inflationRate + +> **inflationRate**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4716](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4716) + +*** + +### txVelocityFiat + +> **txVelocityFiat**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4718](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4718) + +*** + +### txVelocityNative + +> **txVelocityNative**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4717](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4717) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Cap.md b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Cap.md new file mode 100644 index 000000000..ced7cdc2f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Cap.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cointime\_Cap + +# Interface: SeriesTree\_Cointime\_Cap + +Defined in: [Developer/brk/modules/brk-client/index.js:4697](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4697) + +## Properties + +### active + +> **active**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4701](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4701) + +*** + +### aviv + +> **aviv**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4703](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4703) + +*** + +### cointime + +> **cointime**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4702](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4702) + +*** + +### investor + +> **investor**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4699](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4699) + +*** + +### thermo + +> **thermo**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4698](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4698) + +*** + +### vaulted + +> **vaulted**: [`CentsUsdPattern3`](CentsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4700](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4700) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Prices.md b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Prices.md new file mode 100644 index 000000000..4530e787b --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Prices.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cointime\_Prices + +# Interface: SeriesTree\_Cointime\_Prices + +Defined in: [Developer/brk/modules/brk-client/index.js:4707](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4707) + +## Properties + +### active + +> **active**: [`BpsCentsPercentilesRatioSatsUsdPattern`](BpsCentsPercentilesRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4709](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4709) + +*** + +### cointime + +> **cointime**: [`BpsCentsPercentilesRatioSatsUsdPattern`](BpsCentsPercentilesRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4711](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4711) + +*** + +### trueMarketMean + +> **trueMarketMean**: [`BpsCentsPercentilesRatioSatsUsdPattern`](BpsCentsPercentilesRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4710](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4710) + +*** + +### vaulted + +> **vaulted**: [`BpsCentsPercentilesRatioSatsUsdPattern`](BpsCentsPercentilesRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4708](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4708) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cointime_ReserveRisk.md b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_ReserveRisk.md new file mode 100644 index 000000000..aba107d05 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_ReserveRisk.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cointime\_ReserveRisk + +# Interface: SeriesTree\_Cointime\_ReserveRisk + +Defined in: [Developer/brk/modules/brk-client/index.js:4722](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4722) + +## Properties + +### hodlBank + +> **hodlBank**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4725](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4725) + +*** + +### value + +> **value**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4723](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4723) + +*** + +### vocddMedian1y + +> **vocddMedian1y**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4724](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4724) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Supply.md b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Supply.md new file mode 100644 index 000000000..895185181 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Supply.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cointime\_Supply + +# Interface: SeriesTree\_Cointime\_Supply + +Defined in: [Developer/brk/modules/brk-client/index.js:4683](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4683) + +## Properties + +### active + +> **active**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4685](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4685) + +*** + +### vaulted + +> **vaulted**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4684](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4684) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Value.md b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Value.md new file mode 100644 index 000000000..6c6852997 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Cointime_Value.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Cointime\_Value + +# Interface: SeriesTree\_Cointime\_Value + +Defined in: [Developer/brk/modules/brk-client/index.js:4689](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4689) + +## Properties + +### created + +> **created**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4691](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4691) + +*** + +### destroyed + +> **destroyed**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4690](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4690) + +*** + +### stored + +> **stored**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4692](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4692) + +*** + +### vocdd + +> **vocdd**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4693](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4693) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Constants.md b/modules/brk-client/docs/interfaces/SeriesTree_Constants.md new file mode 100644 index 000000000..84b0d5a0a --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Constants.md @@ -0,0 +1,153 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Constants + +# Interface: SeriesTree\_Constants + +Defined in: [Developer/brk/modules/brk-client/index.js:4729](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4729) + +## Properties + +### \_0 + +> **\_0**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4730](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4730) + +*** + +### \_1 + +> **\_1**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4731](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4731) + +*** + +### \_100 + +> **\_100**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4742](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4742) + +*** + +### \_2 + +> **\_2**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4732](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4732) + +*** + +### \_20 + +> **\_20**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4735](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4735) + +*** + +### \_3 + +> **\_3**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4733](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4733) + +*** + +### \_30 + +> **\_30**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4736](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4736) + +*** + +### \_382 + +> **\_382**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4737](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4737) + +*** + +### \_4 + +> **\_4**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4734](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4734) + +*** + +### \_50 + +> **\_50**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4738](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4738) + +*** + +### \_600 + +> **\_600**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4743](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4743) + +*** + +### \_618 + +> **\_618**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4739](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4739) + +*** + +### \_70 + +> **\_70**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4740](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4740) + +*** + +### \_80 + +> **\_80**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4741](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4741) + +*** + +### minus1 + +> **minus1**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4744](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4744) + +*** + +### minus2 + +> **minus2**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4745](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4745) + +*** + +### minus3 + +> **minus3**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4746](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4746) + +*** + +### minus4 + +> **minus4**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4747](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4747) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes.md new file mode 100644 index 000000000..f63cd3c99 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes.md @@ -0,0 +1,169 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes + +# Interface: SeriesTree\_Indexes + +Defined in: [Developer/brk/modules/brk-client/index.js:4751](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4751) + +## Properties + +### addr + +> **addr**: [`SeriesTree_Indexes_Addr`](SeriesTree_Indexes_Addr.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4752](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4752) + +*** + +### day1 + +> **day1**: [`SeriesTree_Indexes_Day1`](SeriesTree_Indexes_Day1.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4761](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4761) + +*** + +### day3 + +> **day3**: [`SeriesTree_Indexes_Day3`](SeriesTree_Indexes_Day3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4762](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4762) + +*** + +### epoch + +> **epoch**: [`SeriesTree_Indexes_Epoch`](SeriesTree_Indexes_Epoch.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4754](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4754) + +*** + +### halving + +> **halving**: [`SeriesTree_Indexes_Halving`](SeriesTree_Indexes_Halving.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4755](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4755) + +*** + +### height + +> **height**: [`SeriesTree_Indexes_Height`](SeriesTree_Indexes_Height.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4753](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4753) + +*** + +### hour1 + +> **hour1**: [`SeriesTree_Indexes_Hour1`](SeriesTree_Indexes_Hour1.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4758](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4758) + +*** + +### hour12 + +> **hour12**: [`SeriesTree_Indexes_Hour12`](SeriesTree_Indexes_Hour12.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4760](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4760) + +*** + +### hour4 + +> **hour4**: [`SeriesTree_Indexes_Hour4`](SeriesTree_Indexes_Hour4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4759](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4759) + +*** + +### minute10 + +> **minute10**: [`SeriesTree_Indexes_Minute10`](SeriesTree_Indexes_Minute10.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4756](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4756) + +*** + +### minute30 + +> **minute30**: [`SeriesTree_Indexes_Minute30`](SeriesTree_Indexes_Minute30.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4757](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4757) + +*** + +### month1 + +> **month1**: [`SeriesTree_Indexes_Month1`](SeriesTree_Indexes_Month1.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4764](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4764) + +*** + +### month3 + +> **month3**: [`SeriesTree_Indexes_Month3`](SeriesTree_Indexes_Month3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4765](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4765) + +*** + +### month6 + +> **month6**: [`SeriesTree_Indexes_Month6`](SeriesTree_Indexes_Month6.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4766](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4766) + +*** + +### txIndex + +> **txIndex**: [`SeriesTree_Indexes_TxIndex`](SeriesTree_Indexes_TxIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4769](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4769) + +*** + +### txinIndex + +> **txinIndex**: [`SeriesTree_Indexes_TxinIndex`](SeriesTree_Indexes_TxinIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4770](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4770) + +*** + +### txoutIndex + +> **txoutIndex**: [`SeriesTree_Indexes_TxoutIndex`](SeriesTree_Indexes_TxoutIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4771](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4771) + +*** + +### week1 + +> **week1**: [`SeriesTree_Indexes_Week1`](SeriesTree_Indexes_Week1.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4763](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4763) + +*** + +### year1 + +> **year1**: [`SeriesTree_Indexes_Year1`](SeriesTree_Indexes_Year1.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4767](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4767) + +*** + +### year10 + +> **year10**: [`SeriesTree_Indexes_Year10`](SeriesTree_Indexes_Year10.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4768](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4768) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr.md new file mode 100644 index 000000000..c09216a21 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr + +# Interface: SeriesTree\_Indexes\_Addr + +Defined in: [Developer/brk/modules/brk-client/index.js:4775](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4775) + +## Properties + +### empty + +> **empty**: [`SeriesTree_Indexes_Addr_Empty`](SeriesTree_Indexes_Addr_Empty.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4785](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4785) + +*** + +### opReturn + +> **opReturn**: [`SeriesTree_Indexes_Addr_OpReturn`](SeriesTree_Indexes_Addr_OpReturn.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4787](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4787) + +*** + +### p2a + +> **p2a**: [`SeriesTree_Indexes_Addr_P2a`](SeriesTree_Indexes_Addr_P2a.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4783](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4783) + +*** + +### p2ms + +> **p2ms**: [`SeriesTree_Indexes_Addr_P2ms`](SeriesTree_Indexes_Addr_P2ms.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4784](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4784) + +*** + +### p2pk33 + +> **p2pk33**: [`SeriesTree_Indexes_Addr_P2pk33`](SeriesTree_Indexes_Addr_P2pk33.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4776](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4776) + +*** + +### p2pk65 + +> **p2pk65**: [`SeriesTree_Indexes_Addr_P2pk65`](SeriesTree_Indexes_Addr_P2pk65.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4777](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4777) + +*** + +### p2pkh + +> **p2pkh**: [`SeriesTree_Indexes_Addr_P2pkh`](SeriesTree_Indexes_Addr_P2pkh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4778](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4778) + +*** + +### p2sh + +> **p2sh**: [`SeriesTree_Indexes_Addr_P2sh`](SeriesTree_Indexes_Addr_P2sh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4779](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4779) + +*** + +### p2tr + +> **p2tr**: [`SeriesTree_Indexes_Addr_P2tr`](SeriesTree_Indexes_Addr_P2tr.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4780](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4780) + +*** + +### p2wpkh + +> **p2wpkh**: [`SeriesTree_Indexes_Addr_P2wpkh`](SeriesTree_Indexes_Addr_P2wpkh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4781](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4781) + +*** + +### p2wsh + +> **p2wsh**: [`SeriesTree_Indexes_Addr_P2wsh`](SeriesTree_Indexes_Addr_P2wsh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4782](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4782) + +*** + +### unknown + +> **unknown**: [`SeriesTree_Indexes_Addr_Unknown`](SeriesTree_Indexes_Addr_Unknown.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4786](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4786) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_Empty.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_Empty.md new file mode 100644 index 000000000..cd5c157db --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_Empty.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_Empty + +# Interface: SeriesTree\_Indexes\_Addr\_Empty + +Defined in: [Developer/brk/modules/brk-client/index.js:4844](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4844) + +## Properties + +### identity + +> **identity**: [`SeriesPattern22`](../type-aliases/SeriesPattern22.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4845](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4845) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_OpReturn.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_OpReturn.md new file mode 100644 index 000000000..9d5ac3138 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_OpReturn.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_OpReturn + +# Interface: SeriesTree\_Indexes\_Addr\_OpReturn + +Defined in: [Developer/brk/modules/brk-client/index.js:4854](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4854) + +## Properties + +### identity + +> **identity**: [`SeriesPattern23`](../type-aliases/SeriesPattern23.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4855](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4855) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2a.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2a.md new file mode 100644 index 000000000..92717bf91 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2a.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_P2a + +# Interface: SeriesTree\_Indexes\_Addr\_P2a + +Defined in: [Developer/brk/modules/brk-client/index.js:4833](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4833) + +## Properties + +### addr + +> **addr**: [`SeriesPattern24`](../type-aliases/SeriesPattern24.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4835](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4835) + +*** + +### identity + +> **identity**: [`SeriesPattern24`](../type-aliases/SeriesPattern24.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4834](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4834) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2ms.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2ms.md new file mode 100644 index 000000000..09033468d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2ms.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_P2ms + +# Interface: SeriesTree\_Indexes\_Addr\_P2ms + +Defined in: [Developer/brk/modules/brk-client/index.js:4839](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4839) + +## Properties + +### identity + +> **identity**: [`SeriesPattern25`](../type-aliases/SeriesPattern25.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4840](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4840) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2pk33.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2pk33.md new file mode 100644 index 000000000..7327200d1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2pk33.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_P2pk33 + +# Interface: SeriesTree\_Indexes\_Addr\_P2pk33 + +Defined in: [Developer/brk/modules/brk-client/index.js:4791](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4791) + +## Properties + +### addr + +> **addr**: [`SeriesPattern26`](../type-aliases/SeriesPattern26.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4793](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4793) + +*** + +### identity + +> **identity**: [`SeriesPattern26`](../type-aliases/SeriesPattern26.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4792](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4792) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2pk65.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2pk65.md new file mode 100644 index 000000000..e35c5eda1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2pk65.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_P2pk65 + +# Interface: SeriesTree\_Indexes\_Addr\_P2pk65 + +Defined in: [Developer/brk/modules/brk-client/index.js:4797](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4797) + +## Properties + +### addr + +> **addr**: [`SeriesPattern27`](../type-aliases/SeriesPattern27.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4799](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4799) + +*** + +### identity + +> **identity**: [`SeriesPattern27`](../type-aliases/SeriesPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4798](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4798) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2pkh.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2pkh.md new file mode 100644 index 000000000..0b22a115a --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2pkh.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_P2pkh + +# Interface: SeriesTree\_Indexes\_Addr\_P2pkh + +Defined in: [Developer/brk/modules/brk-client/index.js:4803](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4803) + +## Properties + +### addr + +> **addr**: [`SeriesPattern28`](../type-aliases/SeriesPattern28.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4805](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4805) + +*** + +### identity + +> **identity**: [`SeriesPattern28`](../type-aliases/SeriesPattern28.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4804](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4804) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2sh.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2sh.md new file mode 100644 index 000000000..928fb074e --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2sh.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_P2sh + +# Interface: SeriesTree\_Indexes\_Addr\_P2sh + +Defined in: [Developer/brk/modules/brk-client/index.js:4809](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4809) + +## Properties + +### addr + +> **addr**: [`SeriesPattern29`](../type-aliases/SeriesPattern29.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4811](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4811) + +*** + +### identity + +> **identity**: [`SeriesPattern29`](../type-aliases/SeriesPattern29.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4810](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4810) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2tr.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2tr.md new file mode 100644 index 000000000..a8e03124e --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2tr.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_P2tr + +# Interface: SeriesTree\_Indexes\_Addr\_P2tr + +Defined in: [Developer/brk/modules/brk-client/index.js:4815](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4815) + +## Properties + +### addr + +> **addr**: [`SeriesPattern30`](../type-aliases/SeriesPattern30.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4817](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4817) + +*** + +### identity + +> **identity**: [`SeriesPattern30`](../type-aliases/SeriesPattern30.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4816](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4816) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2wpkh.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2wpkh.md new file mode 100644 index 000000000..8499ebe64 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2wpkh.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_P2wpkh + +# Interface: SeriesTree\_Indexes\_Addr\_P2wpkh + +Defined in: [Developer/brk/modules/brk-client/index.js:4821](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4821) + +## Properties + +### addr + +> **addr**: [`SeriesPattern31`](../type-aliases/SeriesPattern31.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4823](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4823) + +*** + +### identity + +> **identity**: [`SeriesPattern31`](../type-aliases/SeriesPattern31.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4822](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4822) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2wsh.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2wsh.md new file mode 100644 index 000000000..675120c57 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_P2wsh.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_P2wsh + +# Interface: SeriesTree\_Indexes\_Addr\_P2wsh + +Defined in: [Developer/brk/modules/brk-client/index.js:4827](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4827) + +## Properties + +### addr + +> **addr**: [`SeriesPattern32`](../type-aliases/SeriesPattern32.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4829](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4829) + +*** + +### identity + +> **identity**: [`SeriesPattern32`](../type-aliases/SeriesPattern32.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4828](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4828) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_Unknown.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_Unknown.md new file mode 100644 index 000000000..f398cb1c7 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Addr_Unknown.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Addr\_Unknown + +# Interface: SeriesTree\_Indexes\_Addr\_Unknown + +Defined in: [Developer/brk/modules/brk-client/index.js:4849](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4849) + +## Properties + +### identity + +> **identity**: [`SeriesPattern33`](../type-aliases/SeriesPattern33.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4850](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4850) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Day1.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Day1.md new file mode 100644 index 000000000..4732c1dc8 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Day1.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Day1 + +# Interface: SeriesTree\_Indexes\_Day1 + +Defined in: [Developer/brk/modules/brk-client/index.js:4923](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4923) + +## Properties + +### date + +> **date**: [`SeriesPattern8`](../type-aliases/SeriesPattern8.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4925](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4925) + +*** + +### firstHeight + +> **firstHeight**: [`SeriesPattern8`](../type-aliases/SeriesPattern8.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4926](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4926) + +*** + +### heightCount + +> **heightCount**: [`SeriesPattern8`](../type-aliases/SeriesPattern8.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4927](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4927) + +*** + +### identity + +> **identity**: [`SeriesPattern8`](../type-aliases/SeriesPattern8.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4924](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4924) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Day3.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Day3.md new file mode 100644 index 000000000..01e3559cb --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Day3.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Day3 + +# Interface: SeriesTree\_Indexes\_Day3 + +Defined in: [Developer/brk/modules/brk-client/index.js:4931](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4931) + +## Properties + +### firstHeight + +> **firstHeight**: [`SeriesPattern9`](../type-aliases/SeriesPattern9.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4933](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4933) + +*** + +### identity + +> **identity**: [`SeriesPattern9`](../type-aliases/SeriesPattern9.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4932](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4932) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Epoch.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Epoch.md new file mode 100644 index 000000000..0ba22c3bf --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Epoch.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Epoch + +# Interface: SeriesTree\_Indexes\_Epoch + +Defined in: [Developer/brk/modules/brk-client/index.js:4880](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4880) + +## Properties + +### firstHeight + +> **firstHeight**: [`SeriesPattern17`](../type-aliases/SeriesPattern17.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4882](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4882) + +*** + +### heightCount + +> **heightCount**: [`SeriesPattern17`](../type-aliases/SeriesPattern17.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4883](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4883) + +*** + +### identity + +> **identity**: [`SeriesPattern17`](../type-aliases/SeriesPattern17.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4881](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4881) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Halving.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Halving.md new file mode 100644 index 000000000..b9c955e6e --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Halving.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Halving + +# Interface: SeriesTree\_Indexes\_Halving + +Defined in: [Developer/brk/modules/brk-client/index.js:4887](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4887) + +## Properties + +### firstHeight + +> **firstHeight**: [`SeriesPattern16`](../type-aliases/SeriesPattern16.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4889](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4889) + +*** + +### identity + +> **identity**: [`SeriesPattern16`](../type-aliases/SeriesPattern16.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4888](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4888) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Height.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Height.md new file mode 100644 index 000000000..b6a2c7ec1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Height.md @@ -0,0 +1,145 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Height + +# Interface: SeriesTree\_Indexes\_Height + +Defined in: [Developer/brk/modules/brk-client/index.js:4859](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4859) + +## Properties + +### day1 + +> **day1**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4866](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4866) + +*** + +### day3 + +> **day3**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4867](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4867) + +*** + +### epoch + +> **epoch**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4868](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4868) + +*** + +### halving + +> **halving**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4869](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4869) + +*** + +### hour1 + +> **hour1**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4863](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4863) + +*** + +### hour12 + +> **hour12**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4865](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4865) + +*** + +### hour4 + +> **hour4**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4864](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4864) + +*** + +### identity + +> **identity**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4860](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4860) + +*** + +### minute10 + +> **minute10**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4861](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4861) + +*** + +### minute30 + +> **minute30**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4862](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4862) + +*** + +### month1 + +> **month1**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4871](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4871) + +*** + +### month3 + +> **month3**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4872](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4872) + +*** + +### month6 + +> **month6**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4873](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4873) + +*** + +### txIndexCount + +> **txIndexCount**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4876](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4876) + +*** + +### week1 + +> **week1**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4870](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4870) + +*** + +### year1 + +> **year1**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4874](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4874) + +*** + +### year10 + +> **year10**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4875](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4875) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Hour1.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Hour1.md new file mode 100644 index 000000000..d05c3ce10 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Hour1.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Hour1 + +# Interface: SeriesTree\_Indexes\_Hour1 + +Defined in: [Developer/brk/modules/brk-client/index.js:4905](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4905) + +## Properties + +### firstHeight + +> **firstHeight**: [`SeriesPattern5`](../type-aliases/SeriesPattern5.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4907](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4907) + +*** + +### identity + +> **identity**: [`SeriesPattern5`](../type-aliases/SeriesPattern5.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4906](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4906) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Hour12.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Hour12.md new file mode 100644 index 000000000..7886aa06f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Hour12.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Hour12 + +# Interface: SeriesTree\_Indexes\_Hour12 + +Defined in: [Developer/brk/modules/brk-client/index.js:4917](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4917) + +## Properties + +### firstHeight + +> **firstHeight**: [`SeriesPattern7`](../type-aliases/SeriesPattern7.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4919](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4919) + +*** + +### identity + +> **identity**: [`SeriesPattern7`](../type-aliases/SeriesPattern7.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4918](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4918) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Hour4.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Hour4.md new file mode 100644 index 000000000..4d2765355 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Hour4.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Hour4 + +# Interface: SeriesTree\_Indexes\_Hour4 + +Defined in: [Developer/brk/modules/brk-client/index.js:4911](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4911) + +## Properties + +### firstHeight + +> **firstHeight**: [`SeriesPattern6`](../type-aliases/SeriesPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4913](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4913) + +*** + +### identity + +> **identity**: [`SeriesPattern6`](../type-aliases/SeriesPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4912](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4912) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Minute10.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Minute10.md new file mode 100644 index 000000000..680e6a438 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Minute10.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Minute10 + +# Interface: SeriesTree\_Indexes\_Minute10 + +Defined in: [Developer/brk/modules/brk-client/index.js:4893](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4893) + +## Properties + +### firstHeight + +> **firstHeight**: [`SeriesPattern3`](../type-aliases/SeriesPattern3.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4895](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4895) + +*** + +### identity + +> **identity**: [`SeriesPattern3`](../type-aliases/SeriesPattern3.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4894](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4894) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Minute30.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Minute30.md new file mode 100644 index 000000000..bd4c632ff --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Minute30.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Minute30 + +# Interface: SeriesTree\_Indexes\_Minute30 + +Defined in: [Developer/brk/modules/brk-client/index.js:4899](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4899) + +## Properties + +### firstHeight + +> **firstHeight**: [`SeriesPattern4`](../type-aliases/SeriesPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4901](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4901) + +*** + +### identity + +> **identity**: [`SeriesPattern4`](../type-aliases/SeriesPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4900](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4900) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Month1.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Month1.md new file mode 100644 index 000000000..39f1ee5be --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Month1.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Month1 + +# Interface: SeriesTree\_Indexes\_Month1 + +Defined in: [Developer/brk/modules/brk-client/index.js:4944](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4944) + +## Properties + +### date + +> **date**: [`SeriesPattern11`](../type-aliases/SeriesPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4946](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4946) + +*** + +### firstHeight + +> **firstHeight**: [`SeriesPattern11`](../type-aliases/SeriesPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4947](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4947) + +*** + +### identity + +> **identity**: [`SeriesPattern11`](../type-aliases/SeriesPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4945](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4945) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Month3.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Month3.md new file mode 100644 index 000000000..e586ccc77 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Month3.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Month3 + +# Interface: SeriesTree\_Indexes\_Month3 + +Defined in: [Developer/brk/modules/brk-client/index.js:4951](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4951) + +## Properties + +### date + +> **date**: [`SeriesPattern12`](../type-aliases/SeriesPattern12.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4953](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4953) + +*** + +### firstHeight + +> **firstHeight**: [`SeriesPattern12`](../type-aliases/SeriesPattern12.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4954](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4954) + +*** + +### identity + +> **identity**: [`SeriesPattern12`](../type-aliases/SeriesPattern12.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4952](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4952) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Month6.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Month6.md new file mode 100644 index 000000000..bd9efc819 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Month6.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Month6 + +# Interface: SeriesTree\_Indexes\_Month6 + +Defined in: [Developer/brk/modules/brk-client/index.js:4958](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4958) + +## Properties + +### date + +> **date**: [`SeriesPattern13`](../type-aliases/SeriesPattern13.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4960](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4960) + +*** + +### firstHeight + +> **firstHeight**: [`SeriesPattern13`](../type-aliases/SeriesPattern13.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4961](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4961) + +*** + +### identity + +> **identity**: [`SeriesPattern13`](../type-aliases/SeriesPattern13.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4959](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4959) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_TxIndex.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_TxIndex.md new file mode 100644 index 000000000..d7e5e2148 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_TxIndex.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_TxIndex + +# Interface: SeriesTree\_Indexes\_TxIndex + +Defined in: [Developer/brk/modules/brk-client/index.js:4979](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4979) + +## Properties + +### identity + +> **identity**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4980](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4980) + +*** + +### inputCount + +> **inputCount**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4981](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4981) + +*** + +### outputCount + +> **outputCount**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4982](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4982) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_TxinIndex.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_TxinIndex.md new file mode 100644 index 000000000..f461ad87e --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_TxinIndex.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_TxinIndex + +# Interface: SeriesTree\_Indexes\_TxinIndex + +Defined in: [Developer/brk/modules/brk-client/index.js:4986](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4986) + +## Properties + +### identity + +> **identity**: [`SeriesPattern20`](../type-aliases/SeriesPattern20.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4987](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4987) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_TxoutIndex.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_TxoutIndex.md new file mode 100644 index 000000000..817f1fe7b --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_TxoutIndex.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_TxoutIndex + +# Interface: SeriesTree\_Indexes\_TxoutIndex + +Defined in: [Developer/brk/modules/brk-client/index.js:4991](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4991) + +## Properties + +### identity + +> **identity**: [`SeriesPattern21`](../type-aliases/SeriesPattern21.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4992](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4992) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Week1.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Week1.md new file mode 100644 index 000000000..85bfe635a --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Week1.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Week1 + +# Interface: SeriesTree\_Indexes\_Week1 + +Defined in: [Developer/brk/modules/brk-client/index.js:4937](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4937) + +## Properties + +### date + +> **date**: [`SeriesPattern10`](../type-aliases/SeriesPattern10.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4939](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4939) + +*** + +### firstHeight + +> **firstHeight**: [`SeriesPattern10`](../type-aliases/SeriesPattern10.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4940](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4940) + +*** + +### identity + +> **identity**: [`SeriesPattern10`](../type-aliases/SeriesPattern10.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4938](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4938) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Year1.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Year1.md new file mode 100644 index 000000000..863efa316 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Year1.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Year1 + +# Interface: SeriesTree\_Indexes\_Year1 + +Defined in: [Developer/brk/modules/brk-client/index.js:4965](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4965) + +## Properties + +### date + +> **date**: [`SeriesPattern14`](../type-aliases/SeriesPattern14.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4967](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4967) + +*** + +### firstHeight + +> **firstHeight**: [`SeriesPattern14`](../type-aliases/SeriesPattern14.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4968](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4968) + +*** + +### identity + +> **identity**: [`SeriesPattern14`](../type-aliases/SeriesPattern14.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4966](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4966) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Year10.md b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Year10.md new file mode 100644 index 000000000..84f4b7bc9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indexes_Year10.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indexes\_Year10 + +# Interface: SeriesTree\_Indexes\_Year10 + +Defined in: [Developer/brk/modules/brk-client/index.js:4972](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4972) + +## Properties + +### date + +> **date**: [`SeriesPattern15`](../type-aliases/SeriesPattern15.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4974](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4974) + +*** + +### firstHeight + +> **firstHeight**: [`SeriesPattern15`](../type-aliases/SeriesPattern15.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4975](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4975) + +*** + +### identity + +> **identity**: [`SeriesPattern15`](../type-aliases/SeriesPattern15.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4973](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4973) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indicators.md b/modules/brk-client/docs/interfaces/SeriesTree_Indicators.md new file mode 100644 index 000000000..df9be9198 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indicators.md @@ -0,0 +1,89 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indicators + +# Interface: SeriesTree\_Indicators + +Defined in: [Developer/brk/modules/brk-client/index.js:4996](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4996) + +## Properties + +### coindaysDestroyedSupplyAdjusted + +> **coindaysDestroyedSupplyAdjusted**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5002](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5002) + +*** + +### coinyearsDestroyedSupplyAdjusted + +> **coinyearsDestroyedSupplyAdjusted**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5003](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5003) + +*** + +### dormancy + +> **dormancy**: [`SeriesTree_Indicators_Dormancy`](SeriesTree_Indicators_Dormancy.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5004](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5004) + +*** + +### gini + +> **gini**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4999](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4999) + +*** + +### nvt + +> **nvt**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4998](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4998) + +*** + +### puellMultiple + +> **puellMultiple**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4997](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4997) + +*** + +### rhodlRatio + +> **rhodlRatio**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5000](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5000) + +*** + +### sellerExhaustion + +> **sellerExhaustion**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5006](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5006) + +*** + +### stockToFlow + +> **stockToFlow**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5005](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5005) + +*** + +### thermoCapMultiple + +> **thermoCapMultiple**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5001](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5001) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Indicators_Dormancy.md b/modules/brk-client/docs/interfaces/SeriesTree_Indicators_Dormancy.md new file mode 100644 index 000000000..7dad4d452 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Indicators_Dormancy.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Indicators\_Dormancy + +# Interface: SeriesTree\_Indicators\_Dormancy + +Defined in: [Developer/brk/modules/brk-client/index.js:5010](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5010) + +## Properties + +### flow + +> **flow**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5012](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5012) + +*** + +### supplyAdjusted + +> **supplyAdjusted**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5011](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5011) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Inputs.md b/modules/brk-client/docs/interfaces/SeriesTree_Inputs.md new file mode 100644 index 000000000..e21d1b71d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Inputs.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Inputs + +# Interface: SeriesTree\_Inputs + +Defined in: [Developer/brk/modules/brk-client/index.js:4346](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4346) + +## Properties + +### count + +> **count**: [`CumulativeRollingSumPattern`](CumulativeRollingSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4349](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4349) + +*** + +### raw + +> **raw**: [`SeriesTree_Inputs_Raw`](SeriesTree_Inputs_Raw.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4347](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4347) + +*** + +### spent + +> **spent**: [`SeriesTree_Inputs_Spent`](SeriesTree_Inputs_Spent.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4348](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4348) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Inputs_Raw.md b/modules/brk-client/docs/interfaces/SeriesTree_Inputs_Raw.md new file mode 100644 index 000000000..5b879ce19 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Inputs_Raw.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Inputs\_Raw + +# Interface: SeriesTree\_Inputs\_Raw + +Defined in: [Developer/brk/modules/brk-client/index.js:4353](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4353) + +## Properties + +### firstTxinIndex + +> **firstTxinIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4354](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4354) + +*** + +### outpoint + +> **outpoint**: [`SeriesPattern20`](../type-aliases/SeriesPattern20.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4355](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4355) + +*** + +### outputType + +> **outputType**: [`SeriesPattern20`](../type-aliases/SeriesPattern20.md)\<[`OutputType`](../type-aliases/OutputType.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4357](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4357) + +*** + +### txIndex + +> **txIndex**: [`SeriesPattern20`](../type-aliases/SeriesPattern20.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4356](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4356) + +*** + +### typeIndex + +> **typeIndex**: [`SeriesPattern20`](../type-aliases/SeriesPattern20.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4358](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4358) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Inputs_Spent.md b/modules/brk-client/docs/interfaces/SeriesTree_Inputs_Spent.md new file mode 100644 index 000000000..743b83f91 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Inputs_Spent.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Inputs\_Spent + +# Interface: SeriesTree\_Inputs\_Spent + +Defined in: [Developer/brk/modules/brk-client/index.js:4362](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4362) + +## Properties + +### txoutIndex + +> **txoutIndex**: [`SeriesPattern20`](../type-aliases/SeriesPattern20.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4363](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4363) + +*** + +### value + +> **value**: [`SeriesPattern20`](../type-aliases/SeriesPattern20.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4364](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4364) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market.md b/modules/brk-client/docs/interfaces/SeriesTree_Market.md new file mode 100644 index 000000000..faa85ec1c --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market + +# Interface: SeriesTree\_Market + +Defined in: [Developer/brk/modules/brk-client/index.js:5016](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5016) + +## Properties + +### ath + +> **ath**: [`SeriesTree_Market_Ath`](SeriesTree_Market_Ath.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5017](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5017) + +*** + +### dca + +> **dca**: [`SeriesTree_Market_Dca`](SeriesTree_Market_Dca.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5023](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5023) + +*** + +### lookback + +> **lookback**: [`SeriesTree_Market_Lookback`](SeriesTree_Market_Lookback.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5018](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5018) + +*** + +### movingAverage + +> **movingAverage**: [`SeriesTree_Market_MovingAverage`](SeriesTree_Market_MovingAverage.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5022](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5022) + +*** + +### range + +> **range**: [`SeriesTree_Market_Range`](SeriesTree_Market_Range.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5021](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5021) + +*** + +### returns + +> **returns**: [`SeriesTree_Market_Returns`](SeriesTree_Market_Returns.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5019](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5019) + +*** + +### technical + +> **technical**: [`SeriesTree_Market_Technical`](SeriesTree_Market_Technical.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5024](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5024) + +*** + +### volatility + +> **volatility**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5020](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5020) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Ath.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Ath.md new file mode 100644 index 000000000..07b7a2cce --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Ath.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Ath + +# Interface: SeriesTree\_Market\_Ath + +Defined in: [Developer/brk/modules/brk-client/index.js:5028](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5028) + +## Properties + +### daysSince + +> **daysSince**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5031](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5031) + +*** + +### drawdown + +> **drawdown**: [`BpsPercentRatioPattern5`](BpsPercentRatioPattern5.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5030](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5030) + +*** + +### high + +> **high**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5029](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5029) + +*** + +### maxDaysBetween + +> **maxDaysBetween**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5033](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5033) + +*** + +### maxYearsBetween + +> **maxYearsBetween**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5034](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5034) + +*** + +### yearsSince + +> **yearsSince**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5032](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5032) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca.md new file mode 100644 index 000000000..17193d9d1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Dca + +# Interface: SeriesTree\_Market\_Dca + +Defined in: [Developer/brk/modules/brk-client/index.js:5187](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5187) + +## Properties + +### class + +> **class**: [`SeriesTree_Market_Dca_Class`](SeriesTree_Market_Dca_Class.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5190](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5190) + +*** + +### period + +> **period**: [`SeriesTree_Market_Dca_Period`](SeriesTree_Market_Dca_Period.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5189](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5189) + +*** + +### satsPerDay + +> **satsPerDay**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5188](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5188) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class.md new file mode 100644 index 000000000..15f33b0b3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Dca\_Class + +# Interface: SeriesTree\_Market\_Dca\_Class + +Defined in: [Developer/brk/modules/brk-client/index.js:5220](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5220) + +## Properties + +### costBasis + +> **costBasis**: [`SeriesTree_Market_Dca_Class_CostBasis`](SeriesTree_Market_Dca_Class_CostBasis.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5222](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5222) + +*** + +### return + +> **return**: [`SeriesTree_Market_Dca_Class_Return`](SeriesTree_Market_Dca_Class_Return.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5223](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5223) + +*** + +### stack + +> **stack**: [`SeriesTree_Market_Dca_Class_Stack`](SeriesTree_Market_Dca_Class_Stack.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5221](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5221) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class_CostBasis.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class_CostBasis.md new file mode 100644 index 000000000..3be570046 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class_CostBasis.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Dca\_Class\_CostBasis + +# Interface: SeriesTree\_Market\_Dca\_Class\_CostBasis + +Defined in: [Developer/brk/modules/brk-client/index.js:5243](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5243) + +## Properties + +### from2015 + +> **from2015**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5244](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5244) + +*** + +### from2016 + +> **from2016**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5245](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5245) + +*** + +### from2017 + +> **from2017**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5246](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5246) + +*** + +### from2018 + +> **from2018**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5247](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5247) + +*** + +### from2019 + +> **from2019**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5248](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5248) + +*** + +### from2020 + +> **from2020**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5249](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5249) + +*** + +### from2021 + +> **from2021**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5250](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5250) + +*** + +### from2022 + +> **from2022**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5251](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5251) + +*** + +### from2023 + +> **from2023**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5252](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5252) + +*** + +### from2024 + +> **from2024**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5253](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5253) + +*** + +### from2025 + +> **from2025**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5254](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5254) + +*** + +### from2026 + +> **from2026**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5255](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5255) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class_Return.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class_Return.md new file mode 100644 index 000000000..dd0b6b3ac --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class_Return.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Dca\_Class\_Return + +# Interface: SeriesTree\_Market\_Dca\_Class\_Return + +Defined in: [Developer/brk/modules/brk-client/index.js:5259](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5259) + +## Properties + +### from2015 + +> **from2015**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5260](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5260) + +*** + +### from2016 + +> **from2016**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5261](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5261) + +*** + +### from2017 + +> **from2017**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5262](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5262) + +*** + +### from2018 + +> **from2018**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5263](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5263) + +*** + +### from2019 + +> **from2019**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5264](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5264) + +*** + +### from2020 + +> **from2020**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5265](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5265) + +*** + +### from2021 + +> **from2021**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5266](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5266) + +*** + +### from2022 + +> **from2022**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5267](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5267) + +*** + +### from2023 + +> **from2023**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5268](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5268) + +*** + +### from2024 + +> **from2024**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5269](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5269) + +*** + +### from2025 + +> **from2025**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5270](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5270) + +*** + +### from2026 + +> **from2026**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5271](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5271) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class_Stack.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class_Stack.md new file mode 100644 index 000000000..437ab085d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Class_Stack.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Dca\_Class\_Stack + +# Interface: SeriesTree\_Market\_Dca\_Class\_Stack + +Defined in: [Developer/brk/modules/brk-client/index.js:5227](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5227) + +## Properties + +### from2015 + +> **from2015**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5228](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5228) + +*** + +### from2016 + +> **from2016**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5229](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5229) + +*** + +### from2017 + +> **from2017**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5230](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5230) + +*** + +### from2018 + +> **from2018**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5231](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5231) + +*** + +### from2019 + +> **from2019**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5232](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5232) + +*** + +### from2020 + +> **from2020**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5233](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5233) + +*** + +### from2021 + +> **from2021**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5234](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5234) + +*** + +### from2022 + +> **from2022**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5235](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5235) + +*** + +### from2023 + +> **from2023**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5236](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5236) + +*** + +### from2024 + +> **from2024**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5237](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5237) + +*** + +### from2025 + +> **from2025**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5238](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5238) + +*** + +### from2026 + +> **from2026**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5239](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5239) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Period.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Period.md new file mode 100644 index 000000000..722761383 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Period.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Dca\_Period + +# Interface: SeriesTree\_Market\_Dca\_Period + +Defined in: [Developer/brk/modules/brk-client/index.js:5194](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5194) + +## Properties + +### cagr + +> **cagr**: [`_10y2y3y4y5y6y8yPattern`](10y2y3y4y5y6y8yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5198](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5198) + +*** + +### costBasis + +> **costBasis**: [`SeriesTree_Market_Dca_Period_CostBasis`](SeriesTree_Market_Dca_Period_CostBasis.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5196](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5196) + +*** + +### lumpSumReturn + +> **lumpSumReturn**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5200](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5200) + +*** + +### lumpSumStack + +> **lumpSumStack**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern3`](10y1m1w1y2y3m3y4y5y6m6y8yPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5199](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5199) + +*** + +### return + +> **return**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern2`](10y1m1w1y2y3m3y4y5y6m6y8yPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5197](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5197) + +*** + +### stack + +> **stack**: [`_10y1m1w1y2y3m3y4y5y6m6y8yPattern3`](10y1m1w1y2y3m3y4y5y6m6y8yPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5195](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5195) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Period_CostBasis.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Period_CostBasis.md new file mode 100644 index 000000000..38af6e99d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Dca_Period_CostBasis.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Dca\_Period\_CostBasis + +# Interface: SeriesTree\_Market\_Dca\_Period\_CostBasis + +Defined in: [Developer/brk/modules/brk-client/index.js:5204](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5204) + +## Properties + +### \_10y + +> **\_10y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5216](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5216) + +*** + +### \_1m + +> **\_1m**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5206](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5206) + +*** + +### \_1w + +> **\_1w**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5205](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5205) + +*** + +### \_1y + +> **\_1y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5209](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5209) + +*** + +### \_2y + +> **\_2y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5210](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5210) + +*** + +### \_3m + +> **\_3m**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5207](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5207) + +*** + +### \_3y + +> **\_3y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5211](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5211) + +*** + +### \_4y + +> **\_4y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5212](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5212) + +*** + +### \_5y + +> **\_5y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5213](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5213) + +*** + +### \_6m + +> **\_6m**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5208](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5208) + +*** + +### \_6y + +> **\_6y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5214](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5214) + +*** + +### \_8y + +> **\_8y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5215](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5215) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Lookback.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Lookback.md new file mode 100644 index 000000000..f900f8000 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Lookback.md @@ -0,0 +1,113 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Lookback + +# Interface: SeriesTree\_Market\_Lookback + +Defined in: [Developer/brk/modules/brk-client/index.js:5038](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5038) + +## Properties + +### \_10y + +> **\_10y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5051](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5051) + +*** + +### \_1m + +> **\_1m**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5041](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5041) + +*** + +### \_1w + +> **\_1w**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5040](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5040) + +*** + +### \_1y + +> **\_1y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5044](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5044) + +*** + +### \_24h + +> **\_24h**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5039](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5039) + +*** + +### \_2y + +> **\_2y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5045](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5045) + +*** + +### \_3m + +> **\_3m**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5042](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5042) + +*** + +### \_3y + +> **\_3y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5046](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5046) + +*** + +### \_4y + +> **\_4y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5047](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5047) + +*** + +### \_5y + +> **\_5y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5048](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5048) + +*** + +### \_6m + +> **\_6m**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5043](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5043) + +*** + +### \_6y + +> **\_6y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5049](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5049) + +*** + +### \_8y + +> **\_8y**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5050](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5050) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage.md new file mode 100644 index 000000000..6d5c9bb2a --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_MovingAverage + +# Interface: SeriesTree\_Market\_MovingAverage + +Defined in: [Developer/brk/modules/brk-client/index.js:5120](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5120) + +## Properties + +### ema + +> **ema**: [`SeriesTree_Market_MovingAverage_Ema`](SeriesTree_Market_MovingAverage_Ema.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5122](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5122) + +*** + +### sma + +> **sma**: [`SeriesTree_Market_MovingAverage_Sma`](SeriesTree_Market_MovingAverage_Sma.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5121](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5121) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Ema.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Ema.md new file mode 100644 index 000000000..bee46cac4 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Ema.md @@ -0,0 +1,137 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_MovingAverage\_Ema + +# Interface: SeriesTree\_Market\_MovingAverage\_Ema + +Defined in: [Developer/brk/modules/brk-client/index.js:5167](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5167) + +## Properties + +### \_12d + +> **\_12d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5170](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5170) + +*** + +### \_13d + +> **\_13d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5171](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5171) + +*** + +### \_144d + +> **\_144d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5178](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5178) + +*** + +### \_1m + +> **\_1m**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5174](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5174) + +*** + +### \_1w + +> **\_1w**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5168](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5168) + +*** + +### \_1y + +> **\_1y**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5180](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5180) + +*** + +### \_200d + +> **\_200d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5179](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5179) + +*** + +### \_200w + +> **\_200w**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5182](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5182) + +*** + +### \_21d + +> **\_21d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5172](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5172) + +*** + +### \_26d + +> **\_26d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5173](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5173) + +*** + +### \_2y + +> **\_2y**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5181](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5181) + +*** + +### \_34d + +> **\_34d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5175](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5175) + +*** + +### \_4y + +> **\_4y**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5183](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5183) + +*** + +### \_55d + +> **\_55d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5176](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5176) + +*** + +### \_89d + +> **\_89d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5177](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5177) + +*** + +### \_8d + +> **\_8d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5169](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5169) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Sma.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Sma.md new file mode 100644 index 000000000..0133b803d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Sma.md @@ -0,0 +1,137 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_MovingAverage\_Sma + +# Interface: SeriesTree\_Market\_MovingAverage\_Sma + +Defined in: [Developer/brk/modules/brk-client/index.js:5126](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5126) + +## Properties + +### \_111d + +> **\_111d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5135](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5135) + +*** + +### \_13d + +> **\_13d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5129](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5129) + +*** + +### \_144d + +> **\_144d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5136](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5136) + +*** + +### \_1m + +> **\_1m**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5131](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5131) + +*** + +### \_1w + +> **\_1w**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5127](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5127) + +*** + +### \_1y + +> **\_1y**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5139](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5139) + +*** + +### \_200d + +> **\_200d**: [`SeriesTree_Market_MovingAverage_Sma_200d`](SeriesTree_Market_MovingAverage_Sma_200d.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5137](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5137) + +*** + +### \_200w + +> **\_200w**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5141](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5141) + +*** + +### \_21d + +> **\_21d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5130](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5130) + +*** + +### \_2y + +> **\_2y**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5140](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5140) + +*** + +### \_34d + +> **\_34d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5132](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5132) + +*** + +### \_350d + +> **\_350d**: [`SeriesTree_Market_MovingAverage_Sma_350d`](SeriesTree_Market_MovingAverage_Sma_350d.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5138](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5138) + +*** + +### \_4y + +> **\_4y**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5142](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5142) + +*** + +### \_55d + +> **\_55d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5133](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5133) + +*** + +### \_89d + +> **\_89d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5134](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5134) + +*** + +### \_8d + +> **\_8d**: [`BpsCentsRatioSatsUsdPattern`](BpsCentsRatioSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5128](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5128) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Sma_200d.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Sma_200d.md new file mode 100644 index 000000000..bcd8da0ad --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Sma_200d.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_MovingAverage\_Sma\_200d + +# Interface: SeriesTree\_Market\_MovingAverage\_Sma\_200d + +Defined in: [Developer/brk/modules/brk-client/index.js:5146](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5146) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5150](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5150) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5148](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5148) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5151](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5151) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5149](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5149) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5147](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5147) + +*** + +### x08 + +> **x08**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5153](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5153) + +*** + +### x24 + +> **x24**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5152](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5152) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Sma_350d.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Sma_350d.md new file mode 100644 index 000000000..592a616dd --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_MovingAverage_Sma_350d.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_MovingAverage\_Sma\_350d + +# Interface: SeriesTree\_Market\_MovingAverage\_Sma\_350d + +Defined in: [Developer/brk/modules/brk-client/index.js:5157](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5157) + +## Properties + +### bps + +> **bps**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5161](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5161) + +*** + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5159](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5159) + +*** + +### ratio + +> **ratio**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5162](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5162) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5160](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5160) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5158](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5158) + +*** + +### x2 + +> **x2**: [`CentsSatsUsdPattern`](CentsSatsUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5163](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5163) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Range.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Range.md new file mode 100644 index 000000000..56bae4d2f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Range.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Range + +# Interface: SeriesTree\_Market\_Range + +Defined in: [Developer/brk/modules/brk-client/index.js:5111](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5111) + +## Properties + +### choppinessIndex2w + +> **choppinessIndex2w**: [`BpsPercentRatioPattern3`](BpsPercentRatioPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5116](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5116) + +*** + +### max + +> **max**: [`_1m1w1y2wPattern`](1m1w1y2wPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5113](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5113) + +*** + +### min + +> **min**: [`_1m1w1y2wPattern`](1m1w1y2wPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5112](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5112) + +*** + +### trueRange + +> **trueRange**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5114](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5114) + +*** + +### trueRangeSum2w + +> **trueRangeSum2w**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5115](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5115) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns.md new file mode 100644 index 000000000..ab71119d8 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Returns + +# Interface: SeriesTree\_Market\_Returns + +Defined in: [Developer/brk/modules/brk-client/index.js:5055](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5055) + +## Properties + +### cagr + +> **cagr**: [`_10y2y3y4y5y6y8yPattern`](10y2y3y4y5y6y8yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5057](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5057) + +*** + +### periods + +> **periods**: [`SeriesTree_Market_Returns_Periods`](SeriesTree_Market_Returns_Periods.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5056](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5056) + +*** + +### sd24h + +> **sd24h**: [`SeriesTree_Market_Returns_Sd24h`](SeriesTree_Market_Returns_Sd24h.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5058](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5058) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Periods.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Periods.md new file mode 100644 index 000000000..4e4e01df3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Periods.md @@ -0,0 +1,113 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Returns\_Periods + +# Interface: SeriesTree\_Market\_Returns\_Periods + +Defined in: [Developer/brk/modules/brk-client/index.js:5062](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5062) + +## Properties + +### \_10y + +> **\_10y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5075](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5075) + +*** + +### \_1m + +> **\_1m**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5065](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5065) + +*** + +### \_1w + +> **\_1w**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5064](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5064) + +*** + +### \_1y + +> **\_1y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5068](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5068) + +*** + +### \_24h + +> **\_24h**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5063](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5063) + +*** + +### \_2y + +> **\_2y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5069](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5069) + +*** + +### \_3m + +> **\_3m**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5066](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5066) + +*** + +### \_3y + +> **\_3y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5070](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5070) + +*** + +### \_4y + +> **\_4y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5071](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5071) + +*** + +### \_5y + +> **\_5y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5072](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5072) + +*** + +### \_6m + +> **\_6m**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5067](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5067) + +*** + +### \_6y + +> **\_6y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5073](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5073) + +*** + +### \_8y + +> **\_8y**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5074](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5074) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h.md new file mode 100644 index 000000000..e0e0c437d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Returns\_Sd24h + +# Interface: SeriesTree\_Market\_Returns\_Sd24h + +Defined in: [Developer/brk/modules/brk-client/index.js:5079](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5079) + +## Properties + +### \_1m + +> **\_1m**: [`SeriesTree_Market_Returns_Sd24h_1m`](SeriesTree_Market_Returns_Sd24h_1m.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5082](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5082) + +*** + +### \_1w + +> **\_1w**: [`SeriesTree_Market_Returns_Sd24h_1w`](SeriesTree_Market_Returns_Sd24h_1w.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5081](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5081) + +*** + +### \_1y + +> **\_1y**: [`SeriesTree_Market_Returns_Sd24h_1y`](SeriesTree_Market_Returns_Sd24h_1y.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5083](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5083) + +*** + +### \_24h + +> **\_24h**: [`SeriesTree_Market_Returns_Sd24h_24h`](SeriesTree_Market_Returns_Sd24h_24h.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5080](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5080) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_1m.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_1m.md new file mode 100644 index 000000000..c8ab84a09 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_1m.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Returns\_Sd24h\_1m + +# Interface: SeriesTree\_Market\_Returns\_Sd24h\_1m + +Defined in: [Developer/brk/modules/brk-client/index.js:5099](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5099) + +## Properties + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5101](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5101) + +*** + +### sma + +> **sma**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5100](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5100) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_1w.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_1w.md new file mode 100644 index 000000000..ade6fcfa7 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_1w.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Returns\_Sd24h\_1w + +# Interface: SeriesTree\_Market\_Returns\_Sd24h\_1w + +Defined in: [Developer/brk/modules/brk-client/index.js:5093](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5093) + +## Properties + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5095](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5095) + +*** + +### sma + +> **sma**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5094](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5094) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_1y.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_1y.md new file mode 100644 index 000000000..a1aac8186 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_1y.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Returns\_Sd24h\_1y + +# Interface: SeriesTree\_Market\_Returns\_Sd24h\_1y + +Defined in: [Developer/brk/modules/brk-client/index.js:5105](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5105) + +## Properties + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5107](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5107) + +*** + +### sma + +> **sma**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5106](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5106) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_24h.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_24h.md new file mode 100644 index 000000000..c864d3a2f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Returns_Sd24h_24h.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Returns\_Sd24h\_24h + +# Interface: SeriesTree\_Market\_Returns\_Sd24h\_24h + +Defined in: [Developer/brk/modules/brk-client/index.js:5087](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5087) + +## Properties + +### sd + +> **sd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5089](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5089) + +*** + +### sma + +> **sma**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5088](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5088) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical.md new file mode 100644 index 000000000..514fe197f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Technical + +# Interface: SeriesTree\_Market\_Technical + +Defined in: [Developer/brk/modules/brk-client/index.js:5275](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5275) + +## Properties + +### macd + +> **macd**: [`SeriesTree_Market_Technical_Macd`](SeriesTree_Market_Technical_Macd.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5278](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5278) + +*** + +### piCycle + +> **piCycle**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5277](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5277) + +*** + +### rsi + +> **rsi**: [`SeriesTree_Market_Technical_Rsi`](SeriesTree_Market_Technical_Rsi.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5276](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5276) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd.md new file mode 100644 index 000000000..72a6c85f9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Technical\_Macd + +# Interface: SeriesTree\_Market\_Technical\_Macd + +Defined in: [Developer/brk/modules/brk-client/index.js:5289](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5289) + +## Properties + +### \_1m + +> **\_1m**: [`SeriesTree_Market_Technical_Macd_1m`](SeriesTree_Market_Technical_Macd_1m.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5292](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5292) + +*** + +### \_1w + +> **\_1w**: [`SeriesTree_Market_Technical_Macd_1w`](SeriesTree_Market_Technical_Macd_1w.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5291](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5291) + +*** + +### \_24h + +> **\_24h**: [`SeriesTree_Market_Technical_Macd_24h`](SeriesTree_Market_Technical_Macd_24h.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5290](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5290) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd_1m.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd_1m.md new file mode 100644 index 000000000..f7a05340c --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd_1m.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Technical\_Macd\_1m + +# Interface: SeriesTree\_Market\_Technical\_Macd\_1m + +Defined in: [Developer/brk/modules/brk-client/index.js:5314](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5314) + +## Properties + +### emaFast + +> **emaFast**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5315](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5315) + +*** + +### emaSlow + +> **emaSlow**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5316](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5316) + +*** + +### histogram + +> **histogram**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5319](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5319) + +*** + +### line + +> **line**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5317](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5317) + +*** + +### signal + +> **signal**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5318](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5318) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd_1w.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd_1w.md new file mode 100644 index 000000000..b977ecc6d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd_1w.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Technical\_Macd\_1w + +# Interface: SeriesTree\_Market\_Technical\_Macd\_1w + +Defined in: [Developer/brk/modules/brk-client/index.js:5305](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5305) + +## Properties + +### emaFast + +> **emaFast**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5306](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5306) + +*** + +### emaSlow + +> **emaSlow**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5307](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5307) + +*** + +### histogram + +> **histogram**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5310](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5310) + +*** + +### line + +> **line**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5308](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5308) + +*** + +### signal + +> **signal**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5309](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5309) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd_24h.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd_24h.md new file mode 100644 index 000000000..d0d248935 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Macd_24h.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Technical\_Macd\_24h + +# Interface: SeriesTree\_Market\_Technical\_Macd\_24h + +Defined in: [Developer/brk/modules/brk-client/index.js:5296](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5296) + +## Properties + +### emaFast + +> **emaFast**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5297](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5297) + +*** + +### emaSlow + +> **emaSlow**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5298](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5298) + +*** + +### histogram + +> **histogram**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5301](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5301) + +*** + +### line + +> **line**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5299](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5299) + +*** + +### signal + +> **signal**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5300](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5300) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Rsi.md b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Rsi.md new file mode 100644 index 000000000..bec676b80 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Market_Technical_Rsi.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Market\_Technical\_Rsi + +# Interface: SeriesTree\_Market\_Technical\_Rsi + +Defined in: [Developer/brk/modules/brk-client/index.js:5282](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5282) + +## Properties + +### \_1m + +> **\_1m**: [`RsiStochPattern`](RsiStochPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5285](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5285) + +*** + +### \_1w + +> **\_1w**: [`RsiStochPattern`](RsiStochPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5284](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5284) + +*** + +### \_24h + +> **\_24h**: [`RsiStochPattern`](RsiStochPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5283](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5283) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Mining.md b/modules/brk-client/docs/interfaces/SeriesTree_Mining.md new file mode 100644 index 000000000..e4f615624 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Mining.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Mining + +# Interface: SeriesTree\_Mining + +Defined in: [Developer/brk/modules/brk-client/index.js:4587](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4587) + +## Properties + +### hashrate + +> **hashrate**: [`SeriesTree_Mining_Hashrate`](SeriesTree_Mining_Hashrate.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4589](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4589) + +*** + +### rewards + +> **rewards**: [`SeriesTree_Mining_Rewards`](SeriesTree_Mining_Rewards.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4588](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4588) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Mining_Hashrate.md b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Hashrate.md new file mode 100644 index 000000000..95a6921bd --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Hashrate.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Mining\_Hashrate + +# Interface: SeriesTree\_Mining\_Hashrate + +Defined in: [Developer/brk/modules/brk-client/index.js:4635](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4635) + +## Properties + +### price + +> **price**: [`PhsReboundThsPattern`](PhsReboundThsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4637](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4637) + +*** + +### rate + +> **rate**: [`SeriesTree_Mining_Hashrate_Rate`](SeriesTree_Mining_Hashrate_Rate.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4636](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4636) + +*** + +### value + +> **value**: [`PhsReboundThsPattern`](PhsReboundThsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4638](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4638) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Mining_Hashrate_Rate.md b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Hashrate_Rate.md new file mode 100644 index 000000000..60d865659 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Hashrate_Rate.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Mining\_Hashrate\_Rate + +# Interface: SeriesTree\_Mining\_Hashrate\_Rate + +Defined in: [Developer/brk/modules/brk-client/index.js:4642](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4642) + +## Properties + +### ath + +> **ath**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4645](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4645) + +*** + +### base + +> **base**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4643](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4643) + +*** + +### drawdown + +> **drawdown**: [`BpsPercentRatioPattern5`](BpsPercentRatioPattern5.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4646](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4646) + +*** + +### sma + +> **sma**: [`SeriesTree_Mining_Hashrate_Rate_Sma`](SeriesTree_Mining_Hashrate_Rate_Sma.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4644](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4644) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Mining_Hashrate_Rate_Sma.md b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Hashrate_Rate_Sma.md new file mode 100644 index 000000000..3d9fba1c9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Hashrate_Rate_Sma.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Mining\_Hashrate\_Rate\_Sma + +# Interface: SeriesTree\_Mining\_Hashrate\_Rate\_Sma + +Defined in: [Developer/brk/modules/brk-client/index.js:4650](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4650) + +## Properties + +### \_1m + +> **\_1m**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4652](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4652) + +*** + +### \_1w + +> **\_1w**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4651](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4651) + +*** + +### \_1y + +> **\_1y**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4654](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4654) + +*** + +### \_2m + +> **\_2m**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4653](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4653) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards.md b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards.md new file mode 100644 index 000000000..da42b3681 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Mining\_Rewards + +# Interface: SeriesTree\_Mining\_Rewards + +Defined in: [Developer/brk/modules/brk-client/index.js:4593](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4593) + +## Properties + +### coinbase + +> **coinbase**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4594](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4594) + +*** + +### fees + +> **fees**: [`SeriesTree_Mining_Rewards_Fees`](SeriesTree_Mining_Rewards_Fees.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4596](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4596) + +*** + +### subsidy + +> **subsidy**: [`SeriesTree_Mining_Rewards_Subsidy`](SeriesTree_Mining_Rewards_Subsidy.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4595](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4595) + +*** + +### unclaimed + +> **unclaimed**: [`BlockCumulativePattern`](BlockCumulativePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4597](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4597) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards_Fees.md b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards_Fees.md new file mode 100644 index 000000000..cb726b565 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards_Fees.md @@ -0,0 +1,113 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Mining\_Rewards\_Fees + +# Interface: SeriesTree\_Mining\_Rewards\_Fees + +Defined in: [Developer/brk/modules/brk-client/index.js:4610](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4610) + +## Properties + +### average + +> **average**: [`_1m1w1y24hPattern3`](1m1w1y24hPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4614](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4614) + +*** + +### block + +> **block**: [`BtcCentsSatsUsdPattern2`](BtcCentsSatsUsdPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4611](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4611) + +*** + +### cumulative + +> **cumulative**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4612](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4612) + +*** + +### dominance + +> **dominance**: [`_1m1w1y24hBpsPercentRatioPattern`](1m1w1y24hBpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4622](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4622) + +*** + +### max + +> **max**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4616](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4616) + +*** + +### median + +> **median**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4619](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4619) + +*** + +### min + +> **min**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4615](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4615) + +*** + +### pct10 + +> **pct10**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4617](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4617) + +*** + +### pct25 + +> **pct25**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4618](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4618) + +*** + +### pct75 + +> **pct75**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4620](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4620) + +*** + +### pct90 + +> **pct90**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4621](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4621) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4613](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4613) + +*** + +### toSubsidyRatio + +> **toSubsidyRatio**: [`SeriesTree_Mining_Rewards_Fees_ToSubsidyRatio`](SeriesTree_Mining_Rewards_Fees_ToSubsidyRatio.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4623](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4623) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards_Fees_ToSubsidyRatio.md b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards_Fees_ToSubsidyRatio.md new file mode 100644 index 000000000..d60c778b3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards_Fees_ToSubsidyRatio.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Mining\_Rewards\_Fees\_ToSubsidyRatio + +# Interface: SeriesTree\_Mining\_Rewards\_Fees\_ToSubsidyRatio + +Defined in: [Developer/brk/modules/brk-client/index.js:4627](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4627) + +## Properties + +### \_1m + +> **\_1m**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4630](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4630) + +*** + +### \_1w + +> **\_1w**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4629](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4629) + +*** + +### \_1y + +> **\_1y**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4631](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4631) + +*** + +### \_24h + +> **\_24h**: [`BpsRatioPattern2`](BpsRatioPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4628](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4628) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards_Subsidy.md b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards_Subsidy.md new file mode 100644 index 000000000..68e2a70b7 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Mining_Rewards_Subsidy.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Mining\_Rewards\_Subsidy + +# Interface: SeriesTree\_Mining\_Rewards\_Subsidy + +Defined in: [Developer/brk/modules/brk-client/index.js:4601](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4601) + +## Properties + +### average + +> **average**: [`_1m1w1y24hPattern3`](1m1w1y24hPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4605](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4605) + +*** + +### block + +> **block**: [`BtcCentsSatsUsdPattern2`](BtcCentsSatsUsdPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4602](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4602) + +*** + +### cumulative + +> **cumulative**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4603](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4603) + +*** + +### dominance + +> **dominance**: [`_1m1w1y24hBpsPercentRatioPattern`](1m1w1y24hBpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4606](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4606) + +*** + +### sum + +> **sum**: [`_1m1w1y24hPattern4`](1m1w1y24hPattern4.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4604](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4604) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Outputs.md b/modules/brk-client/docs/interfaces/SeriesTree_Outputs.md new file mode 100644 index 000000000..485b5b07d --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Outputs.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Outputs + +# Interface: SeriesTree\_Outputs + +Defined in: [Developer/brk/modules/brk-client/index.js:4368](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4368) + +## Properties + +### count + +> **count**: [`SeriesTree_Outputs_Count`](SeriesTree_Outputs_Count.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4371](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4371) + +*** + +### raw + +> **raw**: [`SeriesTree_Outputs_Raw`](SeriesTree_Outputs_Raw.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4369](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4369) + +*** + +### spent + +> **spent**: [`SeriesTree_Outputs_Spent`](SeriesTree_Outputs_Spent.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4370](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4370) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Outputs_Count.md b/modules/brk-client/docs/interfaces/SeriesTree_Outputs_Count.md new file mode 100644 index 000000000..0929cd6bf --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Outputs_Count.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Outputs\_Count + +# Interface: SeriesTree\_Outputs\_Count + +Defined in: [Developer/brk/modules/brk-client/index.js:4389](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4389) + +## Properties + +### total + +> **total**: [`CumulativeRollingSumPattern`](CumulativeRollingSumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4390](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4390) + +*** + +### unspent + +> **unspent**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4391](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4391) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Outputs_Raw.md b/modules/brk-client/docs/interfaces/SeriesTree_Outputs_Raw.md new file mode 100644 index 000000000..5b78f628e --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Outputs_Raw.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Outputs\_Raw + +# Interface: SeriesTree\_Outputs\_Raw + +Defined in: [Developer/brk/modules/brk-client/index.js:4375](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4375) + +## Properties + +### firstTxoutIndex + +> **firstTxoutIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4376](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4376) + +*** + +### outputType + +> **outputType**: [`SeriesPattern21`](../type-aliases/SeriesPattern21.md)\<[`OutputType`](../type-aliases/OutputType.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4378](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4378) + +*** + +### txIndex + +> **txIndex**: [`SeriesPattern21`](../type-aliases/SeriesPattern21.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4380](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4380) + +*** + +### typeIndex + +> **typeIndex**: [`SeriesPattern21`](../type-aliases/SeriesPattern21.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4379](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4379) + +*** + +### value + +> **value**: [`SeriesPattern21`](../type-aliases/SeriesPattern21.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4377](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4377) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Outputs_Spent.md b/modules/brk-client/docs/interfaces/SeriesTree_Outputs_Spent.md new file mode 100644 index 000000000..f45545e48 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Outputs_Spent.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Outputs\_Spent + +# Interface: SeriesTree\_Outputs\_Spent + +Defined in: [Developer/brk/modules/brk-client/index.js:4384](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4384) + +## Properties + +### txinIndex + +> **txinIndex**: [`SeriesPattern21`](../type-aliases/SeriesPattern21.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4385](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4385) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Pools.md b/modules/brk-client/docs/interfaces/SeriesTree_Pools.md new file mode 100644 index 000000000..cc3a5d8ab --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Pools.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Pools + +# Interface: SeriesTree\_Pools + +Defined in: [Developer/brk/modules/brk-client/index.js:5323](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5323) + +## Properties + +### major + +> **major**: [`SeriesTree_Pools_Major`](SeriesTree_Pools_Major.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5325](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5325) + +*** + +### minor + +> **minor**: [`SeriesTree_Pools_Minor`](SeriesTree_Pools_Minor.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5326](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5326) + +*** + +### pool + +> **pool**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<[`PoolSlug`](../type-aliases/PoolSlug.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5324](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5324) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Pools_Major.md b/modules/brk-client/docs/interfaces/SeriesTree_Pools_Major.md new file mode 100644 index 000000000..7ac185c8f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Pools_Major.md @@ -0,0 +1,185 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Pools\_Major + +# Interface: SeriesTree\_Pools\_Major + +Defined in: [Developer/brk/modules/brk-client/index.js:5330](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5330) + +## Properties + +### antpool + +> **antpool**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5339](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5339) + +*** + +### binancepool + +> **binancepool**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5346](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5346) + +*** + +### bitfury + +> **bitfury**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5342](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5342) + +*** + +### braiinspool + +> **braiinspool**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5338](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5338) + +*** + +### btcc + +> **btcc**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5340](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5340) + +*** + +### btccom + +> **btccom**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5333](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5333) + +*** + +### btcguild + +> **btcguild**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5335](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5335) + +*** + +### btctop + +> **btctop**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5334](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5334) + +*** + +### bwpool + +> **bwpool**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5341](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5341) + +*** + +### eligius + +> **eligius**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5336](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5336) + +*** + +### f2pool + +> **f2pool**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5337](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5337) + +*** + +### foundryusa + +> **foundryusa**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5347](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5347) + +*** + +### luxor + +> **luxor**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5332](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5332) + +*** + +### marapool + +> **marapool**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5349](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5349) + +*** + +### ocean + +> **ocean**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5351](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5351) + +*** + +### poolin + +> **poolin**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5344](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5344) + +*** + +### sbicrypto + +> **sbicrypto**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5348](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5348) + +*** + +### secpool + +> **secpool**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5350](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5350) + +*** + +### spiderpool + +> **spiderpool**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5345](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5345) + +*** + +### unknown + +> **unknown**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5331](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5331) + +*** + +### viabtc + +> **viabtc**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5343](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5343) + +*** + +### whitepool + +> **whitepool**: [`BlocksDominanceRewardsPattern`](BlocksDominanceRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5352](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5352) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Pools_Minor.md b/modules/brk-client/docs/interfaces/SeriesTree_Pools_Minor.md new file mode 100644 index 000000000..49762f7ba --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Pools_Minor.md @@ -0,0 +1,1129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Pools\_Minor + +# Interface: SeriesTree\_Pools\_Minor + +Defined in: [Developer/brk/modules/brk-client/index.js:5356](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5356) + +## Properties + +### aaopool + +> **aaopool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5450](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5450) + +*** + +### arkpool + +> **arkpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5452](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5452) + +*** + +### asicminer + +> **asicminer**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5369](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5369) + +*** + +### axbt + +> **axbt**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5368](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5368) + +*** + +### batpool + +> **batpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5419](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5419) + +*** + +### bcmonster + +> **bcmonster**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5414](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5414) + +*** + +### bcpoolio + +> **bcpoolio**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5394](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5394) + +*** + +### bitalo + +> **bitalo**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5386](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5386) + +*** + +### bitclub + +> **bitclub**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5400](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5400) + +*** + +### bitcoinaffiliatenetwork + +> **bitcoinaffiliatenetwork**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5401](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5401) + +*** + +### bitcoincom + +> **bitcoincom**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5365](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5365) + +*** + +### bitcoinindia + +> **bitcoinindia**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5425](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5425) + +*** + +### bitcoinindiapool + +> **bitcoinindiapool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5473](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5473) + +*** + +### bitcoinrussia + +> **bitcoinrussia**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5371](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5371) + +*** + +### bitcoinukraine + +> **bitcoinukraine**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5437](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5437) + +*** + +### bitfarms + +> **bitfarms**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5361](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5361) + +*** + +### bitfufupool + +> **bitfufupool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5487](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5487) + +*** + +### bitminter + +> **bitminter**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5370](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5370) + +*** + +### bitparking + +> **bitparking**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5382](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5382) + +*** + +### bitsolo + +> **bitsolo**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5403](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5403) + +*** + +### bixin + +> **bixin**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5416](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5416) + +*** + +### blockfills + +> **blockfills**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5357](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5357) + +*** + +### bravomining + +> **bravomining**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5411](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5411) + +*** + +### btcdig + +> **btcdig**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5466](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5466) + +*** + +### btclab + +> **btclab**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5493](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5493) + +*** + +### btcmp + +> **btcmp**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5468](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5468) + +*** + +### btcnuggets + +> **btcnuggets**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5459](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5459) + +*** + +### btcpoolparty + +> **btcpoolparty**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5463](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5463) + +*** + +### btcserv + +> **btcserv**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5372](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5372) + +*** + +### btpool + +> **btpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5423](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5423) + +*** + +### bytepool + +> **bytepool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5444](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5444) + +*** + +### canoe + +> **canoe**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5475](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5475) + +*** + +### canoepool + +> **canoepool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5364](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5364) + +*** + +### carbonnegative + +> **carbonnegative**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5482](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5482) + +*** + +### ckpool + +> **ckpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5398](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5398) + +*** + +### cloudhashing + +> **cloudhashing**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5460](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5460) + +*** + +### coinlab + +> **coinlab**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5378](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5378) + +*** + +### cointerra + +> **cointerra**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5395](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5395) + +*** + +### connectbtc + +> **connectbtc**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5418](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5418) + +*** + +### dcex + +> **dcex**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5422](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5422) + +*** + +### dcexploration + +> **dcexploration**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5421](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5421) + +*** + +### digitalbtc + +> **digitalbtc**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5405](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5405) + +*** + +### digitalxmintsy + +> **digitalxmintsy**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5461](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5461) + +*** + +### dpool + +> **dpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5433](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5433) + +*** + +### eclipsemc + +> **eclipsemc**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5375](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5375) + +*** + +### eightbaochi + +> **eightbaochi**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5406](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5406) + +*** + +### ekanembtc + +> **ekanembtc**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5474](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5474) + +*** + +### emcdpool + +> **emcdpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5451](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5451) + +*** + +### entrustcharitypool + +> **entrustcharitypool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5455](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5455) + +*** + +### eobot + +> **eobot**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5469](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5469) + +*** + +### est3lar + +> **est3lar**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5496](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5496) + +*** + +### exxbw + +> **exxbw**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5402](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5402) + +*** + +### fiftyeightcoin + +> **fiftyeightcoin**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5424](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5424) + +*** + +### futurebitapollosolo + +> **futurebitapollosolo**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5481](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5481) + +*** + +### gbminers + +> **gbminers**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5367](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5367) + +*** + +### gdpool + +> **gdpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5488](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5488) + +*** + +### ghashio + +> **ghashio**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5380](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5380) + +*** + +### givemecoins + +> **givemecoins**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5392](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5392) + +*** + +### gogreenlight + +> **gogreenlight**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5472](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5472) + +*** + +### haominer + +> **haominer**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5435](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5435) + +*** + +### haozhuzhu + +> **haozhuzhu**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5429](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5429) + +*** + +### hashbx + +> **hashbx**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5432](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5432) + +*** + +### hashpool + +> **hashpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5409](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5409) + +*** + +### helix + +> **helix**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5436](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5436) + +*** + +### hhtt + +> **hhtt**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5387](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5387) + +*** + +### hotpool + +> **hotpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5412](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5412) + +*** + +### hummerpool + +> **hummerpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5442](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5442) + +*** + +### huobipool + +> **huobipool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5362](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5362) + +*** + +### innopolistech + +> **innopolistech**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5492](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5492) + +*** + +### kanopool + +> **kanopool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5396](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5396) + +*** + +### kncminer + +> **kncminer**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5385](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5385) + +*** + +### kucoinpool + +> **kucoinpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5454](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5454) + +*** + +### lubiancom + +> **lubiancom**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5448](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5448) + +*** + +### maxbtc + +> **maxbtc**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5376](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5376) + +*** + +### maxipool + +> **maxipool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5486](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5486) + +*** + +### megabigpower + +> **megabigpower**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5388](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5388) + +*** + +### minerium + +> **minerium**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5447](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5447) + +*** + +### miningcity + +> **miningcity**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5446](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5446) + +*** + +### miningdutch + +> **miningdutch**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5489](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5489) + +*** + +### miningkings + +> **miningkings**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5431](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5431) + +*** + +### miningsquared + +> **miningsquared**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5491](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5491) + +*** + +### mmpool + +> **mmpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5383](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5383) + +*** + +### mtred + +> **mtred**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5389](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5389) + +*** + +### multicoinco + +> **multicoinco**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5393](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5393) + +*** + +### multipool + +> **multipool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5464](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5464) + +*** + +### mybtccoinpool + +> **mybtccoinpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5407](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5407) + +*** + +### neopool + +> **neopool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5485](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5485) + +*** + +### nexious + +> **nexious**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5410](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5410) + +*** + +### nicehash + +> **nicehash**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5399](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5399) + +*** + +### nmcbit + +> **nmcbit**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5390](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5390) + +*** + +### novablock + +> **novablock**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5445](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5445) + +*** + +### okexpool + +> **okexpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5413](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5413) + +*** + +### okkong + +> **okkong**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5449](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5449) + +*** + +### okminer + +> **okminer**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5456](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5456) + +*** + +### okpooltop + +> **okpooltop**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5441](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5441) + +*** + +### onehash + +> **onehash**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5415](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5415) + +*** + +### onem1x + +> **onem1x**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5477](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5477) + +*** + +### onethash + +> **onethash**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5360](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5360) + +*** + +### ozcoin + +> **ozcoin**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5374](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5374) + +*** + +### parasite + +> **parasite**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5494](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5494) + +*** + +### patels + +> **patels**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5471](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5471) + +*** + +### pegapool + +> **pegapool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5458](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5458) + +*** + +### phashio + +> **phashio**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5427](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5427) + +*** + +### phoenix + +> **phoenix**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5484](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5484) + +*** + +### polmine + +> **polmine**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5384](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5384) + +*** + +### pool175btc + +> **pool175btc**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5366](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5366) + +*** + +### pool50btc + +> **pool50btc**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5379](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5379) + +*** + +### portlandhodl + +> **portlandhodl**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5483](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5483) + +*** + +### publicpool + +> **publicpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5490](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5490) + +*** + +### purebtccom + +> **purebtccom**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5453](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5453) + +*** + +### rawpool + +> **rawpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5434](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5434) + +*** + +### redrockpool + +> **redrockpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5495](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5495) + +*** + +### rigpool + +> **rigpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5428](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5428) + +*** + +### secretsuperstar + +> **secretsuperstar**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5438](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5438) + +*** + +### sevenpool + +> **sevenpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5430](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5430) + +*** + +### shawnp0wers + +> **shawnp0wers**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5426](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5426) + +*** + +### sigmapoolcom + +> **sigmapoolcom**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5440](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5440) + +*** + +### simplecoinus + +> **simplecoinus**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5373](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5373) + +*** + +### solock + +> **solock**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5397](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5397) + +*** + +### stminingcorp + +> **stminingcorp**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5381](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5381) + +*** + +### tangpool + +> **tangpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5443](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5443) + +*** + +### tatmaspool + +> **tatmaspool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5417](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5417) + +*** + +### tbdice + +> **tbdice**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5408](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5408) + +*** + +### telco214 + +> **telco214**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5462](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5462) + +*** + +### terrapool + +> **terrapool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5359](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5359) + +*** + +### tiger + +> **tiger**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5476](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5476) + +*** + +### tigerpoolnet + +> **tigerpoolnet**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5439](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5439) + +*** + +### titan + +> **titan**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5457](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5457) + +*** + +### transactioncoinmining + +> **transactioncoinmining**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5465](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5465) + +*** + +### trickysbtcpool + +> **trickysbtcpool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5467](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5467) + +*** + +### triplemining + +> **triplemining**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5377](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5377) + +*** + +### twentyoneinc + +> **twentyoneinc**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5404](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5404) + +*** + +### ultimuspool + +> **ultimuspool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5358](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5358) + +*** + +### unomp + +> **unomp**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5470](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5470) + +*** + +### waterhole + +> **waterhole**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5420](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5420) + +*** + +### wayicn + +> **wayicn**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5363](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5363) + +*** + +### wiz + +> **wiz**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5479](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5479) + +*** + +### wk057 + +> **wk057**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5480](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5480) + +*** + +### yourbtcnet + +> **yourbtcnet**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5391](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5391) + +*** + +### zulupool + +> **zulupool**: [`BlocksDominancePattern`](BlocksDominancePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5478](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5478) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Prices.md b/modules/brk-client/docs/interfaces/SeriesTree_Prices.md new file mode 100644 index 000000000..2e25f6f79 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Prices.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Prices + +# Interface: SeriesTree\_Prices + +Defined in: [Developer/brk/modules/brk-client/index.js:5500](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5500) + +## Properties + +### ohlc + +> **ohlc**: [`SeriesTree_Prices_Ohlc`](SeriesTree_Prices_Ohlc.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5502](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5502) + +*** + +### split + +> **split**: [`SeriesTree_Prices_Split`](SeriesTree_Prices_Split.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5501](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5501) + +*** + +### spot + +> **spot**: [`SeriesTree_Prices_Spot`](SeriesTree_Prices_Spot.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5503](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5503) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Prices_Ohlc.md b/modules/brk-client/docs/interfaces/SeriesTree_Prices_Ohlc.md new file mode 100644 index 000000000..88d9508f3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Prices_Ohlc.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Prices\_Ohlc + +# Interface: SeriesTree\_Prices\_Ohlc + +Defined in: [Developer/brk/modules/brk-client/index.js:5515](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5515) + +## Properties + +### cents + +> **cents**: [`SeriesPattern2`](../type-aliases/SeriesPattern2.md)\<[`OHLCCents`](OHLCCents.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5517](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5517) + +*** + +### sats + +> **sats**: [`SeriesPattern2`](../type-aliases/SeriesPattern2.md)\<[`OHLCSats`](OHLCSats.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5518](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5518) + +*** + +### usd + +> **usd**: [`SeriesPattern2`](../type-aliases/SeriesPattern2.md)\<[`OHLCDollars`](OHLCDollars.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5516](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5516) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Prices_Split.md b/modules/brk-client/docs/interfaces/SeriesTree_Prices_Split.md new file mode 100644 index 000000000..fc9fc5000 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Prices_Split.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Prices\_Split + +# Interface: SeriesTree\_Prices\_Split + +Defined in: [Developer/brk/modules/brk-client/index.js:5507](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5507) + +## Properties + +### close + +> **close**: [`CentsSatsUsdPattern3`](CentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5511](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5511) + +*** + +### high + +> **high**: [`CentsSatsUsdPattern3`](CentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5509](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5509) + +*** + +### low + +> **low**: [`CentsSatsUsdPattern3`](CentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5510](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5510) + +*** + +### open + +> **open**: [`CentsSatsUsdPattern3`](CentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5508](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5508) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Prices_Spot.md b/modules/brk-client/docs/interfaces/SeriesTree_Prices_Spot.md new file mode 100644 index 000000000..e9ab5de02 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Prices_Spot.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Prices\_Spot + +# Interface: SeriesTree\_Prices\_Spot + +Defined in: [Developer/brk/modules/brk-client/index.js:5522](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5522) + +## Properties + +### cents + +> **cents**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5524](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5524) + +*** + +### sats + +> **sats**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5525](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5525) + +*** + +### usd + +> **usd**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5523](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5523) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Scripts.md b/modules/brk-client/docs/interfaces/SeriesTree_Scripts.md new file mode 100644 index 000000000..85e4fca6c --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Scripts.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Scripts + +# Interface: SeriesTree\_Scripts + +Defined in: [Developer/brk/modules/brk-client/index.js:4527](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4527) + +## Properties + +### count + +> **count**: [`SeriesTree_Scripts_Count`](SeriesTree_Scripts_Count.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4529](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4529) + +*** + +### raw + +> **raw**: [`SeriesTree_Scripts_Raw`](SeriesTree_Scripts_Raw.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4528](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4528) + +*** + +### value + +> **value**: [`SeriesTree_Scripts_Value`](SeriesTree_Scripts_Value.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4530](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4530) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Count.md b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Count.md new file mode 100644 index 000000000..f566b388a --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Count.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Scripts\_Count + +# Interface: SeriesTree\_Scripts\_Count + +Defined in: [Developer/brk/modules/brk-client/index.js:4566](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4566) + +## Properties + +### emptyOutput + +> **emptyOutput**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4577](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4577) + +*** + +### opReturn + +> **opReturn**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4576](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4576) + +*** + +### p2a + +> **p2a**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4567](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4567) + +*** + +### p2ms + +> **p2ms**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4568](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4568) + +*** + +### p2pk33 + +> **p2pk33**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4569](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4569) + +*** + +### p2pk65 + +> **p2pk65**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4570](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4570) + +*** + +### p2pkh + +> **p2pkh**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4571](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4571) + +*** + +### p2sh + +> **p2sh**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4572](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4572) + +*** + +### p2tr + +> **p2tr**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4573](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4573) + +*** + +### p2wpkh + +> **p2wpkh**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4574](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4574) + +*** + +### p2wsh + +> **p2wsh**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4575](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4575) + +*** + +### unknownOutput + +> **unknownOutput**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4578](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4578) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw.md b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw.md new file mode 100644 index 000000000..d15e6ab43 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Scripts\_Raw + +# Interface: SeriesTree\_Scripts\_Raw + +Defined in: [Developer/brk/modules/brk-client/index.js:4534](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4534) + +## Properties + +### empty + +> **empty**: [`SeriesTree_Scripts_Raw_Empty`](SeriesTree_Scripts_Raw_Empty.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4535](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4535) + +*** + +### opReturn + +> **opReturn**: [`SeriesTree_Scripts_Raw_OpReturn`](SeriesTree_Scripts_Raw_OpReturn.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4536](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4536) + +*** + +### p2ms + +> **p2ms**: [`SeriesTree_Scripts_Raw_P2ms`](SeriesTree_Scripts_Raw_P2ms.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4537](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4537) + +*** + +### unknown + +> **unknown**: [`SeriesTree_Scripts_Raw_Unknown`](SeriesTree_Scripts_Raw_Unknown.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4538](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4538) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_Empty.md b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_Empty.md new file mode 100644 index 000000000..a4f5d09ec --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_Empty.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Scripts\_Raw\_Empty + +# Interface: SeriesTree\_Scripts\_Raw\_Empty + +Defined in: [Developer/brk/modules/brk-client/index.js:4542](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4542) + +## Properties + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4543](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4543) + +*** + +### toTxIndex + +> **toTxIndex**: [`SeriesPattern22`](../type-aliases/SeriesPattern22.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4544](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4544) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_OpReturn.md b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_OpReturn.md new file mode 100644 index 000000000..f794d03f7 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_OpReturn.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Scripts\_Raw\_OpReturn + +# Interface: SeriesTree\_Scripts\_Raw\_OpReturn + +Defined in: [Developer/brk/modules/brk-client/index.js:4548](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4548) + +## Properties + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4549](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4549) + +*** + +### toTxIndex + +> **toTxIndex**: [`SeriesPattern23`](../type-aliases/SeriesPattern23.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4550](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4550) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_P2ms.md b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_P2ms.md new file mode 100644 index 000000000..e4bba36dd --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_P2ms.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Scripts\_Raw\_P2ms + +# Interface: SeriesTree\_Scripts\_Raw\_P2ms + +Defined in: [Developer/brk/modules/brk-client/index.js:4554](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4554) + +## Properties + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4555](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4555) + +*** + +### toTxIndex + +> **toTxIndex**: [`SeriesPattern25`](../type-aliases/SeriesPattern25.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4556](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4556) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_Unknown.md b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_Unknown.md new file mode 100644 index 000000000..7cb9b0e97 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Raw_Unknown.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Scripts\_Raw\_Unknown + +# Interface: SeriesTree\_Scripts\_Raw\_Unknown + +Defined in: [Developer/brk/modules/brk-client/index.js:4560](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4560) + +## Properties + +### firstIndex + +> **firstIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4561](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4561) + +*** + +### toTxIndex + +> **toTxIndex**: [`SeriesPattern33`](../type-aliases/SeriesPattern33.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4562](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4562) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Value.md b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Value.md new file mode 100644 index 000000000..9ac2ecc39 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Scripts_Value.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Scripts\_Value + +# Interface: SeriesTree\_Scripts\_Value + +Defined in: [Developer/brk/modules/brk-client/index.js:4582](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4582) + +## Properties + +### opReturn + +> **opReturn**: [`BlockCumulativePattern`](BlockCumulativePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4583](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4583) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Supply.md b/modules/brk-client/docs/interfaces/SeriesTree_Supply.md new file mode 100644 index 000000000..fdaa206f1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Supply.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Supply + +# Interface: SeriesTree\_Supply + +Defined in: [Developer/brk/modules/brk-client/index.js:5529](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5529) + +## Properties + +### burned + +> **burned**: [`BlockCumulativePattern`](BlockCumulativePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5532](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5532) + +*** + +### circulating + +> **circulating**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5531](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5531) + +*** + +### hodledOrLost + +> **hodledOrLost**: [`BtcCentsSatsUsdPattern3`](BtcCentsSatsUsdPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5537](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5537) + +*** + +### inflationRate + +> **inflationRate**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5533](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5533) + +*** + +### marketCap + +> **marketCap**: [`CentsDeltaUsdPattern`](CentsDeltaUsdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5535](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5535) + +*** + +### marketMinusRealizedCapGrowthRate + +> **marketMinusRealizedCapGrowthRate**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5536](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5536) + +*** + +### state + +> **state**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<[`SupplyState`](SupplyState.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5530](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5530) + +*** + +### velocity + +> **velocity**: [`SeriesTree_Supply_Velocity`](SeriesTree_Supply_Velocity.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5534](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5534) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Supply_Velocity.md b/modules/brk-client/docs/interfaces/SeriesTree_Supply_Velocity.md new file mode 100644 index 000000000..dd6e6881c --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Supply_Velocity.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Supply\_Velocity + +# Interface: SeriesTree\_Supply\_Velocity + +Defined in: [Developer/brk/modules/brk-client/index.js:5541](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5541) + +## Properties + +### fiat + +> **fiat**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5543](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5543) + +*** + +### native + +> **native**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:5542](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L5542) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Transactions.md b/modules/brk-client/docs/interfaces/SeriesTree_Transactions.md new file mode 100644 index 000000000..ee10c8833 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Transactions.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Transactions + +# Interface: SeriesTree\_Transactions + +Defined in: [Developer/brk/modules/brk-client/index.js:4280](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4280) + +## Properties + +### count + +> **count**: [`SeriesTree_Transactions_Count`](SeriesTree_Transactions_Count.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4282](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4282) + +*** + +### fees + +> **fees**: [`SeriesTree_Transactions_Fees`](SeriesTree_Transactions_Fees.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4284](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4284) + +*** + +### raw + +> **raw**: [`SeriesTree_Transactions_Raw`](SeriesTree_Transactions_Raw.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4281](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4281) + +*** + +### size + +> **size**: [`SeriesTree_Transactions_Size`](SeriesTree_Transactions_Size.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4283](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4283) + +*** + +### versions + +> **versions**: [`SeriesTree_Transactions_Versions`](SeriesTree_Transactions_Versions.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4285](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4285) + +*** + +### volume + +> **volume**: [`SeriesTree_Transactions_Volume`](SeriesTree_Transactions_Volume.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4286](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4286) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Count.md b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Count.md new file mode 100644 index 000000000..e09f3470f --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Count.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Transactions\_Count + +# Interface: SeriesTree\_Transactions\_Count + +Defined in: [Developer/brk/modules/brk-client/index.js:4304](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4304) + +## Properties + +### isCoinbase + +> **isCoinbase**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`boolean`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4306](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4306) + +*** + +### total + +> **total**: [`AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern`](AverageBlockCumulativeMaxMedianMinPct10Pct25Pct75Pct90SumPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4305](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4305) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Fees.md b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Fees.md new file mode 100644 index 000000000..4f7a56c2c --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Fees.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Transactions\_Fees + +# Interface: SeriesTree\_Transactions\_Fees + +Defined in: [Developer/brk/modules/brk-client/index.js:4323](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4323) + +## Properties + +### fee + +> **fee**: [`_6bBlockTxPattern`](6bBlockTxPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4326](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4326) + +*** + +### feeRate + +> **feeRate**: [`_6bBlockTxPattern`](6bBlockTxPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4327](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4327) + +*** + +### inputValue + +> **inputValue**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4324](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4324) + +*** + +### outputValue + +> **outputValue**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4325](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4325) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Raw.md b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Raw.md new file mode 100644 index 000000000..3347f29d3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Raw.md @@ -0,0 +1,89 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Transactions\_Raw + +# Interface: SeriesTree\_Transactions\_Raw + +Defined in: [Developer/brk/modules/brk-client/index.js:4290](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4290) + +## Properties + +### baseSize + +> **baseSize**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4296](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4296) + +*** + +### firstTxIndex + +> **firstTxIndex**: [`SeriesPattern18`](../type-aliases/SeriesPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4291](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4291) + +*** + +### firstTxinIndex + +> **firstTxinIndex**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4299](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4299) + +*** + +### firstTxoutIndex + +> **firstTxoutIndex**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4300](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4300) + +*** + +### height + +> **height**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4292](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4292) + +*** + +### isExplicitlyRbf + +> **isExplicitlyRbf**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`boolean`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4298](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4298) + +*** + +### rawLocktime + +> **rawLocktime**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4295](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4295) + +*** + +### totalSize + +> **totalSize**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4297](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4297) + +*** + +### txid + +> **txid**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4293](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4293) + +*** + +### txVersion + +> **txVersion**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4294](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4294) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Size.md b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Size.md new file mode 100644 index 000000000..3da14c4f9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Size.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Transactions\_Size + +# Interface: SeriesTree\_Transactions\_Size + +Defined in: [Developer/brk/modules/brk-client/index.js:4310](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4310) + +## Properties + +### vsize + +> **vsize**: [`_6bBlockTxPattern`](6bBlockTxPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4311](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4311) + +*** + +### weight + +> **weight**: [`SeriesTree_Transactions_Size_Weight`](SeriesTree_Transactions_Size_Weight.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4312](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4312) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Size_Weight.md b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Size_Weight.md new file mode 100644 index 000000000..248dd9ab2 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Size_Weight.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Transactions\_Size\_Weight + +# Interface: SeriesTree\_Transactions\_Size\_Weight + +Defined in: [Developer/brk/modules/brk-client/index.js:4316](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4316) + +## Properties + +### \_6b + +> **\_6b**: [`MaxMedianMinPct10Pct25Pct75Pct90Pattern2`](MaxMedianMinPct10Pct25Pct75Pct90Pattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4319](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4319) + +*** + +### block + +> **block**: [`MaxMedianMinPct10Pct25Pct75Pct90Pattern2`](MaxMedianMinPct10Pct25Pct75Pct90Pattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4318](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4318) + +*** + +### txIndex + +> **txIndex**: [`SeriesPattern19`](../type-aliases/SeriesPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4317](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4317) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Versions.md b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Versions.md new file mode 100644 index 000000000..02cad54a3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Versions.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Transactions\_Versions + +# Interface: SeriesTree\_Transactions\_Versions + +Defined in: [Developer/brk/modules/brk-client/index.js:4331](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4331) + +## Properties + +### v1 + +> **v1**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4332](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4332) + +*** + +### v2 + +> **v2**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4333](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4333) + +*** + +### v3 + +> **v3**: [`AverageBlockCumulativeSumPattern`](AverageBlockCumulativeSumPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4334](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4334) diff --git a/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Volume.md b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Volume.md new file mode 100644 index 000000000..7e3911cfc --- /dev/null +++ b/modules/brk-client/docs/interfaces/SeriesTree_Transactions_Volume.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Transactions\_Volume + +# Interface: SeriesTree\_Transactions\_Volume + +Defined in: [Developer/brk/modules/brk-client/index.js:4338](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4338) + +## Properties + +### inputsPerSec + +> **inputsPerSec**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4342](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4342) + +*** + +### outputsPerSec + +> **outputsPerSec**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4341](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4341) + +*** + +### transferVolume + +> **transferVolume**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4339](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4339) + +*** + +### txPerSec + +> **txPerSec**: [`_1m1w1y24hPattern`](1m1w1y24hPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4340](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4340) diff --git a/modules/brk-client/docs/interfaces/SingleItemBuilder.md b/modules/brk-client/docs/interfaces/SingleItemBuilder.md index 6e94e5d1b..6121a5a6d 100644 --- a/modules/brk-client/docs/interfaces/SingleItemBuilder.md +++ b/modules/brk-client/docs/interfaces/SingleItemBuilder.md @@ -6,7 +6,7 @@ # Interface: SingleItemBuilder\ -Defined in: [Developer/brk/modules/brk-client/index.js:1045](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1045) +Defined in: [Developer/brk/modules/brk-client/index.js:1205](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1205) ## Type Parameters @@ -16,11 +16,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1045](https://github.com/ ## Properties -### fetch() +### fetch -> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> +> **fetch**: (`onUpdate?`) => `Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\> -Defined in: [Developer/brk/modules/brk-client/index.js:1046](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1046) +Defined in: [Developer/brk/modules/brk-client/index.js:1206](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1206) Fetch the item @@ -32,15 +32,15 @@ Fetch the item #### Returns -`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> +`Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\> *** -### fetchCsv() +### fetchCsv > **fetchCsv**: () => `Promise`\<`string`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1047](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1047) +Defined in: [Developer/brk/modules/brk-client/index.js:1207](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1207) Fetch as CSV @@ -54,6 +54,6 @@ Fetch as CSV > **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1048](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1048) +Defined in: [Developer/brk/modules/brk-client/index.js:1208](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1208) Thenable diff --git a/modules/brk-client/docs/interfaces/SkippedBuilder.md b/modules/brk-client/docs/interfaces/SkippedBuilder.md index 1de352b7f..b87b6ea34 100644 --- a/modules/brk-client/docs/interfaces/SkippedBuilder.md +++ b/modules/brk-client/docs/interfaces/SkippedBuilder.md @@ -6,7 +6,7 @@ # Interface: SkippedBuilder\ -Defined in: [Developer/brk/modules/brk-client/index.js:1053](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1053) +Defined in: [Developer/brk/modules/brk-client/index.js:1217](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1217) ## Type Parameters @@ -16,11 +16,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1053](https://github.com/ ## Properties -### fetch() +### fetch -> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> +> **fetch**: (`onUpdate?`) => `Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\> -Defined in: [Developer/brk/modules/brk-client/index.js:1055](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1055) +Defined in: [Developer/brk/modules/brk-client/index.js:1219](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1219) Fetch from skipped position to end @@ -32,15 +32,15 @@ Fetch from skipped position to end #### Returns -`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> +`Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\> *** -### fetchCsv() +### fetchCsv > **fetchCsv**: () => `Promise`\<`string`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1056](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1056) +Defined in: [Developer/brk/modules/brk-client/index.js:1220](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1220) Fetch as CSV @@ -50,11 +50,11 @@ Fetch as CSV *** -### take() +### take > **take**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1054](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1054) +Defined in: [Developer/brk/modules/brk-client/index.js:1218](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1218) Take n items after skipped position @@ -74,6 +74,6 @@ Take n items after skipped position > **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1057](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1057) +Defined in: [Developer/brk/modules/brk-client/index.js:1221](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1221) Thenable diff --git a/modules/brk-client/docs/interfaces/SpendingSpentUnspentPattern.md b/modules/brk-client/docs/interfaces/SpendingSpentUnspentPattern.md new file mode 100644 index 000000000..b25e0eb9b --- /dev/null +++ b/modules/brk-client/docs/interfaces/SpendingSpentUnspentPattern.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SpendingSpentUnspentPattern + +# Interface: SpendingSpentUnspentPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:3615](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3615) + +## Properties + +### spendingRate + +> **spendingRate**: [`SeriesPattern1`](../type-aliases/SeriesPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3616](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3616) + +*** + +### spentCount + +> **spentCount**: [`AverageBlockCumulativeSumPattern2`](AverageBlockCumulativeSumPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3617](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3617) + +*** + +### unspentCount + +> **unspentCount**: [`BaseDeltaPattern`](BaseDeltaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3618](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L3618) diff --git a/modules/brk-client/docs/interfaces/SupplyState.md b/modules/brk-client/docs/interfaces/SupplyState.md index 7b4b96073..e371ca7d2 100644 --- a/modules/brk-client/docs/interfaces/SupplyState.md +++ b/modules/brk-client/docs/interfaces/SupplyState.md @@ -6,7 +6,7 @@ # Interface: SupplyState -Defined in: [Developer/brk/modules/brk-client/index.js:703](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L703) +Defined in: [Developer/brk/modules/brk-client/index.js:799](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L799) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:703](https://github.com/b > **utxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:704](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L704) +Defined in: [Developer/brk/modules/brk-client/index.js:800](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L800) Number of unspent transaction outputs @@ -24,6 +24,6 @@ Number of unspent transaction outputs > **value**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:705](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L705) +Defined in: [Developer/brk/modules/brk-client/index.js:801](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L801) Total value in satoshis diff --git a/modules/brk-client/docs/interfaces/SyncStatus.md b/modules/brk-client/docs/interfaces/SyncStatus.md index 4c192464f..cac164aa4 100644 --- a/modules/brk-client/docs/interfaces/SyncStatus.md +++ b/modules/brk-client/docs/interfaces/SyncStatus.md @@ -6,7 +6,7 @@ # Interface: SyncStatus -Defined in: [Developer/brk/modules/brk-client/index.js:710](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L710) +Defined in: [Developer/brk/modules/brk-client/index.js:806](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L806) ## Properties @@ -14,17 +14,27 @@ Defined in: [Developer/brk/modules/brk-client/index.js:710](https://github.com/b > **blocksBehind**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:713](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L713) +Defined in: [Developer/brk/modules/brk-client/index.js:810](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L810) Number of blocks behind the tip *** +### computedHeight + +> **computedHeight**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:808](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L808) + +Height of the last computed block (series) + +*** + ### indexedHeight > **indexedHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:711](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L711) +Defined in: [Developer/brk/modules/brk-client/index.js:807](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L807) Height of the last indexed block @@ -34,7 +44,7 @@ Height of the last indexed block > **lastIndexedAt**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:714](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L714) +Defined in: [Developer/brk/modules/brk-client/index.js:811](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L811) Human-readable timestamp of the last indexed block (ISO 8601) @@ -44,7 +54,7 @@ Human-readable timestamp of the last indexed block (ISO 8601) > **lastIndexedAtUnix**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:715](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L715) +Defined in: [Developer/brk/modules/brk-client/index.js:812](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L812) Unix timestamp of the last indexed block @@ -54,6 +64,6 @@ Unix timestamp of the last indexed block > **tipHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:712](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L712) +Defined in: [Developer/brk/modules/brk-client/index.js:809](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L809) Height of the chain tip (from Bitcoin node) diff --git a/modules/brk-client/docs/interfaces/TimePeriodParam.md b/modules/brk-client/docs/interfaces/TimePeriodParam.md index 85c3b8bca..a1401153a 100644 --- a/modules/brk-client/docs/interfaces/TimePeriodParam.md +++ b/modules/brk-client/docs/interfaces/TimePeriodParam.md @@ -6,7 +6,7 @@ # Interface: TimePeriodParam -Defined in: [Developer/brk/modules/brk-client/index.js:726](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L726) +Defined in: [Developer/brk/modules/brk-client/index.js:823](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L823) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:726](https://github.com/b > **timePeriod**: [`TimePeriod`](../type-aliases/TimePeriod.md) -Defined in: [Developer/brk/modules/brk-client/index.js:727](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L727) +Defined in: [Developer/brk/modules/brk-client/index.js:824](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L824) diff --git a/modules/brk-client/docs/interfaces/TimestampParam.md b/modules/brk-client/docs/interfaces/TimestampParam.md index 44389bf0e..dff56ae41 100644 --- a/modules/brk-client/docs/interfaces/TimestampParam.md +++ b/modules/brk-client/docs/interfaces/TimestampParam.md @@ -6,7 +6,7 @@ # Interface: TimestampParam -Defined in: [Developer/brk/modules/brk-client/index.js:735](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L735) +Defined in: [Developer/brk/modules/brk-client/index.js:832](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L832) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:735](https://github.com/b > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:736](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L736) +Defined in: [Developer/brk/modules/brk-client/index.js:833](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L833) diff --git a/modules/brk-client/docs/interfaces/ToPattern.md b/modules/brk-client/docs/interfaces/ToPattern.md new file mode 100644 index 000000000..de9fdf01e --- /dev/null +++ b/modules/brk-client/docs/interfaces/ToPattern.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / ToPattern + +# Interface: ToPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:4047](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4047) + +## Properties + +### toMcap + +> **toMcap**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4048](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4048) + +*** + +### toRcap + +> **toRcap**: [`BpsPercentRatioPattern`](BpsPercentRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4049](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4049) diff --git a/modules/brk-client/docs/interfaces/Transaction.md b/modules/brk-client/docs/interfaces/Transaction.md index f71b907e1..e0ab26398 100644 --- a/modules/brk-client/docs/interfaces/Transaction.md +++ b/modules/brk-client/docs/interfaces/Transaction.md @@ -6,7 +6,7 @@ # Interface: Transaction -Defined in: [Developer/brk/modules/brk-client/index.js:741](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L741) +Defined in: [Developer/brk/modules/brk-client/index.js:838](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L838) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:741](https://github.com/b > **fee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:749](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L749) +Defined in: [Developer/brk/modules/brk-client/index.js:846](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L846) Transaction fee in satoshis @@ -22,9 +22,9 @@ Transaction fee in satoshis ### index? -> `optional` **index**: `number` \| `null` +> `optional` **index?**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:742](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L742) +Defined in: [Developer/brk/modules/brk-client/index.js:839](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L839) *** @@ -32,7 +32,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:742](https://github.com/b > **locktime**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:745](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L745) +Defined in: [Developer/brk/modules/brk-client/index.js:842](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L842) *** @@ -40,7 +40,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:745](https://github.com/b > **sigops**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:748](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L748) +Defined in: [Developer/brk/modules/brk-client/index.js:845](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L845) Number of signature operations @@ -50,7 +50,7 @@ Number of signature operations > **size**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:746](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L746) +Defined in: [Developer/brk/modules/brk-client/index.js:843](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L843) Transaction size in bytes @@ -60,7 +60,7 @@ Transaction size in bytes > **status**: [`TxStatus`](TxStatus.md) -Defined in: [Developer/brk/modules/brk-client/index.js:752](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L752) +Defined in: [Developer/brk/modules/brk-client/index.js:849](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L849) *** @@ -68,7 +68,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:752](https://github.com/b > **txid**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:743](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L743) +Defined in: [Developer/brk/modules/brk-client/index.js:840](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L840) *** @@ -76,7 +76,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:743](https://github.com/b > **version**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:744](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L744) +Defined in: [Developer/brk/modules/brk-client/index.js:841](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L841) *** @@ -84,7 +84,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:744](https://github.com/b > **vin**: [`TxIn`](TxIn.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:750](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L750) +Defined in: [Developer/brk/modules/brk-client/index.js:847](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L847) Transaction inputs @@ -94,7 +94,7 @@ Transaction inputs > **vout**: [`TxOut`](TxOut.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:751](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L751) +Defined in: [Developer/brk/modules/brk-client/index.js:848](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L848) Transaction outputs @@ -104,6 +104,6 @@ Transaction outputs > **weight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:747](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L747) +Defined in: [Developer/brk/modules/brk-client/index.js:844](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L844) Transaction weight diff --git a/modules/brk-client/docs/interfaces/TransferPattern.md b/modules/brk-client/docs/interfaces/TransferPattern.md new file mode 100644 index 000000000..09c51501f --- /dev/null +++ b/modules/brk-client/docs/interfaces/TransferPattern.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / TransferPattern + +# Interface: TransferPattern + +Defined in: [Developer/brk/modules/brk-client/index.js:4117](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4117) + +## Properties + +### transferVolume + +> **transferVolume**: [`AverageBlockCumulativeSumPattern3`](AverageBlockCumulativeSumPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4118](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4118) diff --git a/modules/brk-client/docs/interfaces/TxIn.md b/modules/brk-client/docs/interfaces/TxIn.md index 17b4ec4c1..652be0c04 100644 --- a/modules/brk-client/docs/interfaces/TxIn.md +++ b/modules/brk-client/docs/interfaces/TxIn.md @@ -6,15 +6,15 @@ # Interface: TxIn -Defined in: [Developer/brk/modules/brk-client/index.js:762](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L762) +Defined in: [Developer/brk/modules/brk-client/index.js:859](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L859) ## Properties ### innerRedeemscriptAsm? -> `optional` **innerRedeemscriptAsm**: `string` \| `null` +> `optional` **innerRedeemscriptAsm?**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:770](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L770) +Defined in: [Developer/brk/modules/brk-client/index.js:867](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L867) Inner redeemscript in assembly format (for P2SH-wrapped SegWit) @@ -24,7 +24,7 @@ Inner redeemscript in assembly format (for P2SH-wrapped SegWit) > **isCoinbase**: `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:768](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L768) +Defined in: [Developer/brk/modules/brk-client/index.js:865](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L865) Whether this input is a coinbase (block reward) input @@ -32,9 +32,9 @@ Whether this input is a coinbase (block reward) input ### prevout? -> `optional` **prevout**: [`TxOut`](TxOut.md) \| `null` +> `optional` **prevout?**: [`TxOut`](TxOut.md) \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:765](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L765) +Defined in: [Developer/brk/modules/brk-client/index.js:862](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L862) Information about the previous output being spent @@ -44,7 +44,7 @@ Information about the previous output being spent > **scriptsig**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:766](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L766) +Defined in: [Developer/brk/modules/brk-client/index.js:863](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L863) Signature script (for non-SegWit inputs) @@ -54,7 +54,7 @@ Signature script (for non-SegWit inputs) > **scriptsigAsm**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:767](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L767) +Defined in: [Developer/brk/modules/brk-client/index.js:864](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L864) Signature script in assembly format @@ -64,7 +64,7 @@ Signature script in assembly format > **sequence**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:769](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L769) +Defined in: [Developer/brk/modules/brk-client/index.js:866](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L866) Input sequence number @@ -74,7 +74,7 @@ Input sequence number > **txid**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:763](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L763) +Defined in: [Developer/brk/modules/brk-client/index.js:860](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L860) Transaction ID of the output being spent @@ -84,4 +84,4 @@ Transaction ID of the output being spent > **vout**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:764](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L764) +Defined in: [Developer/brk/modules/brk-client/index.js:861](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L861) diff --git a/modules/brk-client/docs/interfaces/TxOut.md b/modules/brk-client/docs/interfaces/TxOut.md index b38aea01b..8de9a7026 100644 --- a/modules/brk-client/docs/interfaces/TxOut.md +++ b/modules/brk-client/docs/interfaces/TxOut.md @@ -6,7 +6,7 @@ # Interface: TxOut -Defined in: [Developer/brk/modules/brk-client/index.js:777](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L777) +Defined in: [Developer/brk/modules/brk-client/index.js:874](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L874) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:777](https://github.com/b > **scriptpubkey**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:778](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L778) +Defined in: [Developer/brk/modules/brk-client/index.js:875](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L875) Script pubkey (locking script) @@ -24,6 +24,6 @@ Script pubkey (locking script) > **value**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:779](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L779) +Defined in: [Developer/brk/modules/brk-client/index.js:876](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L876) Value of the output in satoshis diff --git a/modules/brk-client/docs/interfaces/TxOutspend.md b/modules/brk-client/docs/interfaces/TxOutspend.md index 40e6e3efe..de7762ba1 100644 --- a/modules/brk-client/docs/interfaces/TxOutspend.md +++ b/modules/brk-client/docs/interfaces/TxOutspend.md @@ -6,7 +6,7 @@ # Interface: TxOutspend -Defined in: [Developer/brk/modules/brk-client/index.js:785](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L785) +Defined in: [Developer/brk/modules/brk-client/index.js:882](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L882) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:785](https://github.com/b > **spent**: `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:786](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L786) +Defined in: [Developer/brk/modules/brk-client/index.js:883](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L883) Whether the output has been spent @@ -22,9 +22,9 @@ Whether the output has been spent ### status? -> `optional` **status**: [`TxStatus`](TxStatus.md) \| `null` +> `optional` **status?**: [`TxStatus`](TxStatus.md) \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:789](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L789) +Defined in: [Developer/brk/modules/brk-client/index.js:886](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L886) Status of the spending transaction (only present if spent) @@ -32,9 +32,9 @@ Status of the spending transaction (only present if spent) ### txid? -> `optional` **txid**: `string` \| `null` +> `optional` **txid?**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:787](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L787) +Defined in: [Developer/brk/modules/brk-client/index.js:884](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L884) Transaction ID of the spending transaction (only present if spent) @@ -42,8 +42,8 @@ Transaction ID of the spending transaction (only present if spent) ### vin? -> `optional` **vin**: `number` \| `null` +> `optional` **vin?**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:788](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L788) +Defined in: [Developer/brk/modules/brk-client/index.js:885](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L885) Input index in the spending transaction (only present if spent) diff --git a/modules/brk-client/docs/interfaces/TxStatus.md b/modules/brk-client/docs/interfaces/TxStatus.md index 6417594aa..e26f23c9e 100644 --- a/modules/brk-client/docs/interfaces/TxStatus.md +++ b/modules/brk-client/docs/interfaces/TxStatus.md @@ -6,15 +6,15 @@ # Interface: TxStatus -Defined in: [Developer/brk/modules/brk-client/index.js:794](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L794) +Defined in: [Developer/brk/modules/brk-client/index.js:891](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L891) ## Properties ### blockHash? -> `optional` **blockHash**: `string` \| `null` +> `optional` **blockHash?**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:797](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L797) +Defined in: [Developer/brk/modules/brk-client/index.js:894](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L894) Block hash (only present if confirmed) @@ -22,9 +22,9 @@ Block hash (only present if confirmed) ### blockHeight? -> `optional` **blockHeight**: `number` \| `null` +> `optional` **blockHeight?**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:796](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L796) +Defined in: [Developer/brk/modules/brk-client/index.js:893](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L893) Block height (only present if confirmed) @@ -32,9 +32,9 @@ Block height (only present if confirmed) ### blockTime? -> `optional` **blockTime**: `number` \| `null` +> `optional` **blockTime?**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:798](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L798) +Defined in: [Developer/brk/modules/brk-client/index.js:895](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L895) Block timestamp (only present if confirmed) @@ -44,6 +44,6 @@ Block timestamp (only present if confirmed) > **confirmed**: `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:795](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L795) +Defined in: [Developer/brk/modules/brk-client/index.js:892](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L892) Whether the transaction is confirmed diff --git a/modules/brk-client/docs/interfaces/TxidParam.md b/modules/brk-client/docs/interfaces/TxidParam.md index 56cf1bcd9..759f359c4 100644 --- a/modules/brk-client/docs/interfaces/TxidParam.md +++ b/modules/brk-client/docs/interfaces/TxidParam.md @@ -6,7 +6,7 @@ # Interface: TxidParam -Defined in: [Developer/brk/modules/brk-client/index.js:811](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L811) +Defined in: [Developer/brk/modules/brk-client/index.js:908](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L908) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:811](https://github.com/b > **txid**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:812](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L812) +Defined in: [Developer/brk/modules/brk-client/index.js:909](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L909) diff --git a/modules/brk-client/docs/interfaces/TxidVout.md b/modules/brk-client/docs/interfaces/TxidVout.md index a5ad8d06e..f60632063 100644 --- a/modules/brk-client/docs/interfaces/TxidVout.md +++ b/modules/brk-client/docs/interfaces/TxidVout.md @@ -6,7 +6,7 @@ # Interface: TxidVout -Defined in: [Developer/brk/modules/brk-client/index.js:817](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L817) +Defined in: [Developer/brk/modules/brk-client/index.js:914](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L914) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:817](https://github.com/b > **txid**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:818](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L818) +Defined in: [Developer/brk/modules/brk-client/index.js:915](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L915) Transaction ID @@ -24,6 +24,6 @@ Transaction ID > **vout**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:819](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L819) +Defined in: [Developer/brk/modules/brk-client/index.js:916](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L916) Output index diff --git a/modules/brk-client/docs/interfaces/Utxo.md b/modules/brk-client/docs/interfaces/Utxo.md index 64197faa3..546a635ae 100644 --- a/modules/brk-client/docs/interfaces/Utxo.md +++ b/modules/brk-client/docs/interfaces/Utxo.md @@ -6,7 +6,7 @@ # Interface: Utxo -Defined in: [Developer/brk/modules/brk-client/index.js:835](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L835) +Defined in: [Developer/brk/modules/brk-client/index.js:932](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L932) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:835](https://github.com/b > **status**: [`TxStatus`](TxStatus.md) -Defined in: [Developer/brk/modules/brk-client/index.js:838](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L838) +Defined in: [Developer/brk/modules/brk-client/index.js:935](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L935) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:838](https://github.com/b > **txid**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:836](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L836) +Defined in: [Developer/brk/modules/brk-client/index.js:933](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L933) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:836](https://github.com/b > **value**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:839](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L839) +Defined in: [Developer/brk/modules/brk-client/index.js:936](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L936) *** @@ -38,4 +38,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:839](https://github.com/b > **vout**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:837](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L837) +Defined in: [Developer/brk/modules/brk-client/index.js:934](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L934) diff --git a/modules/brk-client/docs/interfaces/UtxoPattern.md b/modules/brk-client/docs/interfaces/UtxoPattern.md deleted file mode 100644 index d0a14db8b..000000000 --- a/modules/brk-client/docs/interfaces/UtxoPattern.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / UtxoPattern - -# Interface: UtxoPattern - -Defined in: [Developer/brk/modules/brk-client/index.js:3404](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3404) - -## Properties - -### utxoCount - -> **utxoCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3405](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3405) - -*** - -### utxoCount30dChange - -> **utxoCount30dChange**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3406](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L3406) diff --git a/modules/brk-client/docs/interfaces/ValidateAddrParam.md b/modules/brk-client/docs/interfaces/ValidateAddrParam.md new file mode 100644 index 000000000..0292b6253 --- /dev/null +++ b/modules/brk-client/docs/interfaces/ValidateAddrParam.md @@ -0,0 +1,19 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / ValidateAddrParam + +# Interface: ValidateAddrParam + +Defined in: [Developer/brk/modules/brk-client/index.js:944](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L944) + +## Properties + +### address + +> **address**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:945](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L945) + +Bitcoin address to validate (can be any string) diff --git a/modules/brk-client/docs/interfaces/ValidateAddressParam.md b/modules/brk-client/docs/interfaces/ValidateAddressParam.md deleted file mode 100644 index 56d1fc7d0..000000000 --- a/modules/brk-client/docs/interfaces/ValidateAddressParam.md +++ /dev/null @@ -1,19 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / ValidateAddressParam - -# Interface: ValidateAddressParam - -Defined in: [Developer/brk/modules/brk-client/index.js:847](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L847) - -## Properties - -### address - -> **address**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:848](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L848) - -Bitcoin address to validate (can be any string) diff --git a/modules/brk-client/docs/type-aliases/Addr.md b/modules/brk-client/docs/type-aliases/Addr.md new file mode 100644 index 000000000..53350497e --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Addr.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Addr + +# Type Alias: Addr + +> **Addr** = `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:9](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L9) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Address.md b/modules/brk-client/docs/type-aliases/Address.md deleted file mode 100644 index b6b845746..000000000 --- a/modules/brk-client/docs/type-aliases/Address.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / Address - -# Type Alias: Address - -> **Address**\<\> = `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:9](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L9) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnyAddrIndex.md b/modules/brk-client/docs/type-aliases/AnyAddrIndex.md new file mode 100644 index 000000000..a3768d298 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/AnyAddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AnyAddrIndex + +# Type Alias: AnyAddrIndex + +> **AnyAddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:67](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L67) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnyAddressIndex.md b/modules/brk-client/docs/type-aliases/AnyAddressIndex.md deleted file mode 100644 index a43aae4d3..000000000 --- a/modules/brk-client/docs/type-aliases/AnyAddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AnyAddressIndex - -# Type Alias: AnyAddressIndex - -> **AnyAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:68](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L68) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnyMetricData.md b/modules/brk-client/docs/type-aliases/AnyMetricData.md deleted file mode 100644 index 31a58db6b..000000000 --- a/modules/brk-client/docs/type-aliases/AnyMetricData.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AnyMetricData - -# Type Alias: AnyMetricData - -> **AnyMetricData**\<\> = [`MetricData`](../interfaces/MetricData.md)\<`any`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1019](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1019) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnyMetricEndpointBuilder.md b/modules/brk-client/docs/type-aliases/AnyMetricEndpointBuilder.md deleted file mode 100644 index 45d49d609..000000000 --- a/modules/brk-client/docs/type-aliases/AnyMetricEndpointBuilder.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AnyMetricEndpointBuilder - -# Type Alias: AnyMetricEndpointBuilder - -> **AnyMetricEndpointBuilder**\<\> = [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`any`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1041](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1041) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnyMetricPattern.md b/modules/brk-client/docs/type-aliases/AnyMetricPattern.md deleted file mode 100644 index adb9f2b3a..000000000 --- a/modules/brk-client/docs/type-aliases/AnyMetricPattern.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AnyMetricPattern - -# Type Alias: AnyMetricPattern - -> **AnyMetricPattern**\<\> = [`MetricPattern`](../interfaces/MetricPattern.md)\<`any`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:1077](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1077) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnySeriesData.md b/modules/brk-client/docs/type-aliases/AnySeriesData.md new file mode 100644 index 000000000..51be4f4e4 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/AnySeriesData.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AnySeriesData + +# Type Alias: AnySeriesData + +> **AnySeriesData** = [`SeriesData`](SeriesData.md)\<`any`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1170](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1170) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnySeriesEndpoint.md b/modules/brk-client/docs/type-aliases/AnySeriesEndpoint.md new file mode 100644 index 000000000..cb1969d31 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/AnySeriesEndpoint.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AnySeriesEndpoint + +# Type Alias: AnySeriesEndpoint + +> **AnySeriesEndpoint** = [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`any`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1203](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1203) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnySeriesPattern.md b/modules/brk-client/docs/type-aliases/AnySeriesPattern.md new file mode 100644 index 000000000..53eea5b95 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/AnySeriesPattern.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / AnySeriesPattern + +# Type Alias: AnySeriesPattern + +> **AnySeriesPattern** = [`SeriesPattern`](../interfaces/SeriesPattern.md)\<`any`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1252](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1252) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/BasisPoints16.md b/modules/brk-client/docs/type-aliases/BasisPoints16.md new file mode 100644 index 000000000..8e4536e10 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/BasisPoints16.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BasisPoints16 + +# Type Alias: BasisPoints16 + +> **BasisPoints16** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:75](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L75) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/BasisPoints32.md b/modules/brk-client/docs/type-aliases/BasisPoints32.md new file mode 100644 index 000000000..3cb1b9a0c --- /dev/null +++ b/modules/brk-client/docs/type-aliases/BasisPoints32.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BasisPoints32 + +# Type Alias: BasisPoints32 + +> **BasisPoints32** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:83](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L83) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/BasisPointsSigned16.md b/modules/brk-client/docs/type-aliases/BasisPointsSigned16.md new file mode 100644 index 000000000..c3523652a --- /dev/null +++ b/modules/brk-client/docs/type-aliases/BasisPointsSigned16.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BasisPointsSigned16 + +# Type Alias: BasisPointsSigned16 + +> **BasisPointsSigned16** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:91](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L91) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/BasisPointsSigned32.md b/modules/brk-client/docs/type-aliases/BasisPointsSigned32.md new file mode 100644 index 000000000..3211b02d9 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/BasisPointsSigned32.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BasisPointsSigned32 + +# Type Alias: BasisPointsSigned32 + +> **BasisPointsSigned32** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:99](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L99) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Bitcoin.md b/modules/brk-client/docs/type-aliases/Bitcoin.md index bf58e1dbe..0be190a04 100644 --- a/modules/brk-client/docs/type-aliases/Bitcoin.md +++ b/modules/brk-client/docs/type-aliases/Bitcoin.md @@ -6,8 +6,8 @@ # Type Alias: Bitcoin -> **Bitcoin**\<\> = `number` +> **Bitcoin** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:73](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L73) +Defined in: [Developer/brk/modules/brk-client/index.js:104](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L104) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/BlkPosition.md b/modules/brk-client/docs/type-aliases/BlkPosition.md deleted file mode 100644 index e5a88040f..000000000 --- a/modules/brk-client/docs/type-aliases/BlkPosition.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / BlkPosition - -# Type Alias: BlkPosition - -> **BlkPosition**\<\> = `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:78](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L78) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/BlockHash.md b/modules/brk-client/docs/type-aliases/BlockHash.md index 584ead8be..288e04d2f 100644 --- a/modules/brk-client/docs/type-aliases/BlockHash.md +++ b/modules/brk-client/docs/type-aliases/BlockHash.md @@ -6,8 +6,8 @@ # Type Alias: BlockHash -> **BlockHash**\<\> = `string` +> **BlockHash** = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:95](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L95) +Defined in: [Developer/brk/modules/brk-client/index.js:121](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L121) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Cents.md b/modules/brk-client/docs/type-aliases/Cents.md new file mode 100644 index 000000000..206429dd6 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Cents.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Cents + +# Type Alias: Cents + +> **Cents** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:200](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L200) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/CentsSats.md b/modules/brk-client/docs/type-aliases/CentsSats.md index 550654b2b..6de901a8e 100644 --- a/modules/brk-client/docs/type-aliases/CentsSats.md +++ b/modules/brk-client/docs/type-aliases/CentsSats.md @@ -6,8 +6,8 @@ # Type Alias: CentsSats -> **CentsSats**\<\> = `number` +> **CentsSats** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:174](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L174) +Defined in: [Developer/brk/modules/brk-client/index.js:206](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L206) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/CentsSigned.md b/modules/brk-client/docs/type-aliases/CentsSigned.md new file mode 100644 index 000000000..fdac2d452 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/CentsSigned.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / CentsSigned + +# Type Alias: CentsSigned + +> **CentsSigned** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:212](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L212) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/CentsSquaredSats.md b/modules/brk-client/docs/type-aliases/CentsSquaredSats.md index 900411386..566dc15a9 100644 --- a/modules/brk-client/docs/type-aliases/CentsSquaredSats.md +++ b/modules/brk-client/docs/type-aliases/CentsSquaredSats.md @@ -6,8 +6,8 @@ # Type Alias: CentsSquaredSats -> **CentsSquaredSats**\<\> = `number` +> **CentsSquaredSats** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:181](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L181) +Defined in: [Developer/brk/modules/brk-client/index.js:219](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L219) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/CentsUnsigned.md b/modules/brk-client/docs/type-aliases/CentsUnsigned.md deleted file mode 100644 index e3b909ced..000000000 --- a/modules/brk-client/docs/type-aliases/CentsUnsigned.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CentsUnsigned - -# Type Alias: CentsUnsigned - -> **CentsUnsigned**\<\> = `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:187](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L187) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Close.md b/modules/brk-client/docs/type-aliases/Close.md index a2aac73d5..75b65eb86 100644 --- a/modules/brk-client/docs/type-aliases/Close.md +++ b/modules/brk-client/docs/type-aliases/Close.md @@ -6,8 +6,8 @@ # Type Alias: Close -> **Close**\<\> = [`CentsUnsigned`](CentsUnsigned.md) +> **Close** = [`Dollars`](Dollars.md) -Defined in: [Developer/brk/modules/brk-client/index.js:192](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L192) +Defined in: [Developer/brk/modules/brk-client/index.js:224](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L224) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Cohort.md b/modules/brk-client/docs/type-aliases/Cohort.md index 586f15b1a..32834d4fc 100644 --- a/modules/brk-client/docs/type-aliases/Cohort.md +++ b/modules/brk-client/docs/type-aliases/Cohort.md @@ -6,8 +6,8 @@ # Type Alias: Cohort -> **Cohort**\<\> = `string` +> **Cohort** = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:197](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L197) +Defined in: [Developer/brk/modules/brk-client/index.js:229](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L229) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/CostBasisBucket.md b/modules/brk-client/docs/type-aliases/CostBasisBucket.md index 383ccb4e0..127284434 100644 --- a/modules/brk-client/docs/type-aliases/CostBasisBucket.md +++ b/modules/brk-client/docs/type-aliases/CostBasisBucket.md @@ -6,8 +6,8 @@ # Type Alias: CostBasisBucket -> **CostBasisBucket**\<\> = `"raw"` \| `"lin200"` \| `"lin500"` \| `"lin1000"` \| `"log10"` \| `"log50"` \| `"log100"` \| `"log200"` +> **CostBasisBucket** = `"raw"` \| `"lin200"` \| `"lin500"` \| `"lin1000"` \| `"log10"` \| `"log50"` \| `"log100"` \| `"log200"` -Defined in: [Developer/brk/modules/brk-client/index.js:204](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L204) +Defined in: [Developer/brk/modules/brk-client/index.js:236](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L236) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/CostBasisValue.md b/modules/brk-client/docs/type-aliases/CostBasisValue.md index 2c5557c05..e9778a542 100644 --- a/modules/brk-client/docs/type-aliases/CostBasisValue.md +++ b/modules/brk-client/docs/type-aliases/CostBasisValue.md @@ -6,8 +6,8 @@ # Type Alias: CostBasisValue -> **CostBasisValue**\<\> = `"supply"` \| `"realized"` \| `"unrealized"` +> **CostBasisValue** = `"supply"` \| `"realized"` \| `"unrealized"` -Defined in: [Developer/brk/modules/brk-client/index.js:230](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L230) +Defined in: [Developer/brk/modules/brk-client/index.js:262](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L262) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Date.md b/modules/brk-client/docs/type-aliases/Date.md index 724275dcc..6f7f4ed07 100644 --- a/modules/brk-client/docs/type-aliases/Date.md +++ b/modules/brk-client/docs/type-aliases/Date.md @@ -6,8 +6,8 @@ # Type Alias: Date -> **Date**\<\> = `number` +> **Date** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:244](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L244) +Defined in: [Developer/brk/modules/brk-client/index.js:276](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L276) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/DateIndex.md b/modules/brk-client/docs/type-aliases/DateIndex.md deleted file mode 100644 index 89b819e23..000000000 --- a/modules/brk-client/docs/type-aliases/DateIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / DateIndex - -# Type Alias: DateIndex - -> **DateIndex**\<\> = `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:246](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L246) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/DateSeriesData.md b/modules/brk-client/docs/type-aliases/DateSeriesData.md new file mode 100644 index 000000000..0978385a5 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/DateSeriesData.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DateSeriesData + +# Type Alias: DateSeriesData\ + +> **DateSeriesData**\<`T`\> = [`SeriesData`](SeriesData.md)\<`T`\> & [`DateSeriesDataExtras`](../interfaces/DateSeriesDataExtras.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1169](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1169) + +## Type Parameters + +### T + +`T` diff --git a/modules/brk-client/docs/type-aliases/DateThenable.md b/modules/brk-client/docs/type-aliases/DateThenable.md new file mode 100644 index 000000000..a128de790 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/DateThenable.md @@ -0,0 +1,31 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DateThenable + +# Type Alias: DateThenable\ + +> **DateThenable**\<`T`\> = (`onfulfilled?`, `onrejected?`) => `Promise`\<[`DateSeriesData`](DateSeriesData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1173](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1173) + +## Type Parameters + +### T + +`T` + +## Parameters + +### onfulfilled? + +(`value`) => `any` + +### onrejected? + +(`reason`) => `never` + +## Returns + +`Promise`\<[`DateSeriesData`](DateSeriesData.md)\<`T`\>\> diff --git a/modules/brk-client/docs/type-aliases/Day1.md b/modules/brk-client/docs/type-aliases/Day1.md new file mode 100644 index 000000000..f4e5b77a2 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Day1.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Day1 + +# Type Alias: Day1 + +> **Day1** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:278](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L278) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Day3.md b/modules/brk-client/docs/type-aliases/Day3.md new file mode 100644 index 000000000..ca0b201f5 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Day3.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Day3 + +# Type Alias: Day3 + +> **Day3** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:279](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L279) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/DecadeIndex.md b/modules/brk-client/docs/type-aliases/DecadeIndex.md deleted file mode 100644 index d992c6ea8..000000000 --- a/modules/brk-client/docs/type-aliases/DecadeIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / DecadeIndex - -# Type Alias: DecadeIndex - -> **DecadeIndex**\<\> = `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:247](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L247) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Dollars.md b/modules/brk-client/docs/type-aliases/Dollars.md index b81375c7a..21bb49ddd 100644 --- a/modules/brk-client/docs/type-aliases/Dollars.md +++ b/modules/brk-client/docs/type-aliases/Dollars.md @@ -6,8 +6,8 @@ # Type Alias: Dollars -> **Dollars**\<\> = `number` +> **Dollars** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:295](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L295) +Defined in: [Developer/brk/modules/brk-client/index.js:336](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L336) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/EmptyAddrIndex.md b/modules/brk-client/docs/type-aliases/EmptyAddrIndex.md new file mode 100644 index 000000000..8e2717451 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/EmptyAddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / EmptyAddrIndex + +# Type Alias: EmptyAddrIndex + +> **EmptyAddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:346](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L346) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/EmptyAddressIndex.md b/modules/brk-client/docs/type-aliases/EmptyAddressIndex.md deleted file mode 100644 index 3a92a2319..000000000 --- a/modules/brk-client/docs/type-aliases/EmptyAddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / EmptyAddressIndex - -# Type Alias: EmptyAddressIndex - -> **EmptyAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:305](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L305) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/EmptyOutputIndex.md b/modules/brk-client/docs/type-aliases/EmptyOutputIndex.md index dd653ad11..2ddac99e3 100644 --- a/modules/brk-client/docs/type-aliases/EmptyOutputIndex.md +++ b/modules/brk-client/docs/type-aliases/EmptyOutputIndex.md @@ -6,8 +6,8 @@ # Type Alias: EmptyOutputIndex -> **EmptyOutputIndex**\<\> = [`TypeIndex`](TypeIndex.md) +> **EmptyOutputIndex** = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:306](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L306) +Defined in: [Developer/brk/modules/brk-client/index.js:347](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L347) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Epoch.md b/modules/brk-client/docs/type-aliases/Epoch.md index fa98abb3f..9e89a6319 100644 --- a/modules/brk-client/docs/type-aliases/Epoch.md +++ b/modules/brk-client/docs/type-aliases/Epoch.md @@ -6,8 +6,8 @@ # Type Alias: Epoch -> **Epoch**\<\> = `number` +> **Epoch** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:281](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L281) +Defined in: [Developer/brk/modules/brk-client/index.js:348](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L348) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/FeeRate.md b/modules/brk-client/docs/type-aliases/FeeRate.md index 1a92c9245..2933dfa9a 100644 --- a/modules/brk-client/docs/type-aliases/FeeRate.md +++ b/modules/brk-client/docs/type-aliases/FeeRate.md @@ -6,8 +6,8 @@ # Type Alias: FeeRate -> **FeeRate**\<\> = `number` +> **FeeRate** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:310](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L310) +Defined in: [Developer/brk/modules/brk-client/index.js:363](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L363) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Format.md b/modules/brk-client/docs/type-aliases/Format.md index 684c12060..e30905ec2 100644 --- a/modules/brk-client/docs/type-aliases/Format.md +++ b/modules/brk-client/docs/type-aliases/Format.md @@ -6,8 +6,8 @@ # Type Alias: Format -> **Format**\<\> = `"json"` \| `"csv"` +> **Format** = `"json"` \| `"csv"` -Defined in: [Developer/brk/modules/brk-client/index.js:315](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L315) +Defined in: [Developer/brk/modules/brk-client/index.js:368](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L368) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/FundedAddrIndex.md b/modules/brk-client/docs/type-aliases/FundedAddrIndex.md new file mode 100644 index 000000000..6a7133e68 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/FundedAddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / FundedAddrIndex + +# Type Alias: FundedAddrIndex + +> **FundedAddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:382](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L382) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/FundedAddressIndex.md b/modules/brk-client/docs/type-aliases/FundedAddressIndex.md deleted file mode 100644 index d30812ab9..000000000 --- a/modules/brk-client/docs/type-aliases/FundedAddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / FundedAddressIndex - -# Type Alias: FundedAddressIndex - -> **FundedAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:329](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L329) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Halving.md b/modules/brk-client/docs/type-aliases/Halving.md index 9b147423d..c010ea100 100644 --- a/modules/brk-client/docs/type-aliases/Halving.md +++ b/modules/brk-client/docs/type-aliases/Halving.md @@ -6,8 +6,8 @@ # Type Alias: Halving -> **Halving**\<\> = `number` +> **Halving** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:330](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L330) +Defined in: [Developer/brk/modules/brk-client/index.js:383](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L383) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Height.md b/modules/brk-client/docs/type-aliases/Height.md index 04851594d..3e13dd98e 100644 --- a/modules/brk-client/docs/type-aliases/Height.md +++ b/modules/brk-client/docs/type-aliases/Height.md @@ -6,8 +6,8 @@ # Type Alias: Height -> **Height**\<\> = `number` +> **Height** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:360](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L360) +Defined in: [Developer/brk/modules/brk-client/index.js:420](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L420) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Hex.md b/modules/brk-client/docs/type-aliases/Hex.md index 4b4799b3b..193fd3214 100644 --- a/modules/brk-client/docs/type-aliases/Hex.md +++ b/modules/brk-client/docs/type-aliases/Hex.md @@ -6,8 +6,8 @@ # Type Alias: Hex -> **Hex**\<\> = `string` +> **Hex** = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:369](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L369) +Defined in: [Developer/brk/modules/brk-client/index.js:429](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L429) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/High.md b/modules/brk-client/docs/type-aliases/High.md index 7ae2ad2c8..2dbabb012 100644 --- a/modules/brk-client/docs/type-aliases/High.md +++ b/modules/brk-client/docs/type-aliases/High.md @@ -6,8 +6,8 @@ # Type Alias: High -> **High**\<\> = [`CentsUnsigned`](CentsUnsigned.md) +> **High** = [`Dollars`](Dollars.md) -Defined in: [Developer/brk/modules/brk-client/index.js:374](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L374) +Defined in: [Developer/brk/modules/brk-client/index.js:434](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L434) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Hour1.md b/modules/brk-client/docs/type-aliases/Hour1.md new file mode 100644 index 000000000..194e6d387 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Hour1.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Hour1 + +# Type Alias: Hour1 + +> **Hour1** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:436](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L436) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Hour12.md b/modules/brk-client/docs/type-aliases/Hour12.md new file mode 100644 index 000000000..020073680 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Hour12.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Hour12 + +# Type Alias: Hour12 + +> **Hour12** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:437](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L437) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Hour4.md b/modules/brk-client/docs/type-aliases/Hour4.md new file mode 100644 index 000000000..e3693ee8a --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Hour4.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Hour4 + +# Type Alias: Hour4 + +> **Hour4** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:438](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L438) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Index.md b/modules/brk-client/docs/type-aliases/Index.md index f2b769072..ab148e1ca 100644 --- a/modules/brk-client/docs/type-aliases/Index.md +++ b/modules/brk-client/docs/type-aliases/Index.md @@ -6,8 +6,8 @@ # Type Alias: Index -> **Index**\<\> = `"dateindex"` \| `"decadeindex"` \| `"difficultyepoch"` \| `"emptyoutputindex"` \| `"halvingepoch"` \| `"height"` \| `"txinindex"` \| `"monthindex"` \| `"opreturnindex"` \| `"txoutindex"` \| `"p2aaddressindex"` \| `"p2msoutputindex"` \| `"p2pk33addressindex"` \| `"p2pk65addressindex"` \| `"p2pkhaddressindex"` \| `"p2shaddressindex"` \| `"p2traddressindex"` \| `"p2wpkhaddressindex"` \| `"p2wshaddressindex"` \| `"quarterindex"` \| `"semesterindex"` \| `"txindex"` \| `"unknownoutputindex"` \| `"weekindex"` \| `"yearindex"` \| `"fundedaddressindex"` \| `"emptyaddressindex"` \| `"pairoutputindex"` +> **Index** = `"minute10"` \| `"minute30"` \| `"hour1"` \| `"hour4"` \| `"hour12"` \| `"day1"` \| `"day3"` \| `"week1"` \| `"month1"` \| `"month3"` \| `"month6"` \| `"year1"` \| `"year10"` \| `"halving"` \| `"epoch"` \| `"height"` \| `"tx_index"` \| `"txin_index"` \| `"txout_index"` \| `"empty_output_index"` \| `"op_return_index"` \| `"p2a_addr_index"` \| `"p2ms_output_index"` \| `"p2pk33_addr_index"` \| `"p2pk65_addr_index"` \| `"p2pkh_addr_index"` \| `"p2sh_addr_index"` \| `"p2tr_addr_index"` \| `"p2wpkh_addr_index"` \| `"p2wsh_addr_index"` \| `"unknown_output_index"` \| `"funded_addr_index"` \| `"empty_addr_index"` -Defined in: [Developer/brk/modules/brk-client/index.js:380](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L380) +Defined in: [Developer/brk/modules/brk-client/index.js:443](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L443) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Limit.md b/modules/brk-client/docs/type-aliases/Limit.md index 8e4b7eb91..baf156fa0 100644 --- a/modules/brk-client/docs/type-aliases/Limit.md +++ b/modules/brk-client/docs/type-aliases/Limit.md @@ -6,8 +6,8 @@ # Type Alias: Limit -> **Limit**\<\> = `number` +> **Limit** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:392](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L392) +Defined in: [Developer/brk/modules/brk-client/index.js:468](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L468) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Low.md b/modules/brk-client/docs/type-aliases/Low.md index 0abc0de95..29b5e4760 100644 --- a/modules/brk-client/docs/type-aliases/Low.md +++ b/modules/brk-client/docs/type-aliases/Low.md @@ -6,8 +6,8 @@ # Type Alias: Low -> **Low**\<\> = [`CentsUnsigned`](CentsUnsigned.md) +> **Low** = [`Dollars`](Dollars.md) -Defined in: [Developer/brk/modules/brk-client/index.js:401](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L401) +Defined in: [Developer/brk/modules/brk-client/index.js:473](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L473) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Metric.md b/modules/brk-client/docs/type-aliases/Metric.md deleted file mode 100644 index f97bbfae2..000000000 --- a/modules/brk-client/docs/type-aliases/Metric.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / Metric - -# Type Alias: Metric - -> **Metric**\<\> = `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:425](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L425) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/MetricPattern1.md b/modules/brk-client/docs/type-aliases/MetricPattern1.md deleted file mode 100644 index c2d78494d..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern1.md +++ /dev/null @@ -1,85 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern1 - -# Type Alias: MetricPattern1\ - -> **MetricPattern1**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1341](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1341) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.dateindex - -> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.decadeindex - -> `readonly` **decadeindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.difficultyepoch - -> `readonly` **difficultyepoch**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.height - -> `readonly` **height**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.monthindex - -> `readonly` **monthindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.quarterindex - -> `readonly` **quarterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.semesterindex - -> `readonly` **semesterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.weekindex - -> `readonly` **weekindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.yearindex - -> `readonly` **yearindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern10.md b/modules/brk-client/docs/type-aliases/MetricPattern10.md deleted file mode 100644 index 5d4f151f6..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern10.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern10 - -# Type Alias: MetricPattern10\ - -> **MetricPattern10**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1368](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1368) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.halvingepoch - -> `readonly` **halvingepoch**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern11.md b/modules/brk-client/docs/type-aliases/MetricPattern11.md deleted file mode 100644 index 5c3119899..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern11.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern11 - -# Type Alias: MetricPattern11\ - -> **MetricPattern11**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1371](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1371) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.height - -> `readonly` **height**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern12.md b/modules/brk-client/docs/type-aliases/MetricPattern12.md deleted file mode 100644 index 3af25d0e2..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern12.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern12 - -# Type Alias: MetricPattern12\ - -> **MetricPattern12**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1374](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1374) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.txinindex - -> `readonly` **txinindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern13.md b/modules/brk-client/docs/type-aliases/MetricPattern13.md deleted file mode 100644 index 761f22694..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern13.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern13 - -# Type Alias: MetricPattern13\ - -> **MetricPattern13**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1377](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1377) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.monthindex - -> `readonly` **monthindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern14.md b/modules/brk-client/docs/type-aliases/MetricPattern14.md deleted file mode 100644 index 4f37fb267..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern14.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern14 - -# Type Alias: MetricPattern14\ - -> **MetricPattern14**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1380](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1380) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.opreturnindex - -> `readonly` **opreturnindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern15.md b/modules/brk-client/docs/type-aliases/MetricPattern15.md deleted file mode 100644 index 887af36bc..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern15.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern15 - -# Type Alias: MetricPattern15\ - -> **MetricPattern15**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1383](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1383) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.txoutindex - -> `readonly` **txoutindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern16.md b/modules/brk-client/docs/type-aliases/MetricPattern16.md deleted file mode 100644 index bb08be738..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern16.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern16 - -# Type Alias: MetricPattern16\ - -> **MetricPattern16**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1386](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1386) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.p2aaddressindex - -> `readonly` **p2aaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern17.md b/modules/brk-client/docs/type-aliases/MetricPattern17.md deleted file mode 100644 index 5810e9039..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern17.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern17 - -# Type Alias: MetricPattern17\ - -> **MetricPattern17**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1389](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1389) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.p2msoutputindex - -> `readonly` **p2msoutputindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern18.md b/modules/brk-client/docs/type-aliases/MetricPattern18.md deleted file mode 100644 index 69f21c3aa..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern18.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern18 - -# Type Alias: MetricPattern18\ - -> **MetricPattern18**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1392](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1392) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.p2pk33addressindex - -> `readonly` **p2pk33addressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern19.md b/modules/brk-client/docs/type-aliases/MetricPattern19.md deleted file mode 100644 index 31c3ff0f4..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern19.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern19 - -# Type Alias: MetricPattern19\ - -> **MetricPattern19**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1395](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1395) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.p2pk65addressindex - -> `readonly` **p2pk65addressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern2.md b/modules/brk-client/docs/type-aliases/MetricPattern2.md deleted file mode 100644 index 120bc1b98..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern2.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern2 - -# Type Alias: MetricPattern2\ - -> **MetricPattern2**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1344](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1344) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.dateindex - -> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.decadeindex - -> `readonly` **decadeindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.difficultyepoch - -> `readonly` **difficultyepoch**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.monthindex - -> `readonly` **monthindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.quarterindex - -> `readonly` **quarterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.semesterindex - -> `readonly` **semesterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.weekindex - -> `readonly` **weekindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.yearindex - -> `readonly` **yearindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern20.md b/modules/brk-client/docs/type-aliases/MetricPattern20.md deleted file mode 100644 index 06dbb888c..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern20.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern20 - -# Type Alias: MetricPattern20\ - -> **MetricPattern20**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1398](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1398) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.p2pkhaddressindex - -> `readonly` **p2pkhaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern21.md b/modules/brk-client/docs/type-aliases/MetricPattern21.md deleted file mode 100644 index ac1ec53a2..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern21.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern21 - -# Type Alias: MetricPattern21\ - -> **MetricPattern21**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1401](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1401) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.p2shaddressindex - -> `readonly` **p2shaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern22.md b/modules/brk-client/docs/type-aliases/MetricPattern22.md deleted file mode 100644 index 6eea951b0..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern22.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern22 - -# Type Alias: MetricPattern22\ - -> **MetricPattern22**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1404](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1404) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.p2traddressindex - -> `readonly` **p2traddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern23.md b/modules/brk-client/docs/type-aliases/MetricPattern23.md deleted file mode 100644 index 05b363422..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern23.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern23 - -# Type Alias: MetricPattern23\ - -> **MetricPattern23**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1407](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1407) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.p2wpkhaddressindex - -> `readonly` **p2wpkhaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern24.md b/modules/brk-client/docs/type-aliases/MetricPattern24.md deleted file mode 100644 index ba38e2d8c..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern24.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern24 - -# Type Alias: MetricPattern24\ - -> **MetricPattern24**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1410](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1410) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.p2wshaddressindex - -> `readonly` **p2wshaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern25.md b/modules/brk-client/docs/type-aliases/MetricPattern25.md deleted file mode 100644 index 9659b55a7..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern25.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern25 - -# Type Alias: MetricPattern25\ - -> **MetricPattern25**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1413](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1413) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.quarterindex - -> `readonly` **quarterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern26.md b/modules/brk-client/docs/type-aliases/MetricPattern26.md deleted file mode 100644 index d50ff420a..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern26.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern26 - -# Type Alias: MetricPattern26\ - -> **MetricPattern26**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1416](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1416) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.semesterindex - -> `readonly` **semesterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern27.md b/modules/brk-client/docs/type-aliases/MetricPattern27.md deleted file mode 100644 index eadf53fbe..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern27.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern27 - -# Type Alias: MetricPattern27\ - -> **MetricPattern27**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1419](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1419) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.txindex - -> `readonly` **txindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern28.md b/modules/brk-client/docs/type-aliases/MetricPattern28.md deleted file mode 100644 index d495d2dd3..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern28.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern28 - -# Type Alias: MetricPattern28\ - -> **MetricPattern28**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1422](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1422) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.unknownoutputindex - -> `readonly` **unknownoutputindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern29.md b/modules/brk-client/docs/type-aliases/MetricPattern29.md deleted file mode 100644 index 98b3faf53..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern29.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern29 - -# Type Alias: MetricPattern29\ - -> **MetricPattern29**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1425](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1425) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.weekindex - -> `readonly` **weekindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern3.md b/modules/brk-client/docs/type-aliases/MetricPattern3.md deleted file mode 100644 index aaf2b5b9c..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern3.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern3 - -# Type Alias: MetricPattern3\ - -> **MetricPattern3**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1347](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1347) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.dateindex - -> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.decadeindex - -> `readonly` **decadeindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.height - -> `readonly` **height**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.monthindex - -> `readonly` **monthindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.quarterindex - -> `readonly` **quarterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.semesterindex - -> `readonly` **semesterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.weekindex - -> `readonly` **weekindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.yearindex - -> `readonly` **yearindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern30.md b/modules/brk-client/docs/type-aliases/MetricPattern30.md deleted file mode 100644 index e3c763e4e..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern30.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern30 - -# Type Alias: MetricPattern30\ - -> **MetricPattern30**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1428](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1428) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.yearindex - -> `readonly` **yearindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern31.md b/modules/brk-client/docs/type-aliases/MetricPattern31.md deleted file mode 100644 index 018b5c54a..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern31.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern31 - -# Type Alias: MetricPattern31\ - -> **MetricPattern31**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1431](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1431) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.fundedaddressindex - -> `readonly` **fundedaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern32.md b/modules/brk-client/docs/type-aliases/MetricPattern32.md deleted file mode 100644 index dd1e24c01..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern32.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern32 - -# Type Alias: MetricPattern32\ - -> **MetricPattern32**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1434](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1434) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.emptyaddressindex - -> `readonly` **emptyaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern4.md b/modules/brk-client/docs/type-aliases/MetricPattern4.md deleted file mode 100644 index 1460f8e5d..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern4.md +++ /dev/null @@ -1,77 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern4 - -# Type Alias: MetricPattern4\ - -> **MetricPattern4**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1350](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1350) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.dateindex - -> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.decadeindex - -> `readonly` **decadeindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.monthindex - -> `readonly` **monthindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.quarterindex - -> `readonly` **quarterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.semesterindex - -> `readonly` **semesterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.weekindex - -> `readonly` **weekindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.yearindex - -> `readonly` **yearindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern5.md b/modules/brk-client/docs/type-aliases/MetricPattern5.md deleted file mode 100644 index 54f02ed79..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern5.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern5 - -# Type Alias: MetricPattern5\ - -> **MetricPattern5**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1353](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1353) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.dateindex - -> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -#### by.height - -> `readonly` **height**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern6.md b/modules/brk-client/docs/type-aliases/MetricPattern6.md deleted file mode 100644 index c5cd47346..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern6.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern6 - -# Type Alias: MetricPattern6\ - -> **MetricPattern6**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1356](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1356) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.dateindex - -> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern7.md b/modules/brk-client/docs/type-aliases/MetricPattern7.md deleted file mode 100644 index a3c68b26e..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern7.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern7 - -# Type Alias: MetricPattern7\ - -> **MetricPattern7**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1359](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1359) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.decadeindex - -> `readonly` **decadeindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern8.md b/modules/brk-client/docs/type-aliases/MetricPattern8.md deleted file mode 100644 index ed1133f55..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern8.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern8 - -# Type Alias: MetricPattern8\ - -> **MetricPattern8**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1362](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1362) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.difficultyepoch - -> `readonly` **difficultyepoch**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/MetricPattern9.md b/modules/brk-client/docs/type-aliases/MetricPattern9.md deleted file mode 100644 index edcbd8185..000000000 --- a/modules/brk-client/docs/type-aliases/MetricPattern9.md +++ /dev/null @@ -1,53 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricPattern9 - -# Type Alias: MetricPattern9\ - -> **MetricPattern9**\<`T`\> = `object` - -Defined in: [Developer/brk/modules/brk-client/index.js:1365](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1365) - -## Type Parameters - -### T - -`T` - -## Type Declaration - -### by - -> **by**: `object` - -#### by.emptyoutputindex - -> `readonly` **emptyoutputindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> - -### get() - -> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -#### Parameters - -##### index - -[`Index`](Index.md) - -#### Returns - -[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` - -### indexes() - -> **indexes**: () => readonly [`Index`](Index.md)[] - -#### Returns - -readonly [`Index`](Index.md)[] - -### name - -> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/Metrics.md b/modules/brk-client/docs/type-aliases/Metrics.md deleted file mode 100644 index e6a925939..000000000 --- a/modules/brk-client/docs/type-aliases/Metrics.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / Metrics - -# Type Alias: Metrics - -> **Metrics**\<\> = `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:479](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L479) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Minute10.md b/modules/brk-client/docs/type-aliases/Minute10.md new file mode 100644 index 000000000..a91838edb --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Minute10.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Minute10 + +# Type Alias: Minute10 + +> **Minute10** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:494](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L494) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Minute30.md b/modules/brk-client/docs/type-aliases/Minute30.md new file mode 100644 index 000000000..8b89e436d --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Minute30.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Minute30 + +# Type Alias: Minute30 + +> **Minute30** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:495](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L495) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Month1.md b/modules/brk-client/docs/type-aliases/Month1.md new file mode 100644 index 000000000..8b83df463 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Month1.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Month1 + +# Type Alias: Month1 + +> **Month1** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:496](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L496) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Month3.md b/modules/brk-client/docs/type-aliases/Month3.md new file mode 100644 index 000000000..e36b14d3c --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Month3.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Month3 + +# Type Alias: Month3 + +> **Month3** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:497](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L497) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Month6.md b/modules/brk-client/docs/type-aliases/Month6.md new file mode 100644 index 000000000..c281d77c6 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Month6.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Month6 + +# Type Alias: Month6 + +> **Month6** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:498](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L498) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/MonthIndex.md b/modules/brk-client/docs/type-aliases/MonthIndex.md deleted file mode 100644 index 89929312c..000000000 --- a/modules/brk-client/docs/type-aliases/MonthIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MonthIndex - -# Type Alias: MonthIndex - -> **MonthIndex**\<\> = `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:481](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L481) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/OpReturnIndex.md b/modules/brk-client/docs/type-aliases/OpReturnIndex.md index 141b39b89..d1b023213 100644 --- a/modules/brk-client/docs/type-aliases/OpReturnIndex.md +++ b/modules/brk-client/docs/type-aliases/OpReturnIndex.md @@ -6,8 +6,8 @@ # Type Alias: OpReturnIndex -> **OpReturnIndex**\<\> = [`TypeIndex`](TypeIndex.md) +> **OpReturnIndex** = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:509](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L509) +Defined in: [Developer/brk/modules/brk-client/index.js:526](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L526) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Open.md b/modules/brk-client/docs/type-aliases/Open.md index 06ed6b429..f4c5217aa 100644 --- a/modules/brk-client/docs/type-aliases/Open.md +++ b/modules/brk-client/docs/type-aliases/Open.md @@ -6,8 +6,8 @@ # Type Alias: Open -> **Open**\<\> = [`CentsUnsigned`](CentsUnsigned.md) +> **Open** = [`Dollars`](Dollars.md) -Defined in: [Developer/brk/modules/brk-client/index.js:513](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L513) +Defined in: [Developer/brk/modules/brk-client/index.js:530](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L530) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/OutPoint.md b/modules/brk-client/docs/type-aliases/OutPoint.md index a0be3aee6..ba259f268 100644 --- a/modules/brk-client/docs/type-aliases/OutPoint.md +++ b/modules/brk-client/docs/type-aliases/OutPoint.md @@ -6,8 +6,8 @@ # Type Alias: OutPoint -> **OutPoint**\<\> = `number` +> **OutPoint** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:515](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L515) +Defined in: [Developer/brk/modules/brk-client/index.js:532](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L532) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/OutputType.md b/modules/brk-client/docs/type-aliases/OutputType.md index 0e5701a25..730fd7981 100644 --- a/modules/brk-client/docs/type-aliases/OutputType.md +++ b/modules/brk-client/docs/type-aliases/OutputType.md @@ -6,8 +6,8 @@ # Type Alias: OutputType -> **OutputType**\<\> = `"p2pk65"` \| `"p2pk33"` \| `"p2pkh"` \| `"p2ms"` \| `"p2sh"` \| `"opreturn"` \| `"p2wpkh"` \| `"p2wsh"` \| `"p2tr"` \| `"p2a"` \| `"empty"` \| `"unknown"` +> **OutputType** = `"p2pk65"` \| `"p2pk33"` \| `"p2pkh"` \| `"p2ms"` \| `"p2sh"` \| `"opreturn"` \| `"p2wpkh"` \| `"p2wsh"` \| `"p2tr"` \| `"p2a"` \| `"empty"` \| `"unknown"` -Defined in: [Developer/brk/modules/brk-client/index.js:519](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L519) +Defined in: [Developer/brk/modules/brk-client/index.js:536](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L536) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2AAddrIndex.md b/modules/brk-client/docs/type-aliases/P2AAddrIndex.md new file mode 100644 index 000000000..4638c365f --- /dev/null +++ b/modules/brk-client/docs/type-aliases/P2AAddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / P2AAddrIndex + +# Type Alias: P2AAddrIndex + +> **P2AAddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:538](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L538) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2AAddressIndex.md b/modules/brk-client/docs/type-aliases/P2AAddressIndex.md deleted file mode 100644 index de0e7c51a..000000000 --- a/modules/brk-client/docs/type-aliases/P2AAddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / P2AAddressIndex - -# Type Alias: P2AAddressIndex - -> **P2AAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:521](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L521) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2ABytes.md b/modules/brk-client/docs/type-aliases/P2ABytes.md index 7a0309147..c183f9d0a 100644 --- a/modules/brk-client/docs/type-aliases/P2ABytes.md +++ b/modules/brk-client/docs/type-aliases/P2ABytes.md @@ -6,8 +6,8 @@ # Type Alias: P2ABytes -> **P2ABytes**\<\> = [`U8x2`](U8x2.md) +> **P2ABytes** = [`U8x2`](U8x2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:522](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L522) +Defined in: [Developer/brk/modules/brk-client/index.js:539](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L539) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2MSOutputIndex.md b/modules/brk-client/docs/type-aliases/P2MSOutputIndex.md index 9ca43957e..f27e5012a 100644 --- a/modules/brk-client/docs/type-aliases/P2MSOutputIndex.md +++ b/modules/brk-client/docs/type-aliases/P2MSOutputIndex.md @@ -6,8 +6,8 @@ # Type Alias: P2MSOutputIndex -> **P2MSOutputIndex**\<\> = [`TypeIndex`](TypeIndex.md) +> **P2MSOutputIndex** = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:523](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L523) +Defined in: [Developer/brk/modules/brk-client/index.js:540](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L540) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PK33AddrIndex.md b/modules/brk-client/docs/type-aliases/P2PK33AddrIndex.md new file mode 100644 index 000000000..ee3055037 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/P2PK33AddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / P2PK33AddrIndex + +# Type Alias: P2PK33AddrIndex + +> **P2PK33AddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:541](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L541) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PK33AddressIndex.md b/modules/brk-client/docs/type-aliases/P2PK33AddressIndex.md deleted file mode 100644 index 87f32eb2a..000000000 --- a/modules/brk-client/docs/type-aliases/P2PK33AddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / P2PK33AddressIndex - -# Type Alias: P2PK33AddressIndex - -> **P2PK33AddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:524](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L524) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PK33Bytes.md b/modules/brk-client/docs/type-aliases/P2PK33Bytes.md index d2ce6e205..43b67a13d 100644 --- a/modules/brk-client/docs/type-aliases/P2PK33Bytes.md +++ b/modules/brk-client/docs/type-aliases/P2PK33Bytes.md @@ -6,8 +6,8 @@ # Type Alias: P2PK33Bytes -> **P2PK33Bytes**\<\> = [`U8x33`](U8x33.md) +> **P2PK33Bytes** = [`U8x33`](U8x33.md) -Defined in: [Developer/brk/modules/brk-client/index.js:525](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L525) +Defined in: [Developer/brk/modules/brk-client/index.js:542](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L542) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PK65AddrIndex.md b/modules/brk-client/docs/type-aliases/P2PK65AddrIndex.md new file mode 100644 index 000000000..aaedcd9a5 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/P2PK65AddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / P2PK65AddrIndex + +# Type Alias: P2PK65AddrIndex + +> **P2PK65AddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:543](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L543) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PK65AddressIndex.md b/modules/brk-client/docs/type-aliases/P2PK65AddressIndex.md deleted file mode 100644 index 61d30b9d5..000000000 --- a/modules/brk-client/docs/type-aliases/P2PK65AddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / P2PK65AddressIndex - -# Type Alias: P2PK65AddressIndex - -> **P2PK65AddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:526](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L526) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PK65Bytes.md b/modules/brk-client/docs/type-aliases/P2PK65Bytes.md index c73a9aa3d..70fbe766e 100644 --- a/modules/brk-client/docs/type-aliases/P2PK65Bytes.md +++ b/modules/brk-client/docs/type-aliases/P2PK65Bytes.md @@ -6,8 +6,8 @@ # Type Alias: P2PK65Bytes -> **P2PK65Bytes**\<\> = [`U8x65`](U8x65.md) +> **P2PK65Bytes** = [`U8x65`](U8x65.md) -Defined in: [Developer/brk/modules/brk-client/index.js:527](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L527) +Defined in: [Developer/brk/modules/brk-client/index.js:544](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L544) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PKHAddrIndex.md b/modules/brk-client/docs/type-aliases/P2PKHAddrIndex.md new file mode 100644 index 000000000..ff7b7fbb4 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/P2PKHAddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / P2PKHAddrIndex + +# Type Alias: P2PKHAddrIndex + +> **P2PKHAddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:545](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L545) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PKHAddressIndex.md b/modules/brk-client/docs/type-aliases/P2PKHAddressIndex.md deleted file mode 100644 index 77bb9a3e3..000000000 --- a/modules/brk-client/docs/type-aliases/P2PKHAddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / P2PKHAddressIndex - -# Type Alias: P2PKHAddressIndex - -> **P2PKHAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:528](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L528) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PKHBytes.md b/modules/brk-client/docs/type-aliases/P2PKHBytes.md index f84b1420b..4a0adae05 100644 --- a/modules/brk-client/docs/type-aliases/P2PKHBytes.md +++ b/modules/brk-client/docs/type-aliases/P2PKHBytes.md @@ -6,8 +6,8 @@ # Type Alias: P2PKHBytes -> **P2PKHBytes**\<\> = [`U8x20`](U8x20.md) +> **P2PKHBytes** = [`U8x20`](U8x20.md) -Defined in: [Developer/brk/modules/brk-client/index.js:529](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L529) +Defined in: [Developer/brk/modules/brk-client/index.js:546](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L546) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2SHAddrIndex.md b/modules/brk-client/docs/type-aliases/P2SHAddrIndex.md new file mode 100644 index 000000000..ad6716e13 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/P2SHAddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / P2SHAddrIndex + +# Type Alias: P2SHAddrIndex + +> **P2SHAddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:547](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L547) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2SHAddressIndex.md b/modules/brk-client/docs/type-aliases/P2SHAddressIndex.md deleted file mode 100644 index 1af6224c3..000000000 --- a/modules/brk-client/docs/type-aliases/P2SHAddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / P2SHAddressIndex - -# Type Alias: P2SHAddressIndex - -> **P2SHAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:530](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L530) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2SHBytes.md b/modules/brk-client/docs/type-aliases/P2SHBytes.md index 376e41103..9667fe244 100644 --- a/modules/brk-client/docs/type-aliases/P2SHBytes.md +++ b/modules/brk-client/docs/type-aliases/P2SHBytes.md @@ -6,8 +6,8 @@ # Type Alias: P2SHBytes -> **P2SHBytes**\<\> = [`U8x20`](U8x20.md) +> **P2SHBytes** = [`U8x20`](U8x20.md) -Defined in: [Developer/brk/modules/brk-client/index.js:531](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L531) +Defined in: [Developer/brk/modules/brk-client/index.js:548](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L548) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2TRAddrIndex.md b/modules/brk-client/docs/type-aliases/P2TRAddrIndex.md new file mode 100644 index 000000000..e52a6760a --- /dev/null +++ b/modules/brk-client/docs/type-aliases/P2TRAddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / P2TRAddrIndex + +# Type Alias: P2TRAddrIndex + +> **P2TRAddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:549](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L549) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2TRAddressIndex.md b/modules/brk-client/docs/type-aliases/P2TRAddressIndex.md deleted file mode 100644 index b37d3379b..000000000 --- a/modules/brk-client/docs/type-aliases/P2TRAddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / P2TRAddressIndex - -# Type Alias: P2TRAddressIndex - -> **P2TRAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:532](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L532) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2TRBytes.md b/modules/brk-client/docs/type-aliases/P2TRBytes.md index 370b0e78a..cb19aae63 100644 --- a/modules/brk-client/docs/type-aliases/P2TRBytes.md +++ b/modules/brk-client/docs/type-aliases/P2TRBytes.md @@ -6,8 +6,8 @@ # Type Alias: P2TRBytes -> **P2TRBytes**\<\> = [`U8x32`](U8x32.md) +> **P2TRBytes** = [`U8x32`](U8x32.md) -Defined in: [Developer/brk/modules/brk-client/index.js:533](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L533) +Defined in: [Developer/brk/modules/brk-client/index.js:550](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L550) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2WPKHAddrIndex.md b/modules/brk-client/docs/type-aliases/P2WPKHAddrIndex.md new file mode 100644 index 000000000..ba6990b31 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/P2WPKHAddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / P2WPKHAddrIndex + +# Type Alias: P2WPKHAddrIndex + +> **P2WPKHAddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:551](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L551) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2WPKHAddressIndex.md b/modules/brk-client/docs/type-aliases/P2WPKHAddressIndex.md deleted file mode 100644 index 5e1bba58e..000000000 --- a/modules/brk-client/docs/type-aliases/P2WPKHAddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / P2WPKHAddressIndex - -# Type Alias: P2WPKHAddressIndex - -> **P2WPKHAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:534](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L534) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2WPKHBytes.md b/modules/brk-client/docs/type-aliases/P2WPKHBytes.md index e1b6c05ad..91a17c5a7 100644 --- a/modules/brk-client/docs/type-aliases/P2WPKHBytes.md +++ b/modules/brk-client/docs/type-aliases/P2WPKHBytes.md @@ -6,8 +6,8 @@ # Type Alias: P2WPKHBytes -> **P2WPKHBytes**\<\> = [`U8x20`](U8x20.md) +> **P2WPKHBytes** = [`U8x20`](U8x20.md) -Defined in: [Developer/brk/modules/brk-client/index.js:535](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L535) +Defined in: [Developer/brk/modules/brk-client/index.js:552](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L552) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2WSHAddrIndex.md b/modules/brk-client/docs/type-aliases/P2WSHAddrIndex.md new file mode 100644 index 000000000..781069ceb --- /dev/null +++ b/modules/brk-client/docs/type-aliases/P2WSHAddrIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / P2WSHAddrIndex + +# Type Alias: P2WSHAddrIndex + +> **P2WSHAddrIndex** = [`TypeIndex`](TypeIndex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:553](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L553) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2WSHAddressIndex.md b/modules/brk-client/docs/type-aliases/P2WSHAddressIndex.md deleted file mode 100644 index 1bd9dba2e..000000000 --- a/modules/brk-client/docs/type-aliases/P2WSHAddressIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / P2WSHAddressIndex - -# Type Alias: P2WSHAddressIndex - -> **P2WSHAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:536](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L536) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2WSHBytes.md b/modules/brk-client/docs/type-aliases/P2WSHBytes.md index c6734a99f..59f23f77c 100644 --- a/modules/brk-client/docs/type-aliases/P2WSHBytes.md +++ b/modules/brk-client/docs/type-aliases/P2WSHBytes.md @@ -6,8 +6,8 @@ # Type Alias: P2WSHBytes -> **P2WSHBytes**\<\> = [`U8x32`](U8x32.md) +> **P2WSHBytes** = [`U8x32`](U8x32.md) -Defined in: [Developer/brk/modules/brk-client/index.js:537](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L537) +Defined in: [Developer/brk/modules/brk-client/index.js:554](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L554) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/PoolSlug.md b/modules/brk-client/docs/type-aliases/PoolSlug.md index 764c4b954..847d69c07 100644 --- a/modules/brk-client/docs/type-aliases/PoolSlug.md +++ b/modules/brk-client/docs/type-aliases/PoolSlug.md @@ -6,8 +6,8 @@ # Type Alias: PoolSlug -> **PoolSlug**\<\> = `"unknown"` \| `"blockfills"` \| `"ultimuspool"` \| `"terrapool"` \| `"luxor"` \| `"onethash"` \| `"btccom"` \| `"bitfarms"` \| `"huobipool"` \| `"wayicn"` \| `"canoepool"` \| `"btctop"` \| `"bitcoincom"` \| `"pool175btc"` \| `"gbminers"` \| `"axbt"` \| `"asicminer"` \| `"bitminter"` \| `"bitcoinrussia"` \| `"btcserv"` \| `"simplecoinus"` \| `"btcguild"` \| `"eligius"` \| `"ozcoin"` \| `"eclipsemc"` \| `"maxbtc"` \| `"triplemining"` \| `"coinlab"` \| `"pool50btc"` \| `"ghashio"` \| `"stminingcorp"` \| `"bitparking"` \| `"mmpool"` \| `"polmine"` \| `"kncminer"` \| `"bitalo"` \| `"f2pool"` \| `"hhtt"` \| `"megabigpower"` \| `"mtred"` \| `"nmcbit"` \| `"yourbtcnet"` \| `"givemecoins"` \| `"braiinspool"` \| `"antpool"` \| `"multicoinco"` \| `"bcpoolio"` \| `"cointerra"` \| `"kanopool"` \| `"solock"` \| `"ckpool"` \| `"nicehash"` \| `"bitclub"` \| `"bitcoinaffiliatenetwork"` \| `"btcc"` \| `"bwpool"` \| `"exxbw"` \| `"bitsolo"` \| `"bitfury"` \| `"twentyoneinc"` \| `"digitalbtc"` \| `"eightbaochi"` \| `"mybtccoinpool"` \| `"tbdice"` \| `"hashpool"` \| `"nexious"` \| `"bravomining"` \| `"hotpool"` \| `"okexpool"` \| `"bcmonster"` \| `"onehash"` \| `"bixin"` \| `"tatmaspool"` \| `"viabtc"` \| `"connectbtc"` \| `"batpool"` \| `"waterhole"` \| `"dcexploration"` \| `"dcex"` \| `"btpool"` \| `"fiftyeightcoin"` \| `"bitcoinindia"` \| `"shawnp0wers"` \| `"phashio"` \| `"rigpool"` \| `"haozhuzhu"` \| `"sevenpool"` \| `"miningkings"` \| `"hashbx"` \| `"dpool"` \| `"rawpool"` \| `"haominer"` \| `"helix"` \| `"bitcoinukraine"` \| `"poolin"` \| `"secretsuperstar"` \| `"tigerpoolnet"` \| `"sigmapoolcom"` \| `"okpooltop"` \| `"hummerpool"` \| `"tangpool"` \| `"bytepool"` \| `"spiderpool"` \| `"novablock"` \| `"miningcity"` \| `"binancepool"` \| `"minerium"` \| `"lubiancom"` \| `"okkong"` \| `"aaopool"` \| `"emcdpool"` \| `"foundryusa"` \| `"sbicrypto"` \| `"arkpool"` \| `"purebtccom"` \| `"marapool"` \| `"kucoinpool"` \| `"entrustcharitypool"` \| `"okminer"` \| `"titan"` \| `"pegapool"` \| `"btcnuggets"` \| `"cloudhashing"` \| `"digitalxmintsy"` \| `"telco214"` \| `"btcpoolparty"` \| `"multipool"` \| `"transactioncoinmining"` \| `"btcdig"` \| `"trickysbtcpool"` \| `"btcmp"` \| `"eobot"` \| `"unomp"` \| `"patels"` \| `"gogreenlight"` \| `"ekanembtc"` \| `"canoe"` \| `"tiger"` \| `"onem1x"` \| `"zulupool"` \| `"secpool"` \| `"ocean"` \| `"whitepool"` \| `"wk057"` \| `"futurebitapollosolo"` \| `"carbonnegative"` \| `"portlandhodl"` \| `"phoenix"` \| `"neopool"` \| `"maxipool"` \| `"bitfufupool"` \| `"luckypool"` \| `"miningdutch"` \| `"publicpool"` \| `"miningsquared"` \| `"innopolistech"` \| `"btclab"` \| `"parasite"` +> **PoolSlug** = `"unknown"` \| `"blockfills"` \| `"ultimuspool"` \| `"terrapool"` \| `"luxor"` \| `"onethash"` \| `"btccom"` \| `"bitfarms"` \| `"huobipool"` \| `"wayicn"` \| `"canoepool"` \| `"btctop"` \| `"bitcoincom"` \| `"pool175btc"` \| `"gbminers"` \| `"axbt"` \| `"asicminer"` \| `"bitminter"` \| `"bitcoinrussia"` \| `"btcserv"` \| `"simplecoinus"` \| `"btcguild"` \| `"eligius"` \| `"ozcoin"` \| `"eclipsemc"` \| `"maxbtc"` \| `"triplemining"` \| `"coinlab"` \| `"pool50btc"` \| `"ghashio"` \| `"stminingcorp"` \| `"bitparking"` \| `"mmpool"` \| `"polmine"` \| `"kncminer"` \| `"bitalo"` \| `"f2pool"` \| `"hhtt"` \| `"megabigpower"` \| `"mtred"` \| `"nmcbit"` \| `"yourbtcnet"` \| `"givemecoins"` \| `"braiinspool"` \| `"antpool"` \| `"multicoinco"` \| `"bcpoolio"` \| `"cointerra"` \| `"kanopool"` \| `"solock"` \| `"ckpool"` \| `"nicehash"` \| `"bitclub"` \| `"bitcoinaffiliatenetwork"` \| `"btcc"` \| `"bwpool"` \| `"exxbw"` \| `"bitsolo"` \| `"bitfury"` \| `"twentyoneinc"` \| `"digitalbtc"` \| `"eightbaochi"` \| `"mybtccoinpool"` \| `"tbdice"` \| `"hashpool"` \| `"nexious"` \| `"bravomining"` \| `"hotpool"` \| `"okexpool"` \| `"bcmonster"` \| `"onehash"` \| `"bixin"` \| `"tatmaspool"` \| `"viabtc"` \| `"connectbtc"` \| `"batpool"` \| `"waterhole"` \| `"dcexploration"` \| `"dcex"` \| `"btpool"` \| `"fiftyeightcoin"` \| `"bitcoinindia"` \| `"shawnp0wers"` \| `"phashio"` \| `"rigpool"` \| `"haozhuzhu"` \| `"sevenpool"` \| `"miningkings"` \| `"hashbx"` \| `"dpool"` \| `"rawpool"` \| `"haominer"` \| `"helix"` \| `"bitcoinukraine"` \| `"poolin"` \| `"secretsuperstar"` \| `"tigerpoolnet"` \| `"sigmapoolcom"` \| `"okpooltop"` \| `"hummerpool"` \| `"tangpool"` \| `"bytepool"` \| `"spiderpool"` \| `"novablock"` \| `"miningcity"` \| `"binancepool"` \| `"minerium"` \| `"lubiancom"` \| `"okkong"` \| `"aaopool"` \| `"emcdpool"` \| `"foundryusa"` \| `"sbicrypto"` \| `"arkpool"` \| `"purebtccom"` \| `"marapool"` \| `"kucoinpool"` \| `"entrustcharitypool"` \| `"okminer"` \| `"titan"` \| `"pegapool"` \| `"btcnuggets"` \| `"cloudhashing"` \| `"digitalxmintsy"` \| `"telco214"` \| `"btcpoolparty"` \| `"multipool"` \| `"transactioncoinmining"` \| `"btcdig"` \| `"trickysbtcpool"` \| `"btcmp"` \| `"eobot"` \| `"unomp"` \| `"patels"` \| `"gogreenlight"` \| `"bitcoinindiapool"` \| `"ekanembtc"` \| `"canoe"` \| `"tiger"` \| `"onem1x"` \| `"zulupool"` \| `"secpool"` \| `"ocean"` \| `"whitepool"` \| `"wiz"` \| `"wk057"` \| `"futurebitapollosolo"` \| `"carbonnegative"` \| `"portlandhodl"` \| `"phoenix"` \| `"neopool"` \| `"maxipool"` \| `"bitfufupool"` \| `"gdpool"` \| `"miningdutch"` \| `"publicpool"` \| `"miningsquared"` \| `"innopolistech"` \| `"btclab"` \| `"parasite"` \| `"redrockpool"` \| `"est3lar"` -Defined in: [Developer/brk/modules/brk-client/index.js:597](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L597) +Defined in: [Developer/brk/modules/brk-client/index.js:618](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L618) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/QuarterIndex.md b/modules/brk-client/docs/type-aliases/QuarterIndex.md deleted file mode 100644 index 48e770a35..000000000 --- a/modules/brk-client/docs/type-aliases/QuarterIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / QuarterIndex - -# Type Alias: QuarterIndex - -> **QuarterIndex**\<\> = `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:623](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L623) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/RangeIndex.md b/modules/brk-client/docs/type-aliases/RangeIndex.md new file mode 100644 index 000000000..c8c545821 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/RangeIndex.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / RangeIndex + +# Type Alias: RangeIndex + +> **RangeIndex** = `number` \| [`Date`](Date.md) \| [`Timestamp`](Timestamp.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:647](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L647) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/RawLockTime.md b/modules/brk-client/docs/type-aliases/RawLockTime.md index 1992c1149..6fab31409 100644 --- a/modules/brk-client/docs/type-aliases/RawLockTime.md +++ b/modules/brk-client/docs/type-aliases/RawLockTime.md @@ -6,8 +6,8 @@ # Type Alias: RawLockTime -> **RawLockTime**\<\> = `number` +> **RawLockTime** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:627](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L627) +Defined in: [Developer/brk/modules/brk-client/index.js:652](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L652) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Sats.md b/modules/brk-client/docs/type-aliases/Sats.md index df518852d..16c7c4096 100644 --- a/modules/brk-client/docs/type-aliases/Sats.md +++ b/modules/brk-client/docs/type-aliases/Sats.md @@ -6,8 +6,8 @@ # Type Alias: Sats -> **Sats**\<\> = `number` +> **Sats** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:652](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L652) +Defined in: [Developer/brk/modules/brk-client/index.js:677](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L677) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/SatsFract.md b/modules/brk-client/docs/type-aliases/SatsFract.md index af098a9a4..1efd54e21 100644 --- a/modules/brk-client/docs/type-aliases/SatsFract.md +++ b/modules/brk-client/docs/type-aliases/SatsFract.md @@ -6,8 +6,8 @@ # Type Alias: SatsFract -> **SatsFract**\<\> = `number` +> **SatsFract** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:664](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L664) +Defined in: [Developer/brk/modules/brk-client/index.js:689](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L689) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/SatsSigned.md b/modules/brk-client/docs/type-aliases/SatsSigned.md index e99256b2a..8010c1da3 100644 --- a/modules/brk-client/docs/type-aliases/SatsSigned.md +++ b/modules/brk-client/docs/type-aliases/SatsSigned.md @@ -6,8 +6,8 @@ # Type Alias: SatsSigned -> **SatsSigned**\<\> = `number` +> **SatsSigned** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:670](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L670) +Defined in: [Developer/brk/modules/brk-client/index.js:695](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L695) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/SemesterIndex.md b/modules/brk-client/docs/type-aliases/SemesterIndex.md deleted file mode 100644 index 536c8147a..000000000 --- a/modules/brk-client/docs/type-aliases/SemesterIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / SemesterIndex - -# Type Alias: SemesterIndex - -> **SemesterIndex**\<\> = `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:672](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L672) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/SeriesData.md b/modules/brk-client/docs/type-aliases/SeriesData.md new file mode 100644 index 000000000..db045e316 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesData.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesData + +# Type Alias: SeriesData\ + +> **SeriesData**\<`T`\> = [`SeriesDataBase`](../interfaces/SeriesDataBase.md)\<`T`\> & `Iterable`\<\[`number`, `T`\]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1159](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1159) + +## Type Parameters + +### T + +`T` diff --git a/modules/brk-client/docs/type-aliases/SeriesList.md b/modules/brk-client/docs/type-aliases/SeriesList.md new file mode 100644 index 000000000..8800a7429 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesList.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesList + +# Type Alias: SeriesList + +> **SeriesList** = `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:730](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L730) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/SeriesName.md b/modules/brk-client/docs/type-aliases/SeriesName.md new file mode 100644 index 000000000..edfb2486b --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesName.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesName + +# Type Alias: SeriesName + +> **SeriesName** = `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:735](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L735) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern1.md b/modules/brk-client/docs/type-aliases/SeriesPattern1.md new file mode 100644 index 000000000..c3fc890a7 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern1.md @@ -0,0 +1,113 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern1 + +# Type Alias: SeriesPattern1\ + +> **SeriesPattern1**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1523](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1523) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.day1 + +> `readonly` **day1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.day3 + +> `readonly` **day3**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.epoch + +> `readonly` **epoch**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +#### by.halving + +> `readonly` **halving**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +#### by.height + +> `readonly` **height**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +#### by.hour1 + +> `readonly` **hour1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.hour12 + +> `readonly` **hour12**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.hour4 + +> `readonly` **hour4**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.minute10 + +> `readonly` **minute10**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.minute30 + +> `readonly` **minute30**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.month1 + +> `readonly` **month1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.month3 + +> `readonly` **month3**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.month6 + +> `readonly` **month6**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.week1 + +> `readonly` **week1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.year1 + +> `readonly` **year1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.year10 + +> `readonly` **year10**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern10.md b/modules/brk-client/docs/type-aliases/SeriesPattern10.md new file mode 100644 index 000000000..2123a8f32 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern10.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern10 + +# Type Alias: SeriesPattern10\ + +> **SeriesPattern10**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1550](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1550) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.week1 + +> `readonly` **week1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern11.md b/modules/brk-client/docs/type-aliases/SeriesPattern11.md new file mode 100644 index 000000000..81e18b2c8 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern11.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern11 + +# Type Alias: SeriesPattern11\ + +> **SeriesPattern11**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1553](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1553) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.month1 + +> `readonly` **month1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern12.md b/modules/brk-client/docs/type-aliases/SeriesPattern12.md new file mode 100644 index 000000000..efa1fd0a5 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern12.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern12 + +# Type Alias: SeriesPattern12\ + +> **SeriesPattern12**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1556](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1556) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.month3 + +> `readonly` **month3**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern13.md b/modules/brk-client/docs/type-aliases/SeriesPattern13.md new file mode 100644 index 000000000..ab103caf7 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern13.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern13 + +# Type Alias: SeriesPattern13\ + +> **SeriesPattern13**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1559](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1559) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.month6 + +> `readonly` **month6**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern14.md b/modules/brk-client/docs/type-aliases/SeriesPattern14.md new file mode 100644 index 000000000..a384d2176 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern14.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern14 + +# Type Alias: SeriesPattern14\ + +> **SeriesPattern14**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1562](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1562) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.year1 + +> `readonly` **year1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern15.md b/modules/brk-client/docs/type-aliases/SeriesPattern15.md new file mode 100644 index 000000000..ef63c24c0 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern15.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern15 + +# Type Alias: SeriesPattern15\ + +> **SeriesPattern15**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1565](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1565) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.year10 + +> `readonly` **year10**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern16.md b/modules/brk-client/docs/type-aliases/SeriesPattern16.md new file mode 100644 index 000000000..e9d3ad4dd --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern16.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern16 + +# Type Alias: SeriesPattern16\ + +> **SeriesPattern16**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1568](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1568) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.halving + +> `readonly` **halving**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern17.md b/modules/brk-client/docs/type-aliases/SeriesPattern17.md new file mode 100644 index 000000000..cf6067b68 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern17.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern17 + +# Type Alias: SeriesPattern17\ + +> **SeriesPattern17**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1571](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1571) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.epoch + +> `readonly` **epoch**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern18.md b/modules/brk-client/docs/type-aliases/SeriesPattern18.md new file mode 100644 index 000000000..2c3c25d3a --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern18.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern18 + +# Type Alias: SeriesPattern18\ + +> **SeriesPattern18**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1574](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1574) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.height + +> `readonly` **height**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern19.md b/modules/brk-client/docs/type-aliases/SeriesPattern19.md new file mode 100644 index 000000000..2a6a9bac4 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern19.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern19 + +# Type Alias: SeriesPattern19\ + +> **SeriesPattern19**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1577](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1577) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.tx\_index + +> `readonly` **tx\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern2.md b/modules/brk-client/docs/type-aliases/SeriesPattern2.md new file mode 100644 index 000000000..99044ccf4 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern2.md @@ -0,0 +1,109 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern2 + +# Type Alias: SeriesPattern2\ + +> **SeriesPattern2**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1526](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1526) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.day1 + +> `readonly` **day1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.day3 + +> `readonly` **day3**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.epoch + +> `readonly` **epoch**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +#### by.halving + +> `readonly` **halving**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +#### by.hour1 + +> `readonly` **hour1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.hour12 + +> `readonly` **hour12**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.hour4 + +> `readonly` **hour4**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.minute10 + +> `readonly` **minute10**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.minute30 + +> `readonly` **minute30**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.month1 + +> `readonly` **month1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.month3 + +> `readonly` **month3**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.month6 + +> `readonly` **month6**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.week1 + +> `readonly` **week1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.year1 + +> `readonly` **year1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +#### by.year10 + +> `readonly` **year10**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern20.md b/modules/brk-client/docs/type-aliases/SeriesPattern20.md new file mode 100644 index 000000000..9d01bce3a --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern20.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern20 + +# Type Alias: SeriesPattern20\ + +> **SeriesPattern20**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1580](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1580) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.txin\_index + +> `readonly` **txin\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern21.md b/modules/brk-client/docs/type-aliases/SeriesPattern21.md new file mode 100644 index 000000000..a75b05605 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern21.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern21 + +# Type Alias: SeriesPattern21\ + +> **SeriesPattern21**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1583](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1583) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.txout\_index + +> `readonly` **txout\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern22.md b/modules/brk-client/docs/type-aliases/SeriesPattern22.md new file mode 100644 index 000000000..a39257520 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern22.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern22 + +# Type Alias: SeriesPattern22\ + +> **SeriesPattern22**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1586](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1586) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.empty\_output\_index + +> `readonly` **empty\_output\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern23.md b/modules/brk-client/docs/type-aliases/SeriesPattern23.md new file mode 100644 index 000000000..045c58a8c --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern23.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern23 + +# Type Alias: SeriesPattern23\ + +> **SeriesPattern23**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1589](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1589) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.op\_return\_index + +> `readonly` **op\_return\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern24.md b/modules/brk-client/docs/type-aliases/SeriesPattern24.md new file mode 100644 index 000000000..beddea23a --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern24.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern24 + +# Type Alias: SeriesPattern24\ + +> **SeriesPattern24**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1592](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1592) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.p2a\_addr\_index + +> `readonly` **p2a\_addr\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern25.md b/modules/brk-client/docs/type-aliases/SeriesPattern25.md new file mode 100644 index 000000000..79adc9ed9 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern25.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern25 + +# Type Alias: SeriesPattern25\ + +> **SeriesPattern25**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1595](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1595) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.p2ms\_output\_index + +> `readonly` **p2ms\_output\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern26.md b/modules/brk-client/docs/type-aliases/SeriesPattern26.md new file mode 100644 index 000000000..479d9e48e --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern26.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern26 + +# Type Alias: SeriesPattern26\ + +> **SeriesPattern26**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1598](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1598) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.p2pk33\_addr\_index + +> `readonly` **p2pk33\_addr\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern27.md b/modules/brk-client/docs/type-aliases/SeriesPattern27.md new file mode 100644 index 000000000..7be26f03c --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern27.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern27 + +# Type Alias: SeriesPattern27\ + +> **SeriesPattern27**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1601](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1601) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.p2pk65\_addr\_index + +> `readonly` **p2pk65\_addr\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern28.md b/modules/brk-client/docs/type-aliases/SeriesPattern28.md new file mode 100644 index 000000000..759b9ab2e --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern28.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern28 + +# Type Alias: SeriesPattern28\ + +> **SeriesPattern28**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1604](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1604) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.p2pkh\_addr\_index + +> `readonly` **p2pkh\_addr\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern29.md b/modules/brk-client/docs/type-aliases/SeriesPattern29.md new file mode 100644 index 000000000..343ccc67d --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern29.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern29 + +# Type Alias: SeriesPattern29\ + +> **SeriesPattern29**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1607](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1607) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.p2sh\_addr\_index + +> `readonly` **p2sh\_addr\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern3.md b/modules/brk-client/docs/type-aliases/SeriesPattern3.md new file mode 100644 index 000000000..001c6b734 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern3.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern3 + +# Type Alias: SeriesPattern3\ + +> **SeriesPattern3**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1529](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1529) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.minute10 + +> `readonly` **minute10**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern30.md b/modules/brk-client/docs/type-aliases/SeriesPattern30.md new file mode 100644 index 000000000..a998d7d2e --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern30.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern30 + +# Type Alias: SeriesPattern30\ + +> **SeriesPattern30**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1610](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1610) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.p2tr\_addr\_index + +> `readonly` **p2tr\_addr\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern31.md b/modules/brk-client/docs/type-aliases/SeriesPattern31.md new file mode 100644 index 000000000..4f0762bea --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern31.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern31 + +# Type Alias: SeriesPattern31\ + +> **SeriesPattern31**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1613](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1613) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.p2wpkh\_addr\_index + +> `readonly` **p2wpkh\_addr\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern32.md b/modules/brk-client/docs/type-aliases/SeriesPattern32.md new file mode 100644 index 000000000..2a69fc66d --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern32.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern32 + +# Type Alias: SeriesPattern32\ + +> **SeriesPattern32**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1616](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1616) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.p2wsh\_addr\_index + +> `readonly` **p2wsh\_addr\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern33.md b/modules/brk-client/docs/type-aliases/SeriesPattern33.md new file mode 100644 index 000000000..3db80a19d --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern33.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern33 + +# Type Alias: SeriesPattern33\ + +> **SeriesPattern33**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1619](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1619) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.unknown\_output\_index + +> `readonly` **unknown\_output\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern34.md b/modules/brk-client/docs/type-aliases/SeriesPattern34.md new file mode 100644 index 000000000..13dc4969c --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern34.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern34 + +# Type Alias: SeriesPattern34\ + +> **SeriesPattern34**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1622](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1622) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.funded\_addr\_index + +> `readonly` **funded\_addr\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern35.md b/modules/brk-client/docs/type-aliases/SeriesPattern35.md new file mode 100644 index 000000000..8500c1d4c --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern35.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern35 + +# Type Alias: SeriesPattern35\ + +> **SeriesPattern35**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1625](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1625) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.empty\_addr\_index + +> `readonly` **empty\_addr\_index**: [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern4.md b/modules/brk-client/docs/type-aliases/SeriesPattern4.md new file mode 100644 index 000000000..73e3efb85 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern4.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern4 + +# Type Alias: SeriesPattern4\ + +> **SeriesPattern4**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1532](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1532) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.minute30 + +> `readonly` **minute30**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern5.md b/modules/brk-client/docs/type-aliases/SeriesPattern5.md new file mode 100644 index 000000000..9b58b6efb --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern5.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern5 + +# Type Alias: SeriesPattern5\ + +> **SeriesPattern5**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1535](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1535) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.hour1 + +> `readonly` **hour1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern6.md b/modules/brk-client/docs/type-aliases/SeriesPattern6.md new file mode 100644 index 000000000..dadf321fa --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern6.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern6 + +# Type Alias: SeriesPattern6\ + +> **SeriesPattern6**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1538](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1538) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.hour4 + +> `readonly` **hour4**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern7.md b/modules/brk-client/docs/type-aliases/SeriesPattern7.md new file mode 100644 index 000000000..a3b3bf25b --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern7.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern7 + +# Type Alias: SeriesPattern7\ + +> **SeriesPattern7**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1541](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1541) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.hour12 + +> `readonly` **hour12**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern8.md b/modules/brk-client/docs/type-aliases/SeriesPattern8.md new file mode 100644 index 000000000..87273ee8b --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern8.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern8 + +# Type Alias: SeriesPattern8\ + +> **SeriesPattern8**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1544](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1544) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.day1 + +> `readonly` **day1**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesPattern9.md b/modules/brk-client/docs/type-aliases/SeriesPattern9.md new file mode 100644 index 000000000..6b9c9f77d --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesPattern9.md @@ -0,0 +1,53 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesPattern9 + +# Type Alias: SeriesPattern9\ + +> **SeriesPattern9**\<`T`\> = `object` + +Defined in: [Developer/brk/modules/brk-client/index.js:1547](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1547) + +## Type Parameters + +### T + +`T` + +## Type Declaration + +### by + +> **by**: `object` + +#### by.day3 + +> `readonly` **day3**: [`DateSeriesEndpoint`](../interfaces/DateSeriesEndpoint.md)\<`T`\> + +### get + +> **get**: (`index`) => [`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +#### Parameters + +##### index + +[`Index`](Index.md) + +#### Returns + +[`SeriesEndpoint`](../interfaces/SeriesEndpoint.md)\<`T`\> \| `undefined` + +### indexes + +> **indexes**: () => readonly [`Index`](Index.md)[] + +#### Returns + +readonly [`Index`](Index.md)[] + +### name + +> **name**: `string` diff --git a/modules/brk-client/docs/type-aliases/SeriesTree_Positions.md b/modules/brk-client/docs/type-aliases/SeriesTree_Positions.md new file mode 100644 index 000000000..0040316a1 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/SeriesTree_Positions.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SeriesTree\_Positions + +# Type Alias: SeriesTree\_Positions + +> **SeriesTree\_Positions** = `Object` + +Defined in: [Developer/brk/modules/brk-client/index.js:4658](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L4658) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredBool.md b/modules/brk-client/docs/type-aliases/StoredBool.md index cb7759205..aed1d43cb 100644 --- a/modules/brk-client/docs/type-aliases/StoredBool.md +++ b/modules/brk-client/docs/type-aliases/StoredBool.md @@ -6,8 +6,8 @@ # Type Alias: StoredBool -> **StoredBool**\<\> = `number` +> **StoredBool** = `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:676](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L676) +Defined in: [Developer/brk/modules/brk-client/index.js:768](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L768) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredF32.md b/modules/brk-client/docs/type-aliases/StoredF32.md index a46000dc1..413c4fd50 100644 --- a/modules/brk-client/docs/type-aliases/StoredF32.md +++ b/modules/brk-client/docs/type-aliases/StoredF32.md @@ -6,8 +6,8 @@ # Type Alias: StoredF32 -> **StoredF32**\<\> = `number` +> **StoredF32** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:681](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L681) +Defined in: [Developer/brk/modules/brk-client/index.js:772](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L772) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredF64.md b/modules/brk-client/docs/type-aliases/StoredF64.md index 533d39a90..11c6818ea 100644 --- a/modules/brk-client/docs/type-aliases/StoredF64.md +++ b/modules/brk-client/docs/type-aliases/StoredF64.md @@ -6,8 +6,8 @@ # Type Alias: StoredF64 -> **StoredF64**\<\> = `number` +> **StoredF64** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:686](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L686) +Defined in: [Developer/brk/modules/brk-client/index.js:777](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L777) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredI64.md b/modules/brk-client/docs/type-aliases/StoredI64.md new file mode 100644 index 000000000..28889c8d0 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/StoredI64.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / StoredI64 + +# Type Alias: StoredI64 + +> **StoredI64** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:782](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L782) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredI8.md b/modules/brk-client/docs/type-aliases/StoredI8.md index af43bd2db..2ce5e4652 100644 --- a/modules/brk-client/docs/type-aliases/StoredI8.md +++ b/modules/brk-client/docs/type-aliases/StoredI8.md @@ -6,8 +6,8 @@ # Type Alias: StoredI8 -> **StoredI8**\<\> = `number` +> **StoredI8** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:688](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L688) +Defined in: [Developer/brk/modules/brk-client/index.js:784](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L784) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredU16.md b/modules/brk-client/docs/type-aliases/StoredU16.md index 9cc88704c..bcbabd71c 100644 --- a/modules/brk-client/docs/type-aliases/StoredU16.md +++ b/modules/brk-client/docs/type-aliases/StoredU16.md @@ -6,8 +6,8 @@ # Type Alias: StoredU16 -> **StoredU16**\<\> = `number` +> **StoredU16** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:689](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L689) +Defined in: [Developer/brk/modules/brk-client/index.js:785](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L785) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredU32.md b/modules/brk-client/docs/type-aliases/StoredU32.md index 80e1cb001..7bcbbc186 100644 --- a/modules/brk-client/docs/type-aliases/StoredU32.md +++ b/modules/brk-client/docs/type-aliases/StoredU32.md @@ -6,8 +6,8 @@ # Type Alias: StoredU32 -> **StoredU32**\<\> = `number` +> **StoredU32** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:693](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L693) +Defined in: [Developer/brk/modules/brk-client/index.js:789](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L789) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredU64.md b/modules/brk-client/docs/type-aliases/StoredU64.md index c31bb14ae..f1fda3214 100644 --- a/modules/brk-client/docs/type-aliases/StoredU64.md +++ b/modules/brk-client/docs/type-aliases/StoredU64.md @@ -6,8 +6,8 @@ # Type Alias: StoredU64 -> **StoredU64**\<\> = `number` +> **StoredU64** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:698](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L698) +Defined in: [Developer/brk/modules/brk-client/index.js:794](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L794) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Thenable.md b/modules/brk-client/docs/type-aliases/Thenable.md index 41b73d7b4..6342a8c25 100644 --- a/modules/brk-client/docs/type-aliases/Thenable.md +++ b/modules/brk-client/docs/type-aliases/Thenable.md @@ -4,11 +4,11 @@ [brk-client](../globals.md) / Thenable -# Type Alias: Thenable()\ +# Type Alias: Thenable\ -> **Thenable**\<`T`\> = (`onfulfilled?`, `onrejected?`) => `Promise`\<[`MetricData`](../interfaces/MetricData.md)\<`T`\>\> +> **Thenable**\<`T`\> = (`onfulfilled?`, `onrejected?`) => `Promise`\<[`SeriesData`](SeriesData.md)\<`T`\>\> -Defined in: [Developer/brk/modules/brk-client/index.js:1024](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1024) +Defined in: [Developer/brk/modules/brk-client/index.js:1172](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1172) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1024](https://github.com/ ### onfulfilled? -(`value`) => [`MetricData`](../interfaces/MetricData.md)\<`T`\> +(`value`) => `any` ### onrejected? @@ -28,4 +28,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1024](https://github.com/ ## Returns -`Promise`\<[`MetricData`](../interfaces/MetricData.md)\<`T`\>\> +`Promise`\<[`SeriesData`](SeriesData.md)\<`T`\>\> diff --git a/modules/brk-client/docs/type-aliases/TimePeriod.md b/modules/brk-client/docs/type-aliases/TimePeriod.md index 51ff983b1..5c998779f 100644 --- a/modules/brk-client/docs/type-aliases/TimePeriod.md +++ b/modules/brk-client/docs/type-aliases/TimePeriod.md @@ -6,8 +6,8 @@ # Type Alias: TimePeriod -> **TimePeriod**\<\> = `"24h"` \| `"3d"` \| `"1w"` \| `"1m"` \| `"3m"` \| `"6m"` \| `"1y"` \| `"2y"` \| `"3y"` +> **TimePeriod** = `"24h"` \| `"3d"` \| `"1w"` \| `"1m"` \| `"3m"` \| `"6m"` \| `"1y"` \| `"2y"` \| `"3y"` -Defined in: [Developer/brk/modules/brk-client/index.js:723](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L723) +Defined in: [Developer/brk/modules/brk-client/index.js:820](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L820) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Timestamp.md b/modules/brk-client/docs/type-aliases/Timestamp.md index e0da8289a..10da9f287 100644 --- a/modules/brk-client/docs/type-aliases/Timestamp.md +++ b/modules/brk-client/docs/type-aliases/Timestamp.md @@ -6,8 +6,8 @@ # Type Alias: Timestamp -> **Timestamp**\<\> = `number` +> **Timestamp** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:732](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L732) +Defined in: [Developer/brk/modules/brk-client/index.js:829](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L829) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TreeNode.md b/modules/brk-client/docs/type-aliases/TreeNode.md index d4c465511..ed3da9b3c 100644 --- a/modules/brk-client/docs/type-aliases/TreeNode.md +++ b/modules/brk-client/docs/type-aliases/TreeNode.md @@ -6,8 +6,8 @@ # Type Alias: TreeNode -> **TreeNode**\<\> = \{\[`key`: `string`\]: `TreeNode`; \} \| [`MetricLeafWithSchema`](../interfaces/MetricLeafWithSchema.md) +> **TreeNode** = \{\[`key`: `string`\]: `TreeNode`; \} \| [`SeriesLeafWithSchema`](../interfaces/SeriesLeafWithSchema.md) -Defined in: [Developer/brk/modules/brk-client/index.js:757](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L757) +Defined in: [Developer/brk/modules/brk-client/index.js:854](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L854) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TxInIndex.md b/modules/brk-client/docs/type-aliases/TxInIndex.md index 64fc8df9f..11c850c71 100644 --- a/modules/brk-client/docs/type-aliases/TxInIndex.md +++ b/modules/brk-client/docs/type-aliases/TxInIndex.md @@ -6,8 +6,8 @@ # Type Alias: TxInIndex -> **TxInIndex**\<\> = `number` +> **TxInIndex** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:772](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L772) +Defined in: [Developer/brk/modules/brk-client/index.js:869](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L869) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TxIndex.md b/modules/brk-client/docs/type-aliases/TxIndex.md index 296d4fc78..e24b786fe 100644 --- a/modules/brk-client/docs/type-aliases/TxIndex.md +++ b/modules/brk-client/docs/type-aliases/TxIndex.md @@ -6,8 +6,8 @@ # Type Alias: TxIndex -> **TxIndex**\<\> = `number` +> **TxIndex** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:773](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L773) +Defined in: [Developer/brk/modules/brk-client/index.js:870](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L870) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TxOutIndex.md b/modules/brk-client/docs/type-aliases/TxOutIndex.md index 5b2164971..cc3c94cc1 100644 --- a/modules/brk-client/docs/type-aliases/TxOutIndex.md +++ b/modules/brk-client/docs/type-aliases/TxOutIndex.md @@ -6,8 +6,8 @@ # Type Alias: TxOutIndex -> **TxOutIndex**\<\> = `number` +> **TxOutIndex** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:781](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L781) +Defined in: [Developer/brk/modules/brk-client/index.js:878](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L878) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TxVersion.md b/modules/brk-client/docs/type-aliases/TxVersion.md index da71df0da..7d969e273 100644 --- a/modules/brk-client/docs/type-aliases/TxVersion.md +++ b/modules/brk-client/docs/type-aliases/TxVersion.md @@ -6,8 +6,8 @@ # Type Alias: TxVersion -> **TxVersion**\<\> = `number` +> **TxVersion** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:803](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L803) +Defined in: [Developer/brk/modules/brk-client/index.js:900](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L900) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Txid.md b/modules/brk-client/docs/type-aliases/Txid.md index 38093beb8..587720cf9 100644 --- a/modules/brk-client/docs/type-aliases/Txid.md +++ b/modules/brk-client/docs/type-aliases/Txid.md @@ -6,8 +6,8 @@ # Type Alias: Txid -> **Txid**\<\> = `string` +> **Txid** = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:808](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L808) +Defined in: [Developer/brk/modules/brk-client/index.js:905](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L905) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TypeIndex.md b/modules/brk-client/docs/type-aliases/TypeIndex.md index 80404a159..cfda3b556 100644 --- a/modules/brk-client/docs/type-aliases/TypeIndex.md +++ b/modules/brk-client/docs/type-aliases/TypeIndex.md @@ -6,8 +6,8 @@ # Type Alias: TypeIndex -> **TypeIndex**\<\> = `number` +> **TypeIndex** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:824](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L824) +Defined in: [Developer/brk/modules/brk-client/index.js:921](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L921) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/U8x2.md b/modules/brk-client/docs/type-aliases/U8x2.md index 1d231f772..8b2441c60 100644 --- a/modules/brk-client/docs/type-aliases/U8x2.md +++ b/modules/brk-client/docs/type-aliases/U8x2.md @@ -6,8 +6,8 @@ # Type Alias: U8x2 -> **U8x2**\<\> = `number`[] +> **U8x2** = `number`[] -Defined in: [Developer/brk/modules/brk-client/index.js:826](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L826) +Defined in: [Developer/brk/modules/brk-client/index.js:923](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L923) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/U8x20.md b/modules/brk-client/docs/type-aliases/U8x20.md index 4d589db3e..40fb76587 100644 --- a/modules/brk-client/docs/type-aliases/U8x20.md +++ b/modules/brk-client/docs/type-aliases/U8x20.md @@ -6,8 +6,8 @@ # Type Alias: U8x20 -> **U8x20**\<\> = `number`[] +> **U8x20** = `number`[] -Defined in: [Developer/brk/modules/brk-client/index.js:827](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L827) +Defined in: [Developer/brk/modules/brk-client/index.js:924](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L924) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/U8x32.md b/modules/brk-client/docs/type-aliases/U8x32.md index 49cc6ddd0..9603b517e 100644 --- a/modules/brk-client/docs/type-aliases/U8x32.md +++ b/modules/brk-client/docs/type-aliases/U8x32.md @@ -6,8 +6,8 @@ # Type Alias: U8x32 -> **U8x32**\<\> = `number`[] +> **U8x32** = `number`[] -Defined in: [Developer/brk/modules/brk-client/index.js:828](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L828) +Defined in: [Developer/brk/modules/brk-client/index.js:925](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L925) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/U8x33.md b/modules/brk-client/docs/type-aliases/U8x33.md index c9fdee531..39d28bb8b 100644 --- a/modules/brk-client/docs/type-aliases/U8x33.md +++ b/modules/brk-client/docs/type-aliases/U8x33.md @@ -6,8 +6,8 @@ # Type Alias: U8x33 -> **U8x33**\<\> = `string` +> **U8x33** = `number`[] -Defined in: [Developer/brk/modules/brk-client/index.js:829](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L829) +Defined in: [Developer/brk/modules/brk-client/index.js:926](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L926) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/U8x65.md b/modules/brk-client/docs/type-aliases/U8x65.md index ac1c07ef2..9a511cd6b 100644 --- a/modules/brk-client/docs/type-aliases/U8x65.md +++ b/modules/brk-client/docs/type-aliases/U8x65.md @@ -6,8 +6,8 @@ # Type Alias: U8x65 -> **U8x65**\<\> = `string` +> **U8x65** = `number`[] -Defined in: [Developer/brk/modules/brk-client/index.js:830](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L830) +Defined in: [Developer/brk/modules/brk-client/index.js:927](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L927) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/UnknownOutputIndex.md b/modules/brk-client/docs/type-aliases/UnknownOutputIndex.md index 254ef88c0..967d40b7e 100644 --- a/modules/brk-client/docs/type-aliases/UnknownOutputIndex.md +++ b/modules/brk-client/docs/type-aliases/UnknownOutputIndex.md @@ -6,8 +6,8 @@ # Type Alias: UnknownOutputIndex -> **UnknownOutputIndex**\<\> = [`TypeIndex`](TypeIndex.md) +> **UnknownOutputIndex** = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:831](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L831) +Defined in: [Developer/brk/modules/brk-client/index.js:928](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L928) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/VSize.md b/modules/brk-client/docs/type-aliases/VSize.md index bca291214..e718d5ac8 100644 --- a/modules/brk-client/docs/type-aliases/VSize.md +++ b/modules/brk-client/docs/type-aliases/VSize.md @@ -6,8 +6,8 @@ # Type Alias: VSize -> **VSize**\<\> = `number` +> **VSize** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:844](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L844) +Defined in: [Developer/brk/modules/brk-client/index.js:941](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L941) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Version.md b/modules/brk-client/docs/type-aliases/Version.md new file mode 100644 index 000000000..e7809ea77 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Version.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Version + +# Type Alias: Version + +> **Version** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:954](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L954) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Vin.md b/modules/brk-client/docs/type-aliases/Vin.md index 49f7682c3..0f6e7e105 100644 --- a/modules/brk-client/docs/type-aliases/Vin.md +++ b/modules/brk-client/docs/type-aliases/Vin.md @@ -6,8 +6,8 @@ # Type Alias: Vin -> **Vin**\<\> = `number` +> **Vin** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:853](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L853) +Defined in: [Developer/brk/modules/brk-client/index.js:959](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L959) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Vout.md b/modules/brk-client/docs/type-aliases/Vout.md index 2acce090a..9e940ea2f 100644 --- a/modules/brk-client/docs/type-aliases/Vout.md +++ b/modules/brk-client/docs/type-aliases/Vout.md @@ -6,8 +6,8 @@ # Type Alias: Vout -> **Vout**\<\> = `number` +> **Vout** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:858](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L858) +Defined in: [Developer/brk/modules/brk-client/index.js:964](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L964) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Week1.md b/modules/brk-client/docs/type-aliases/Week1.md new file mode 100644 index 000000000..bcbe17ecf --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Week1.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Week1 + +# Type Alias: Week1 + +> **Week1** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:966](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L966) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/WeekIndex.md b/modules/brk-client/docs/type-aliases/WeekIndex.md deleted file mode 100644 index e6002aa35..000000000 --- a/modules/brk-client/docs/type-aliases/WeekIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / WeekIndex - -# Type Alias: WeekIndex - -> **WeekIndex**\<\> = `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:860](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L860) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Weight.md b/modules/brk-client/docs/type-aliases/Weight.md index dffe8b4b9..4f1e9a89e 100644 --- a/modules/brk-client/docs/type-aliases/Weight.md +++ b/modules/brk-client/docs/type-aliases/Weight.md @@ -6,8 +6,8 @@ # Type Alias: Weight -> **Weight**\<\> = `number` +> **Weight** = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:864](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L864) +Defined in: [Developer/brk/modules/brk-client/index.js:970](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L970) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Year1.md b/modules/brk-client/docs/type-aliases/Year1.md new file mode 100644 index 000000000..277667e1b --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Year1.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Year1 + +# Type Alias: Year1 + +> **Year1** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:972](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L972) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Year10.md b/modules/brk-client/docs/type-aliases/Year10.md new file mode 100644 index 000000000..46bebee5b --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Year10.md @@ -0,0 +1,13 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Year10 + +# Type Alias: Year10 + +> **Year10** = `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:973](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L973) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/YearIndex.md b/modules/brk-client/docs/type-aliases/YearIndex.md deleted file mode 100644 index 85a758467..000000000 --- a/modules/brk-client/docs/type-aliases/YearIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / YearIndex - -# Type Alias: YearIndex - -> **YearIndex**\<\> = `number` - -Defined in: [Developer/brk/modules/brk-client/index.js:866](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L866) - -## Type Parameters diff --git a/packages/brk_client/DOCS.md b/packages/brk_client/DOCS.md index 5088bee9b..848930e85 100644 --- a/packages/brk_client/DOCS.md +++ b/packages/brk_client/DOCS.md @@ -2,23 +2,25 @@ * [brk\_client](#brk_client) * [BrkError](#brk_client.BrkError) - * [MetricData](#brk_client.MetricData) * [BrkClient](#brk_client.BrkClient) * [VERSION](#brk_client.BrkClient.VERSION) * [INDEXES](#brk_client.BrkClient.INDEXES) * [POOL\_ID\_TO\_POOL\_NAME](#brk_client.BrkClient.POOL_ID_TO_POOL_NAME) * [TERM\_NAMES](#brk_client.BrkClient.TERM_NAMES) * [EPOCH\_NAMES](#brk_client.BrkClient.EPOCH_NAMES) - * [YEAR\_NAMES](#brk_client.BrkClient.YEAR_NAMES) + * [CLASS\_NAMES](#brk_client.BrkClient.CLASS_NAMES) * [SPENDABLE\_TYPE\_NAMES](#brk_client.BrkClient.SPENDABLE_TYPE_NAMES) * [AGE\_RANGE\_NAMES](#brk_client.BrkClient.AGE_RANGE_NAMES) - * [MAX\_AGE\_NAMES](#brk_client.BrkClient.MAX_AGE_NAMES) - * [MIN\_AGE\_NAMES](#brk_client.BrkClient.MIN_AGE_NAMES) + * [UNDER\_AGE\_NAMES](#brk_client.BrkClient.UNDER_AGE_NAMES) + * [OVER\_AGE\_NAMES](#brk_client.BrkClient.OVER_AGE_NAMES) * [AMOUNT\_RANGE\_NAMES](#brk_client.BrkClient.AMOUNT_RANGE_NAMES) - * [GE\_AMOUNT\_NAMES](#brk_client.BrkClient.GE_AMOUNT_NAMES) - * [LT\_AMOUNT\_NAMES](#brk_client.BrkClient.LT_AMOUNT_NAMES) + * [OVER\_AMOUNT\_NAMES](#brk_client.BrkClient.OVER_AMOUNT_NAMES) + * [UNDER\_AMOUNT\_NAMES](#brk_client.BrkClient.UNDER_AMOUNT_NAMES) + * [PROFITABILITY\_RANGE\_NAMES](#brk_client.BrkClient.PROFITABILITY_RANGE_NAMES) + * [PROFIT\_NAMES](#brk_client.BrkClient.PROFIT_NAMES) + * [LOSS\_NAMES](#brk_client.BrkClient.LOSS_NAMES) * [\_\_init\_\_](#brk_client.BrkClient.__init__) - * [metric](#brk_client.BrkClient.metric) + * [series\_endpoint](#brk_client.BrkClient.series_endpoint) * [index\_to\_date](#brk_client.BrkClient.index_to_date) * [date\_to\_index](#brk_client.BrkClient.date_to_index) * [get\_api](#brk_client.BrkClient.get_api) @@ -39,17 +41,21 @@ * [get\_mempool](#brk_client.BrkClient.get_mempool) * [get\_live\_price](#brk_client.BrkClient.get_live_price) * [get\_mempool\_txids](#brk_client.BrkClient.get_mempool_txids) - * [get\_metric\_info](#brk_client.BrkClient.get_metric_info) - * [get\_metric](#brk_client.BrkClient.get_metric) - * [get\_metrics\_tree](#brk_client.BrkClient.get_metrics_tree) - * [get\_metrics](#brk_client.BrkClient.get_metrics) + * [get\_series\_tree](#brk_client.BrkClient.get_series_tree) + * [get\_series\_bulk](#brk_client.BrkClient.get_series_bulk) * [get\_cost\_basis\_cohorts](#brk_client.BrkClient.get_cost_basis_cohorts) * [get\_cost\_basis\_dates](#brk_client.BrkClient.get_cost_basis_dates) * [get\_cost\_basis](#brk_client.BrkClient.get_cost_basis) - * [get\_metrics\_count](#brk_client.BrkClient.get_metrics_count) + * [get\_series\_count](#brk_client.BrkClient.get_series_count) * [get\_indexes](#brk_client.BrkClient.get_indexes) - * [list\_metrics](#brk_client.BrkClient.list_metrics) - * [search\_metrics](#brk_client.BrkClient.search_metrics) + * [list\_series](#brk_client.BrkClient.list_series) + * [search\_series](#brk_client.BrkClient.search_series) + * [get\_series\_info](#brk_client.BrkClient.get_series_info) + * [get\_series](#brk_client.BrkClient.get_series) + * [get\_series\_data](#brk_client.BrkClient.get_series_data) + * [get\_series\_latest](#brk_client.BrkClient.get_series_latest) + * [get\_series\_len](#brk_client.BrkClient.get_series_len) + * [get\_series\_version](#brk_client.BrkClient.get_series_version) * [get\_disk\_usage](#brk_client.BrkClient.get_disk_usage) * [get\_sync\_status](#brk_client.BrkClient.get_sync_status) * [get\_tx](#brk_client.BrkClient.get_tx) @@ -92,17 +98,6 @@ class BrkError(Exception) Custom error class for BRK client errors. - - -## MetricData Objects - -```python -@dataclass -class MetricData(Generic[T]) -``` - -Metric data with range information. - ## BrkClient Objects @@ -111,7 +106,7 @@ Metric data with range information. class BrkClient(BrkClientBase) ``` -Main BRK client with metrics tree and API methods. +Main BRK client with series tree and API methods. @@ -133,9 +128,9 @@ Main BRK client with metrics tree and API methods. #### EPOCH\_NAMES - + -#### YEAR\_NAMES +#### CLASS\_NAMES @@ -145,25 +140,37 @@ Main BRK client with metrics tree and API methods. #### AGE\_RANGE\_NAMES - + -#### MAX\_AGE\_NAMES +#### UNDER\_AGE\_NAMES - + -#### MIN\_AGE\_NAMES +#### OVER\_AGE\_NAMES #### AMOUNT\_RANGE\_NAMES - + -#### GE\_AMOUNT\_NAMES +#### OVER\_AMOUNT\_NAMES - + -#### LT\_AMOUNT\_NAMES +#### UNDER\_AMOUNT\_NAMES + + + +#### PROFITABILITY\_RANGE\_NAMES + + + +#### PROFIT\_NAMES + + + +#### LOSS\_NAMES @@ -173,18 +180,18 @@ Main BRK client with metrics tree and API methods. def __init__(base_url: str = 'http://localhost:3000', timeout: float = 30.0) ``` - + -#### metric +#### series\_endpoint ```python -def metric(metric: str, index: Index) -> MetricEndpointBuilder[Any] +def series_endpoint(series: str, index: Index) -> SeriesEndpoint[Any] ``` -Create a dynamic metric endpoint builder for any metric/index combination. +Create a dynamic series endpoint builder for any series/index combination. -Use this for programmatic access when the metric name is determined at runtime. -For type-safe access, use the `metrics` tree instead. +Use this for programmatic access when the series name is determined at runtime. +For type-safe access, use the `series` tree instead. @@ -225,7 +232,7 @@ Endpoint: `GET /api.json` #### get\_address ```python -def get_address(address: Address) -> AddressStats +def get_address(address: Addr) -> AddrStats ``` Address information. @@ -241,14 +248,13 @@ Endpoint: `GET /api/address/{address}` #### get\_address\_txs ```python -def get_address_txs(address: Address, - after_txid: Optional[str] = None, - limit: Optional[float] = None) -> List[Txid] +def get_address_txs(address: Addr, + after_txid: Optional[Txid] = None) -> List[Transaction] ``` -Address transaction IDs. +Address transactions. -Get transaction IDs for an address, newest first. Use after_txid for pagination. +Get transaction history for an address, sorted with newest first. Returns up to 50 mempool transactions plus the first 25 confirmed transactions. Use ?after_txid= for pagination. *[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions)* @@ -259,14 +265,14 @@ Endpoint: `GET /api/address/{address}/txs` #### get\_address\_confirmed\_txs ```python -def get_address_confirmed_txs(address: Address, - after_txid: Optional[str] = None, - limit: Optional[float] = None) -> List[Txid] +def get_address_confirmed_txs(address: Addr, + after_txid: Optional[Txid] = None + ) -> List[Transaction] ``` Address confirmed transactions. -Get confirmed transaction IDs for an address, 25 per page. Use ?after_txid= for pagination. +Get confirmed transactions for an address, 25 per page. Use ?after_txid= for pagination. *[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions-chain)* @@ -277,7 +283,7 @@ Endpoint: `GET /api/address/{address}/txs/chain` #### get\_address\_mempool\_txs ```python -def get_address_mempool_txs(address: Address) -> List[Txid] +def get_address_mempool_txs(address: Addr) -> List[Txid] ``` Address mempool transactions. @@ -293,7 +299,7 @@ Endpoint: `GET /api/address/{address}/txs/mempool` #### get\_address\_utxos ```python -def get_address_utxos(address: Address) -> List[Utxo] +def get_address_utxos(address: Addr) -> List[Utxo] ``` Address UTXOs. @@ -494,72 +500,39 @@ Get all transaction IDs currently in the mempool. Endpoint: `GET /api/mempool/txids` - + -#### get\_metric\_info +#### get\_series\_tree ```python -def get_metric_info(metric: Metric) -> List[Index] +def get_series_tree() -> TreeNode ``` -Get supported indexes for a metric. +Series catalog. -Returns the list of indexes supported by the specified metric. For example, `realized_price` might be available on dateindex, weekindex, and monthindex. +Returns the complete hierarchical catalog of available series organized as a tree structure. Series are grouped by categories and subcategories. -Endpoint: `GET /api/metric/{metric}` +Endpoint: `GET /api/series` - + -#### get\_metric +#### get\_series\_bulk ```python -def get_metric(metric: Metric, - index: Index, - start: Optional[float] = None, - end: Optional[float] = None, - limit: Optional[str] = None, - format: Optional[Format] = None) -> Union[AnyMetricData, str] -``` - -Get metric data. - -Fetch data for a specific metric at the given index. Use query parameters to filter by date range and format (json/csv). - -Endpoint: `GET /api/metric/{metric}/{index}` - - - -#### get\_metrics\_tree - -```python -def get_metrics_tree() -> TreeNode -``` - -Metrics catalog. - -Returns the complete hierarchical catalog of available metrics organized as a tree structure. Metrics are grouped by categories and subcategories. - -Endpoint: `GET /api/metrics` - - - -#### get\_metrics - -```python -def get_metrics( - metrics: Metrics, +def get_series_bulk( + series: SeriesList, index: Index, - start: Optional[float] = None, - end: Optional[float] = None, - limit: Optional[str] = None, - format: Optional[Format] = None) -> Union[List[AnyMetricData], str] + start: Optional[RangeIndex] = None, + end: Optional[RangeIndex] = None, + limit: Optional[Limit] = None, + format: Optional[Format] = None) -> Union[List[AnySeriesData], str] ``` -Bulk metric data. +Bulk series data. -Fetch multiple metrics in a single request. Supports filtering by index and date range. Returns an array of MetricData objects. For a single metric, use `get_metric` instead. +Fetch multiple series in a single request. Supports filtering by index and date range. Returns an array of SeriesData objects. For a single series, use `get_series` instead. -Endpoint: `GET /api/metrics/bulk` +Endpoint: `GET /api/series/bulk` @@ -573,7 +546,7 @@ Available cost basis cohorts. List available cohorts for cost basis distribution. -Endpoint: `GET /api/metrics/cost-basis` +Endpoint: `GET /api/series/cost-basis` @@ -587,7 +560,7 @@ Available cost basis dates. List available dates for a cohort's cost basis distribution. -Endpoint: `GET /api/metrics/cost-basis/{cohort}/dates` +Endpoint: `GET /api/series/cost-basis/{cohort}/dates` @@ -608,21 +581,21 @@ Query params: - `bucket`: raw (default), lin200, lin500, lin1000, log10, log50, log100 - `value`: supply (default, in BTC), realized (USD), unrealized (USD) -Endpoint: `GET /api/metrics/cost-basis/{cohort}/{date}` +Endpoint: `GET /api/series/cost-basis/{cohort}/{date}` - + -#### get\_metrics\_count +#### get\_series\_count ```python -def get_metrics_count() -> List[MetricCount] +def get_series_count() -> List[SeriesCount] ``` -Metric count. +Series count. -Returns the number of metrics available per index type. +Returns the number of series available per index type. -Endpoint: `GET /api/metrics/count` +Endpoint: `GET /api/series/count` @@ -634,38 +607,132 @@ def get_indexes() -> List[IndexInfo] List available indexes. -Returns all available indexes with their accepted query aliases. Use any alias when querying metrics. +Returns all available indexes with their accepted query aliases. Use any alias when querying series. -Endpoint: `GET /api/metrics/indexes` +Endpoint: `GET /api/series/indexes` - + -#### list\_metrics +#### list\_series ```python -def list_metrics(page: Optional[float] = None) -> PaginatedMetrics +def list_series(page: Optional[float] = None, + per_page: Optional[float] = None) -> PaginatedSeries ``` -Metrics list. +Series list. -Paginated flat list of all available metric names. Use `page` query param for pagination. +Paginated flat list of all available series names. Use `page` query param for pagination. -Endpoint: `GET /api/metrics/list` +Endpoint: `GET /api/series/list` - + -#### search\_metrics +#### search\_series ```python -def search_metrics(metric: Metric, - limit: Optional[Limit] = None) -> List[Metric] +def search_series(q: SeriesName, limit: Optional[Limit] = None) -> List[str] ``` -Search metrics. +Search series. -Fuzzy search for metrics by name. Supports partial matches and typos. +Fuzzy search for series by name. Supports partial matches and typos. -Endpoint: `GET /api/metrics/search/{metric}` +Endpoint: `GET /api/series/search` + + + +#### get\_series\_info + +```python +def get_series_info(series: SeriesName) -> SeriesInfo +``` + +Get series info. + +Returns the supported indexes and value type for the specified series. + +Endpoint: `GET /api/series/{series}` + + + +#### get\_series + +```python +def get_series(series: SeriesName, + index: Index, + start: Optional[RangeIndex] = None, + end: Optional[RangeIndex] = None, + limit: Optional[Limit] = None, + format: Optional[Format] = None) -> Union[AnySeriesData, str] +``` + +Get series data. + +Fetch data for a specific series at the given index. Use query parameters to filter by date range and format (json/csv). + +Endpoint: `GET /api/series/{series}/{index}` + + + +#### get\_series\_data + +```python +def get_series_data(series: SeriesName, + index: Index, + start: Optional[RangeIndex] = None, + end: Optional[RangeIndex] = None, + limit: Optional[Limit] = None, + format: Optional[Format] = None) -> Union[List[bool], str] +``` + +Get raw series data. + +Returns just the data array without the SeriesData wrapper. Supports the same range and format parameters as the standard endpoint. + +Endpoint: `GET /api/series/{series}/{index}/data` + + + +#### get\_series\_latest + +```python +def get_series_latest(series: SeriesName, index: Index) -> Any +``` + +Get latest series value. + +Returns the single most recent value for a series, unwrapped (not inside a SeriesData object). + +Endpoint: `GET /api/series/{series}/{index}/latest` + + + +#### get\_series\_len + +```python +def get_series_len(series: SeriesName, index: Index) -> float +``` + +Get series data length. + +Returns the total number of data points for a series at the given index. + +Endpoint: `GET /api/series/{series}/{index}/len` + + + +#### get\_series\_version + +```python +def get_series_version(series: SeriesName, index: Index) -> Version +``` + +Get series version. + +Returns the current version of a series. Changes when the series data is updated. + +Endpoint: `GET /api/series/{series}/{index}/version` @@ -1037,7 +1104,7 @@ Endpoint: `GET /api/v1/mining/reward-stats/{block_count}` #### validate\_address ```python -def validate_address(address: str) -> AddressValidation +def validate_address(address: str) -> AddrValidation ``` Validate address. diff --git a/scripts/quick-release.sh b/scripts/quick-release.sh index 0e07757a9..d8ee75ac3 100755 --- a/scripts/quick-release.sh +++ b/scripts/quick-release.sh @@ -55,7 +55,7 @@ echo "" echo "--- Rust ---" cd "$ROOT_DIR" -cargo build --workspace --release +# cargo build --workspace --release echo "" echo "--- JavaScript ---"