diff --git a/crates/brk_bindgen/tests/catalog_test.rs b/crates/brk_bindgen/tests/catalog_test.rs index 210153a28..181076450 100644 --- a/crates/brk_bindgen/tests/catalog_test.rs +++ b/crates/brk_bindgen/tests/catalog_test.rs @@ -862,66 +862,6 @@ fn test_root_cost_basis_prefix() { println!("Nested cost_basis prefix: {:?}", nested_prefix); } -#[test] -fn test_price_sats_vs_usd_different_field_parts() { - // This test verifies that price.sats and price.usd, which have the same structure - // but different metric naming conventions, are handled correctly. - // - // price.sats has: price_ohlc_sats, price_sats_close, price_sats_high, etc. - // price.usd has: price_ohlc, price_close, price_high, etc. - // - // Both should use the same structural pattern but with different base arguments. - - let catalog = load_catalog(); - let metadata = ClientMetadata::from_catalog(catalog.clone()); - - // Generate JavaScript output - let mut js_output = String::new(); - writeln!(js_output, "// Test output").unwrap(); - brk_bindgen::javascript::client::generate_base_client(&mut js_output); - brk_bindgen::javascript::client::generate_index_accessors( - &mut js_output, - &metadata.index_set_patterns, - ); - brk_bindgen::javascript::client::generate_structural_patterns( - &mut js_output, - &metadata.structural_patterns, - &metadata, - ); - brk_bindgen::javascript::tree::generate_tree_typedefs( - &mut js_output, - &metadata.catalog, - &metadata, - ); - brk_bindgen::javascript::tree::generate_main_client( - &mut js_output, - &metadata.catalog, - &metadata, - &[], - ); - - // With improved pattern detection, price.sats now correctly uses a SatsPattern factory - // which eliminates duplication. Verify that it's being used: - assert!( - js_output.contains("sats: createSatsPattern(this, 'price')"), - "price.sats should use SatsPattern factory" - ); - - // Verify price.usd is inlined and uses non-sats metrics (no _sats suffix) - assert!( - js_output.contains("createMetricPattern1(this, 'price_ohlc')"), - "price.usd.ohlc should use 'price_ohlc' (without _sats)" - ); - assert!( - js_output.contains("createSplitPattern2(this, 'price')"), - "price.usd.split should use 'price' base (without _sats)" - ); - - println!("\nPrice sats vs usd field_parts test passed!"); - println!(" - price.sats correctly uses sats-suffixed metrics"); - println!(" - price.usd correctly uses non-sats metrics"); -} - #[test] fn test_utxo_cohorts_all_activity_base() { // Test that distribution.utxo_cohorts.all.activity uses empty base diff --git a/crates/brk_cli/README.md b/crates/brk_cli/README.md index 14b61d0bd..67a76cbfc 100644 --- a/crates/brk_cli/README.md +++ b/crates/brk_cli/README.md @@ -17,26 +17,37 @@ Run a full BRK instance: index the blockchain, compute metrics, serve the API, a ## Install +First, ensure Rust is up to date: + ```bash +rustup update +``` + +Recommended (optimized for your CPU, auto-finds latest version): + +```bash +RUSTFLAGS="-C target-cpu=native" cargo install --locked brk_cli --version "$(cargo search brk_cli | head -1 | awk -F'"' '{print $2}')" +``` + +**Variants:** + +```bash +# Standard install (portable, latest stable only) cargo install --locked brk_cli + +# Specific version +cargo install --locked brk_cli --version "0.1.0-alpha.2" ``` -For pre-release versions (alpha, beta, rc), specify the version explicitly: +See [crates.io/crates/brk_cli/versions](https://crates.io/crates/brk_cli/versions) for all versions. + +## Update + +Same as install - cargo replaces the existing binary: ```bash -# Find the latest version -cargo search brk_cli - -# Install a specific version -cargo install --locked brk_cli --version "VERSION" -``` - -See [crates.io/crates/brk_cli/versions](https://crates.io/crates/brk_cli/versions) for all available versions. - -For better performance, build with native CPU optimizations: - -```bash -RUSTFLAGS="-C target-cpu=native" cargo install --locked brk_cli +rustup update +RUSTFLAGS="-C target-cpu=native" cargo install --locked brk_cli --version "$(cargo search brk_cli | head -1 | awk -F'"' '{print $2}')" ``` ## Requirements diff --git a/modules/brk-client/docs/classes/BrkClient.md b/modules/brk-client/docs/classes/BrkClient.md index ffdff76f2..7e669100a 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:5136](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5136) +Defined in: [Developer/brk/modules/brk-client/index.js:4192](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4192) -Main BRK client with catalog tree and API methods +Main BRK client with metrics tree and API methods ## Extends @@ -20,7 +20,7 @@ Main BRK client with catalog tree and API methods > **new BrkClient**(`options`): `BrkClient` -Defined in: [Developer/brk/modules/brk-client/index.js:6033](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L6033) +Defined in: [Developer/brk/modules/brk-client/index.js:5089](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L5089) #### Parameters @@ -38,19 +38,747 @@ Defined in: [Developer/brk/modules/brk-client/index.js:6033](https://github.com/ ## Properties -### tree +### \_cachePromise -> **tree**: [`CatalogTree`](../interfaces/CatalogTree.md) +> **\_cachePromise**: `Promise`\<`Cache` \| `null`\> -Defined in: [Developer/brk/modules/brk-client/index.js:6036](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L6036) +Defined in: [Developer/brk/modules/brk-client/index.js:983](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L983) + +#### Inherited from + +`BrkClientBase._cachePromise` + +*** + +### metrics + +> **metrics**: [`MetricsTree`](../interfaces/MetricsTree.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:5092](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L5092) ## Methods ### get() -> **get**\<`T`\>(`path`, `onUpdate?`): `Promise`\<`T`\> +> **get**(`path`): `Promise`\<`Response`\> -Defined in: [Developer/brk/modules/brk-client/index.js:619](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L619) +Defined in: [Developer/brk/modules/brk-client/index.js:990](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L990) + +#### Parameters + +##### path + +`string` + +#### Returns + +`Promise`\<`Response`\> + +#### Inherited from + +`BrkClientBase.get` + +*** + +### getAddress() + +> **getAddress**(`address`): `Promise`\<[`AddressStats`](../interfaces/AddressStats.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6135](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6135) + +Address information + +Retrieve address information including balance and transaction counts. Supports all standard Bitcoin address types (P2PKH, P2SH, P2WPKH, P2WSH, P2TR). + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address)* + +Endpoint: `GET /api/address/{address}` + +#### Parameters + +##### address + +`string` + +#### Returns + +`Promise`\<[`AddressStats`](../interfaces/AddressStats.md)\> + +*** + +### getAddressConfirmedTxs() + +> **getAddressConfirmedTxs**(`address`, `after_txid?`, `limit?`): `Promise`\<`string`[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6176](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6176) + +Address confirmed transactions + +Get confirmed transaction IDs for an address, 25 per page. Use ?after_txid= for pagination. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions-chain)* + +Endpoint: `GET /api/address/{address}/txs/chain` + +#### Parameters + +##### address + +`string` + +##### after\_txid? + +`string` + +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`[]\> + +*** + +### getAddressMempoolTxs() + +> **getAddressMempoolTxs**(`address`): `Promise`\<`string`[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6197](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6197) + +Address mempool transactions + +Get unconfirmed transaction IDs for an address from the mempool (up to 50). + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions-mempool)* + +Endpoint: `GET /api/address/{address}/txs/mempool` + +#### Parameters + +##### address + +`string` + +#### Returns + +`Promise`\<`string`[]\> + +*** + +### getAddressTxs() + +> **getAddressTxs**(`address`, `after_txid?`, `limit?`): `Promise`\<`string`[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6153](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6153) + +Address transaction IDs + +Get transaction IDs for an address, newest first. Use after_txid for pagination. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions)* + +Endpoint: `GET /api/address/{address}/txs` + +#### Parameters + +##### address + +`string` + +##### after\_txid? + +`string` + +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`[]\> + +*** + +### getAddressUtxos() + +> **getAddressUtxos**(`address`): `Promise`\<[`Utxo`](../interfaces/Utxo.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6213](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6213) + +Address UTXOs + +Get unspent transaction outputs (UTXOs) for an address. Returns txid, vout, value, and confirmation status for each UTXO. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-utxo)* + +Endpoint: `GET /api/address/{address}/utxo` + +#### Parameters + +##### address + +`string` + +#### Returns + +`Promise`\<[`Utxo`](../interfaces/Utxo.md)[]\> + +*** + +### getBlock() + +> **getBlock**(`hash`): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6245](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6245) + +Block information + +Retrieve block information by block hash. Returns block metadata including height, timestamp, difficulty, size, weight, and transaction count. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block)* + +Endpoint: `GET /api/block/{hash}` + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)\> + +*** + +### getBlockByHeight() + +> **getBlockByHeight**(`height`): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6229](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6229) + +Block by height + +Retrieve block information by block height. Returns block metadata including hash, timestamp, difficulty, size, weight, and transaction count. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-height)* + +Endpoint: `GET /api/block-height/{height}` + +#### Parameters + +##### height + +`number` + +#### Returns + +`Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)\> + +*** + +### getBlockByTimestamp() + +> **getBlockByTimestamp**(`timestamp`): `Promise`\<[`BlockTimestamp`](../interfaces/BlockTimestamp.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6759](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6759) + +Block by timestamp + +Find the block closest to a given UNIX timestamp. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-timestamp)* + +Endpoint: `GET /api/v1/mining/blocks/timestamp/{timestamp}` + +#### Parameters + +##### timestamp + +`number` + +#### Returns + +`Promise`\<[`BlockTimestamp`](../interfaces/BlockTimestamp.md)\> + +*** + +### getBlockFeeRates() + +> **getBlockFeeRates**(`time_period`): `Promise`\<`any`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6695](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6695) + +Block fee rates (WIP) + +**Work in progress.** Get block fee rate percentiles (min, 10th, 25th, median, 75th, 90th, max) for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-feerates)* + +Endpoint: `GET /api/v1/mining/blocks/fee-rates/{time_period}` + +#### Parameters + +##### time\_period + +[`TimePeriod`](../type-aliases/TimePeriod.md) + +#### Returns + +`Promise`\<`any`\> + +*** + +### getBlockFees() + +> **getBlockFees**(`time_period`): `Promise`\<[`BlockFeesEntry`](../interfaces/BlockFeesEntry.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6711](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6711) + +Block fees + +Get average block fees for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-fees)* + +Endpoint: `GET /api/v1/mining/blocks/fees/{time_period}` + +#### Parameters + +##### time\_period + +[`TimePeriod`](../type-aliases/TimePeriod.md) + +#### Returns + +`Promise`\<[`BlockFeesEntry`](../interfaces/BlockFeesEntry.md)[]\> + +*** + +### getBlockRaw() + +> **getBlockRaw**(`hash`): `Promise`\<`number`[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6261](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6261) + +Raw block + +Returns the raw block data in binary format. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-raw)* + +Endpoint: `GET /api/block/{hash}/raw` + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<`number`[]\> + +*** + +### getBlockRewards() + +> **getBlockRewards**(`time_period`): `Promise`\<[`BlockRewardsEntry`](../interfaces/BlockRewardsEntry.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6727](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6727) + +Block rewards + +Get average block rewards (coinbase = subsidy + fees) for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-rewards)* + +Endpoint: `GET /api/v1/mining/blocks/rewards/{time_period}` + +#### Parameters + +##### time\_period + +[`TimePeriod`](../type-aliases/TimePeriod.md) + +#### Returns + +`Promise`\<[`BlockRewardsEntry`](../interfaces/BlockRewardsEntry.md)[]\> + +*** + +### getBlocks() + +> **getBlocks**(): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6341](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6341) + +Recent blocks + +Retrieve the last 10 blocks. Returns block metadata for each block. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-blocks)* + +Endpoint: `GET /api/blocks` + +#### Returns + +`Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)[]\> + +*** + +### getBlocksFromHeight() + +> **getBlocksFromHeight**(`height`): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6357](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6357) + +Blocks from height + +Retrieve up to 10 blocks going backwards from the given height. For example, height=100 returns blocks 100, 99, 98, ..., 91. Height=0 returns only block 0. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-blocks)* + +Endpoint: `GET /api/blocks/{height}` + +#### Parameters + +##### height + +`number` + +#### Returns + +`Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)[]\> + +*** + +### getBlockSizesWeights() + +> **getBlockSizesWeights**(`time_period`): `Promise`\<[`BlockSizesWeights`](../interfaces/BlockSizesWeights.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6743](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6743) + +Block sizes and weights + +Get average block sizes and weights for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-sizes-weights)* + +Endpoint: `GET /api/v1/mining/blocks/sizes-weights/{time_period}` + +#### Parameters + +##### time\_period + +[`TimePeriod`](../type-aliases/TimePeriod.md) + +#### Returns + +`Promise`\<[`BlockSizesWeights`](../interfaces/BlockSizesWeights.md)\> + +*** + +### getBlockStatus() + +> **getBlockStatus**(`hash`): `Promise`\<[`BlockStatus`](../interfaces/BlockStatus.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6277](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6277) + +Block status + +Retrieve the status of a block. Returns whether the block is in the best chain and, if so, its height and the hash of the next block. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-status)* + +Endpoint: `GET /api/block/{hash}/status` + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<[`BlockStatus`](../interfaces/BlockStatus.md)\> + +*** + +### getBlockTxid() + +> **getBlockTxid**(`hash`, `index`): `Promise`\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6294](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6294) + +Transaction ID at index + +Retrieve a single transaction ID at a specific index within a block. Returns plain text txid. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-transaction-id)* + +Endpoint: `GET /api/block/{hash}/txid/{index}` + +#### Parameters + +##### hash + +`string` + +Bitcoin block hash + +##### index + +`number` + +Transaction index within the block (0-based) + +#### Returns + +`Promise`\<`string`\> + +*** + +### getBlockTxids() + +> **getBlockTxids**(`hash`): `Promise`\<`string`[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6310](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6310) + +Block transaction IDs + +Retrieve all transaction IDs in a block. Returns an array of txids in block order. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-transaction-ids)* + +Endpoint: `GET /api/block/{hash}/txids` + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<`string`[]\> + +*** + +### getBlockTxs() + +> **getBlockTxs**(`hash`, `start_index`): `Promise`\<[`Transaction`](../interfaces/Transaction.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6327](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6327) + +Block transactions (paginated) + +Retrieve transactions in a block by block hash, starting from the specified index. Returns up to 25 transactions at a time. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-transactions)* + +Endpoint: `GET /api/block/{hash}/txs/{start_index}` + +#### Parameters + +##### hash + +`string` + +Bitcoin block hash + +##### start\_index + +`number` + +Starting transaction index within the block (0-based) + +#### Returns + +`Promise`\<[`Transaction`](../interfaces/Transaction.md)[]\> + +*** + +### getDifficultyAdjustment() + +> **getDifficultyAdjustment**(): `Promise`\<[`DifficultyAdjustment`](../interfaces/DifficultyAdjustment.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6651](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6651) + +Difficulty adjustment + +Get current difficulty adjustment information including progress through the current epoch, estimated retarget date, and difficulty change prediction. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-difficulty-adjustment)* + +Endpoint: `GET /api/v1/difficulty-adjustment` + +#### Returns + +`Promise`\<[`DifficultyAdjustment`](../interfaces/DifficultyAdjustment.md)\> + +*** + +### getDifficultyAdjustments() + +> **getDifficultyAdjustments**(): `Promise`\<[`DifficultyAdjustmentEntry`](../interfaces/DifficultyAdjustmentEntry.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6773](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6773) + +Difficulty adjustments (all time) + +Get historical difficulty adjustments including timestamp, block height, difficulty value, and percentage change. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-difficulty-adjustments)* + +Endpoint: `GET /api/v1/mining/difficulty-adjustments` + +#### Returns + +`Promise`\<[`DifficultyAdjustmentEntry`](../interfaces/DifficultyAdjustmentEntry.md)[]\> + +*** + +### getDifficultyAdjustmentsByPeriod() + +> **getDifficultyAdjustmentsByPeriod**(`time_period`): `Promise`\<[`DifficultyAdjustmentEntry`](../interfaces/DifficultyAdjustmentEntry.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6789](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6789) + +Difficulty adjustments + +Get historical difficulty adjustments for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-difficulty-adjustments)* + +Endpoint: `GET /api/v1/mining/difficulty-adjustments/{time_period}` + +#### Parameters + +##### time\_period + +[`TimePeriod`](../type-aliases/TimePeriod.md) + +#### Returns + +`Promise`\<[`DifficultyAdjustmentEntry`](../interfaces/DifficultyAdjustmentEntry.md)[]\> + +*** + +### getDiskUsage() + +> **getDiskUsage**(): `Promise`\<[`DiskUsage`](../interfaces/DiskUsage.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6544](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6544) + +Disk usage + +Returns the disk space used by BRK and Bitcoin data. + +Endpoint: `GET /api/server/disk` + +#### Returns + +`Promise`\<[`DiskUsage`](../interfaces/DiskUsage.md)\> + +*** + +### getHashrate() + +> **getHashrate**(): `Promise`\<[`HashrateSummary`](../interfaces/HashrateSummary.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6803](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6803) + +Network hashrate (all time) + +Get network hashrate and difficulty data for all time. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-hashrate)* + +Endpoint: `GET /api/v1/mining/hashrate` + +#### Returns + +`Promise`\<[`HashrateSummary`](../interfaces/HashrateSummary.md)\> + +*** + +### getHashrateByPeriod() + +> **getHashrateByPeriod**(`time_period`): `Promise`\<[`HashrateSummary`](../interfaces/HashrateSummary.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6819](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6819) + +Network hashrate + +Get network hashrate and difficulty data for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-hashrate)* + +Endpoint: `GET /api/v1/mining/hashrate/{time_period}` + +#### Parameters + +##### time\_period + +[`TimePeriod`](../type-aliases/TimePeriod.md) + +#### Returns + +`Promise`\<[`HashrateSummary`](../interfaces/HashrateSummary.md)\> + +*** + +### getHealth() + +> **getHealth**(): `Promise`\<[`Health`](../interfaces/Health.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6909](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6909) + +Health check + +Returns the health status of the API server, including uptime information. + +Endpoint: `GET /health` + +#### Returns + +`Promise`\<[`Health`](../interfaces/Health.md)\> + +*** + +### getIndexes() + +> **getIndexes**(): `Promise`\<[`IndexInfo`](../interfaces/IndexInfo.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6495](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6495) + +List available indexes + +Returns all available indexes with their accepted query aliases. Use any alias when querying metrics. + +Endpoint: `GET /api/metrics/indexes` + +#### Returns + +`Promise`\<[`IndexInfo`](../interfaces/IndexInfo.md)[]\> + +*** + +### getJson() + +> **getJson**\<`T`\>(`path`, `onUpdate?`): `Promise`\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1005](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1005) Make a GET request with stale-while-revalidate caching @@ -78,394 +806,64 @@ Called when data is available #### Inherited from -`BrkClientBase.get` +`BrkClientBase.getJson` *** -### getAddress() +### getMempool() -> **getAddress**(`address`): `Promise`\<[`AddressStats`](../interfaces/AddressStats.md)\> +> **getMempool**(): `Promise`\<[`MempoolInfo`](../interfaces/MempoolInfo.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7444](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7444) - -Address information - -Retrieve comprehensive information about a Bitcoin address including balance, transaction history, UTXOs, and estimated investment metrics. Supports all standard Bitcoin address types (P2PKH, P2SH, P2WPKH, P2WSH, P2TR, etc.). - -#### Parameters - -##### address - -`string` - -#### Returns - -`Promise`\<[`AddressStats`](../interfaces/AddressStats.md)\> - -*** - -### getAddressTxs() - -> **getAddressTxs**(`address`, `after_txid?`, `limit?`): `Promise`\<`string`[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7458](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7458) - -Address transaction IDs - -Get transaction IDs for an address, newest first. Use after_txid for pagination. - -#### Parameters - -##### address - -`string` - -##### after\_txid? - -`string` - -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`[]\> - -*** - -### getAddressTxsChain() - -> **getAddressTxsChain**(`address`, `after_txid?`, `limit?`): `Promise`\<`string`[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7476](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7476) - -Address confirmed transactions - -Get confirmed transaction IDs for an address, 25 per page. Use ?after_txid= for pagination. - -#### Parameters - -##### address - -`string` - -##### after\_txid? - -`string` - -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`[]\> - -*** - -### getAddressTxsMempool() - -> **getAddressTxsMempool**(`address`): `Promise`\<`string`[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7494](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7494) - -Address mempool transactions - -Get unconfirmed transaction IDs for an address from the mempool (up to 50). - -#### Parameters - -##### address - -`string` - -#### Returns - -`Promise`\<`string`[]\> - -*** - -### getAddressUtxo() - -> **getAddressUtxo**(`address`): `Promise`\<[`Utxo`](../interfaces/Utxo.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7506](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7506) - -Address UTXOs - -Get unspent transaction outputs for an address. - -#### Parameters - -##### address - -`string` - -#### Returns - -`Promise`\<[`Utxo`](../interfaces/Utxo.md)[]\> - -*** - -### getBlockByHash() - -> **getBlockByHash**(`hash`): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7530](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7530) - -Block information - -Retrieve block information by block hash. Returns block metadata including height, timestamp, difficulty, size, weight, and transaction count. - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)\> - -*** - -### getBlockByHashRaw() - -> **getBlockByHashRaw**(`hash`): `Promise`\<`number`[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7542](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7542) - -Raw block - -Returns the raw block data in binary format. - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<`number`[]\> - -*** - -### getBlockByHashStatus() - -> **getBlockByHashStatus**(`hash`): `Promise`\<[`BlockStatus`](../interfaces/BlockStatus.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7554](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7554) - -Block status - -Retrieve the status of a block. Returns whether the block is in the best chain and, if so, its height and the hash of the next block. - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<[`BlockStatus`](../interfaces/BlockStatus.md)\> - -*** - -### getBlockByHashTxidByIndex() - -> **getBlockByHashTxidByIndex**(`hash`, `index`): `Promise`\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7567](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7567) - -Transaction ID at index - -Retrieve a single transaction ID at a specific index within a block. Returns plain text txid. - -#### Parameters - -##### hash - -`string` - -Bitcoin block hash - -##### index - -`number` - -Transaction index within the block (0-based) - -#### Returns - -`Promise`\<`string`\> - -*** - -### getBlockByHashTxids() - -> **getBlockByHashTxids**(`hash`): `Promise`\<`string`[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7579](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7579) - -Block transaction IDs - -Retrieve all transaction IDs in a block by block hash. - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<`string`[]\> - -*** - -### getBlockByHashTxsByStartIndex() - -> **getBlockByHashTxsByStartIndex**(`hash`, `start_index`): `Promise`\<[`Transaction`](../interfaces/Transaction.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7592](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7592) - -Block transactions (paginated) - -Retrieve transactions in a block by block hash, starting from the specified index. Returns up to 25 transactions at a time. - -#### Parameters - -##### hash - -`string` - -Bitcoin block hash - -##### start\_index - -`number` - -Starting transaction index within the block (0-based) - -#### Returns - -`Promise`\<[`Transaction`](../interfaces/Transaction.md)[]\> - -*** - -### getBlockHeight() - -> **getBlockHeight**(`height`): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7518](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7518) - -Block by height - -Retrieve block information by block height. Returns block metadata including hash, timestamp, difficulty, size, weight, and transaction count. - -#### Parameters - -##### height - -`number` - -#### Returns - -`Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)\> - -*** - -### getBlocks() - -> **getBlocks**(): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7602](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7602) - -Recent blocks - -Retrieve the last 10 blocks. Returns block metadata for each block. - -#### Returns - -`Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)[]\> - -*** - -### getBlocksByHeight() - -> **getBlocksByHeight**(`height`): `Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7614](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7614) - -Blocks from height - -Retrieve up to 10 blocks going backwards from the given height. For example, height=100 returns blocks 100, 99, 98, ..., 91. Height=0 returns only block 0. - -#### Parameters - -##### height - -`number` - -#### Returns - -`Promise`\<[`BlockInfo`](../interfaces/BlockInfo.md)[]\> - -*** - -### getHealth() - -> **getHealth**(): `Promise`\<[`Health`](../interfaces/Health.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:8008](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L8008) - -Health check - -Returns the health status of the API server - -#### Returns - -`Promise`\<[`Health`](../interfaces/Health.md)\> - -*** - -### getMempoolInfo() - -> **getMempoolInfo**(): `Promise`\<[`MempoolInfo`](../interfaces/MempoolInfo.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7624](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7624) +Defined in: [Developer/brk/modules/brk-client/index.js:6371](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6371) Mempool statistics Get current mempool statistics including transaction count, total vsize, and total fees. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool)* + +Endpoint: `GET /api/mempool/info` + #### Returns `Promise`\<[`MempoolInfo`](../interfaces/MempoolInfo.md)\> *** +### getMempoolBlocks() + +> **getMempoolBlocks**(): `Promise`\<[`MempoolBlock`](../interfaces/MempoolBlock.md)[]\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6665](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6665) + +Projected mempool blocks + +Get projected blocks from the mempool for fee estimation. Each block contains statistics about transactions that would be included if a block were mined now. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool-blocks-fees)* + +Endpoint: `GET /api/v1/fees/mempool-blocks` + +#### Returns + +`Promise`\<[`MempoolBlock`](../interfaces/MempoolBlock.md)[]\> + +*** + ### getMempoolTxids() > **getMempoolTxids**(): `Promise`\<`string`[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7634](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7634) +Defined in: [Developer/brk/modules/brk-client/index.js:6385](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6385) Mempool transaction IDs Get all transaction IDs currently in the mempool. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool-transaction-ids)* + +Endpoint: `GET /api/mempool/txids` + #### Returns `Promise`\<`string`[]\> @@ -474,13 +872,71 @@ Get all transaction IDs currently in the mempool. ### getMetric() -> **getMetric**(`metric`): `Promise`\<[`Index`](../type-aliases/Index.md)[]\> +> **getMetric**(`metric`, `index`, `start?`, `end?`, `limit?`, `format?`): `Promise`\<`string` \| [`AnyMetricData`](../type-aliases/AnyMetricData.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7646](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7646) +Defined in: [Developer/brk/modules/brk-client/index.js:6418](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6418) + +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:6399](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6399) Get supported indexes for a metric -Returns the list of indexes are supported by the specified metric. For example, `realized_price` might be available on dateindex, weekindex, and monthindex. +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 @@ -494,127 +950,59 @@ Returns the list of indexes are supported by the specified metric. For example, *** -### getMetricByIndex() +### getMetrics() -> **getMetricByIndex**(`index`, `metric`, `count?`, `format?`, `from?`, `to?`): `Promise`\<[`AnyMetricData`](../type-aliases/AnyMetricData.md)\> +> **getMetrics**(`metrics?`, `index?`, `start?`, `end?`, `limit?`, `format?`): `Promise`\<`string` \| [`AnyMetricData`](../type-aliases/AnyMetricData.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7663](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7663) - -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). - -#### Parameters - -##### index - -[`Index`](../type-aliases/Index.md) - -Aggregation index - -##### metric - -`string` - -Metric name - -##### count? - -`any` - -Number of values to return (ignored if `to` is set) - -##### format? - -[`Format`](../type-aliases/Format.md) - -Format of the output - -##### from? - -`any` - -Inclusive starting index, if negative counts from end - -##### to? - -`any` - -Exclusive ending index, if negative counts from end - -#### Returns - -`Promise`\<[`AnyMetricData`](../type-aliases/AnyMetricData.md)\> - -*** - -### getMetricsBulk() - -> **getMetricsBulk**(`count?`, `format?`, `from?`, `index?`, `metrics?`, `to?`): `Promise`\<[`AnyMetricData`](../type-aliases/AnyMetricData.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7688](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7688) +Defined in: [Developer/brk/modules/brk-client/index.js:6459](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6459) Bulk metric data -Fetch multiple metrics in a single request. Supports filtering by index and date range. Returns an array of MetricData objects. +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 -##### count? - -`any` - -Number of values to return (ignored if `to` is set) - -##### format? - -[`Format`](../type-aliases/Format.md) - -Format of the output - -##### from? - -`any` - -Inclusive starting index, if negative counts from end - -##### index? - -[`Index`](../type-aliases/Index.md) - -Index to query - ##### metrics? `string` Requested metrics -##### to? +##### index? -`any` +[`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 -#### Returns +##### limit? -`Promise`\<[`AnyMetricData`](../type-aliases/AnyMetricData.md)[]\> +`string` -*** +Maximum number of values to return (ignored if `end` is set) -### getMetricsCatalog() +##### format? -> **getMetricsCatalog**(): `Promise`\<[`TreeNode`](../type-aliases/TreeNode.md)\> +[`Format`](../type-aliases/Format.md) -Defined in: [Developer/brk/modules/brk-client/index.js:7706](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7706) - -Metrics catalog - -Returns the complete hierarchical catalog of available metrics organized as a tree structure. Metrics are grouped by categories and subcategories. Best viewed in an interactive JSON viewer (e.g., Firefox's built-in JSON viewer) for easy navigation of the nested structure. +Format of the output #### Returns -`Promise`\<[`TreeNode`](../type-aliases/TreeNode.md)\> +`Promise`\<`string` \| [`AnyMetricData`](../type-aliases/AnyMetricData.md)[]\> *** @@ -622,11 +1010,13 @@ Returns the complete hierarchical catalog of available metrics organized as a tr > **getMetricsCount**(): `Promise`\<[`MetricCount`](../interfaces/MetricCount.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7716](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7716) +Defined in: [Developer/brk/modules/brk-client/index.js:6483](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6483) Metric count -Current metric count +Returns the number of metrics available per index type. + +Endpoint: `GET /api/metrics/count` #### Returns @@ -634,81 +1024,199 @@ Current metric count *** -### getMetricsIndexes() +### getMetricsTree() -> **getMetricsIndexes**(): `Promise`\<[`IndexInfo`](../interfaces/IndexInfo.md)[]\> +> **getMetricsTree**(): `Promise`\<[`TreeNode`](../type-aliases/TreeNode.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7726](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7726) +Defined in: [Developer/brk/modules/brk-client/index.js:6440](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6440) -List available indexes +Metrics catalog -Returns all available indexes with their accepted query aliases. Use any alias when querying metrics. +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`\<[`IndexInfo`](../interfaces/IndexInfo.md)[]\> +`Promise`\<[`TreeNode`](../type-aliases/TreeNode.md)\> *** -### getMetricsList() +### getPool() -> **getMetricsList**(`page?`): `Promise`\<[`PaginatedMetrics`](../interfaces/PaginatedMetrics.md)\> +> **getPool**(`slug`): `Promise`\<[`PoolDetail`](../interfaces/PoolDetail.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7738](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7738) +Defined in: [Developer/brk/modules/brk-client/index.js:6835](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6835) -Metrics list +Mining pool details -Paginated list of available metrics +Get detailed information about a specific mining pool including block counts and shares for different time periods. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mining-pool)* + +Endpoint: `GET /api/v1/mining/pool/{slug}` #### Parameters -##### page? +##### slug -`any` - -Pagination index +[`PoolSlug`](../type-aliases/PoolSlug.md) #### Returns -`Promise`\<[`PaginatedMetrics`](../interfaces/PaginatedMetrics.md)\> +`Promise`\<[`PoolDetail`](../interfaces/PoolDetail.md)\> *** -### getMetricsSearchByMetric() +### getPools() -> **getMetricsSearchByMetric**(`metric`, `limit?`): `Promise`\<`string`[]\> +> **getPools**(): `Promise`\<[`PoolInfo`](../interfaces/PoolInfo.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7754](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7754) +Defined in: [Developer/brk/modules/brk-client/index.js:6849](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6849) -Search metrics +List all mining pools -Fuzzy search for metrics by name. Supports partial matches and typos. +Get list of all known mining pools with their identifiers. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mining-pools)* + +Endpoint: `GET /api/v1/mining/pools` + +#### Returns + +`Promise`\<[`PoolInfo`](../interfaces/PoolInfo.md)[]\> + +*** + +### getPoolStats() + +> **getPoolStats**(`time_period`): `Promise`\<[`PoolsSummary`](../interfaces/PoolsSummary.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6865](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6865) + +Mining pool statistics + +Get mining pool statistics for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mining-pools)* + +Endpoint: `GET /api/v1/mining/pools/{time_period}` #### Parameters -##### metric +##### time\_period -`string` +[`TimePeriod`](../type-aliases/TimePeriod.md) -##### limit? +#### Returns + +`Promise`\<[`PoolsSummary`](../interfaces/PoolsSummary.md)\> + +*** + +### getRecommendedFees() + +> **getRecommendedFees**(): `Promise`\<[`RecommendedFees`](../interfaces/RecommendedFees.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6679](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6679) + +Recommended fees + +Get recommended fee rates for different confirmation targets based on current mempool state. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-recommended-fees)* + +Endpoint: `GET /api/v1/fees/recommended` + +#### Returns + +`Promise`\<[`RecommendedFees`](../interfaces/RecommendedFees.md)\> + +*** + +### getRewardStats() + +> **getRewardStats**(`block_count`): `Promise`\<[`RewardStats`](../interfaces/RewardStats.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6881](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6881) + +Mining reward statistics + +Get mining reward statistics for the last N blocks including total rewards, fees, and transaction count. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-reward-stats)* + +Endpoint: `GET /api/v1/mining/reward-stats/{block_count}` + +#### Parameters + +##### block\_count `number` +Number of recent blocks to include + #### Returns -`Promise`\<`string`[]\> +`Promise`\<[`RewardStats`](../interfaces/RewardStats.md)\> *** -### getTxByTxid() +### getSyncStatus() -> **getTxByTxid**(`txid`): `Promise`\<[`Transaction`](../interfaces/Transaction.md)\> +> **getSyncStatus**(): `Promise`\<[`SyncStatus`](../interfaces/SyncStatus.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7769](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7769) +Defined in: [Developer/brk/modules/brk-client/index.js:6556](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6556) + +Sync status + +Returns the sync status of the indexer, including indexed height, tip height, blocks behind, and last indexed timestamp. + +Endpoint: `GET /api/server/sync` + +#### Returns + +`Promise`\<[`SyncStatus`](../interfaces/SyncStatus.md)\> + +*** + +### getText() + +> **getText**(`path`): `Promise`\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1038](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1038) + +Make a GET request and return raw text (for CSV responses) + +#### Parameters + +##### path + +`string` + +#### Returns + +`Promise`\<`string`\> + +#### Inherited from + +`BrkClientBase.getText` + +*** + +### getTx() + +> **getTx**(`txid`): `Promise`\<[`Transaction`](../interfaces/Transaction.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:6572](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6572) Transaction information -Retrieve complete transaction data by transaction ID (txid). Returns the full transaction details including inputs, outputs, and metadata. The transaction data is read directly from the blockchain data files. +Retrieve complete transaction data by transaction ID (txid). Returns inputs, outputs, fee, size, and confirmation status. + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction)* + +Endpoint: `GET /api/tx/{txid}` #### Parameters @@ -722,16 +1230,20 @@ Retrieve complete transaction data by transaction ID (txid). Returns the full tr *** -### getTxByTxidHex() +### getTxHex() -> **getTxByTxidHex**(`txid`): `Promise`\<`string`\> +> **getTxHex**(`txid`): `Promise`\<`string`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7781](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7781) +Defined in: [Developer/brk/modules/brk-client/index.js:6588](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6588) Transaction hex Retrieve the raw transaction as a hex-encoded string. Returns the serialized transaction in hexadecimal format. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-hex)* + +Endpoint: `GET /api/tx/{txid}/hex` + #### Parameters ##### txid @@ -744,16 +1256,20 @@ Retrieve the raw transaction as a hex-encoded string. Returns the serialized tra *** -### getTxByTxidOutspendByVout() +### getTxOutspend() -> **getTxByTxidOutspendByVout**(`txid`, `vout`): `Promise`\<[`TxOutspend`](../interfaces/TxOutspend.md)\> +> **getTxOutspend**(`txid`, `vout`): `Promise`\<[`TxOutspend`](../interfaces/TxOutspend.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7794](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7794) +Defined in: [Developer/brk/modules/brk-client/index.js:6605](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6605) Output spend status Get the spending status of a transaction output. Returns whether the output has been spent and, if so, the spending transaction details. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-outspend)* + +Endpoint: `GET /api/tx/{txid}/outspend/{vout}` + #### Parameters ##### txid @@ -774,16 +1290,20 @@ Output index *** -### getTxByTxidOutspends() +### getTxOutspends() -> **getTxByTxidOutspends**(`txid`): `Promise`\<[`TxOutspend`](../interfaces/TxOutspend.md)[]\> +> **getTxOutspends**(`txid`): `Promise`\<[`TxOutspend`](../interfaces/TxOutspend.md)[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7806](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7806) +Defined in: [Developer/brk/modules/brk-client/index.js:6621](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6621) All output spend statuses Get the spending status of all outputs in a transaction. Returns an array with the spend status for each output. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-outspends)* + +Endpoint: `GET /api/tx/{txid}/outspends` + #### Parameters ##### txid @@ -796,16 +1316,20 @@ Get the spending status of all outputs in a transaction. Returns an array with t *** -### getTxByTxidStatus() +### getTxStatus() -> **getTxByTxidStatus**(`txid`): `Promise`\<[`TxStatus`](../interfaces/TxStatus.md)\> +> **getTxStatus**(`txid`): `Promise`\<[`TxStatus`](../interfaces/TxStatus.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7818](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7818) +Defined in: [Developer/brk/modules/brk-client/index.js:6637](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6637) Transaction status Retrieve the confirmation status of a transaction. Returns whether the transaction is confirmed and, if so, the block height, hash, and timestamp. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-status)* + +Endpoint: `GET /api/tx/{txid}/status` + #### Parameters ##### txid @@ -818,312 +1342,123 @@ Retrieve the confirmation status of a transaction. Returns whether the transacti *** -### getV1DifficultyAdjustment() +### getVersion() -> **getV1DifficultyAdjustment**(): `Promise`\<[`DifficultyAdjustment`](../interfaces/DifficultyAdjustment.md)\> +> **getVersion**(): `Promise`\<`string`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7828](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7828) +Defined in: [Developer/brk/modules/brk-client/index.js:6921](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6921) -Difficulty adjustment +API version -Get current difficulty adjustment information including progress through the current epoch, estimated retarget date, and difficulty change prediction. +Returns the current version of the API server + +Endpoint: `GET /version` #### Returns -`Promise`\<[`DifficultyAdjustment`](../interfaces/DifficultyAdjustment.md)\> +`Promise`\<`string`\> *** -### getV1FeesMempoolBlocks() +### listMetrics() -> **getV1FeesMempoolBlocks**(): `Promise`\<[`MempoolBlock`](../interfaces/MempoolBlock.md)[]\> +> **listMetrics**(`page?`): `Promise`\<[`PaginatedMetrics`](../interfaces/PaginatedMetrics.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7838](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7838) +Defined in: [Developer/brk/modules/brk-client/index.js:6509](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6509) -Projected mempool blocks +Metrics list -Get projected blocks from the mempool for fee estimation. Each block contains statistics about transactions that would be included if a block were mined now. +Paginated flat list of all available metric names. Use `page` query param for pagination. -#### Returns - -`Promise`\<[`MempoolBlock`](../interfaces/MempoolBlock.md)[]\> - -*** - -### getV1FeesRecommended() - -> **getV1FeesRecommended**(): `Promise`\<[`RecommendedFees`](../interfaces/RecommendedFees.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7848](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7848) - -Recommended fees - -Get recommended fee rates for different confirmation targets based on current mempool state. - -#### Returns - -`Promise`\<[`RecommendedFees`](../interfaces/RecommendedFees.md)\> - -*** - -### getV1MiningBlocksFeesByTimePeriod() - -> **getV1MiningBlocksFeesByTimePeriod**(`time_period`): `Promise`\<[`BlockFeesEntry`](../interfaces/BlockFeesEntry.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7860](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7860) - -Block fees - -Get average block fees for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y +Endpoint: `GET /api/metrics/list` #### Parameters -##### time\_period +##### page? -[`TimePeriod`](../type-aliases/TimePeriod.md) +`number` + +Pagination index #### Returns -`Promise`\<[`BlockFeesEntry`](../interfaces/BlockFeesEntry.md)[]\> +`Promise`\<[`PaginatedMetrics`](../interfaces/PaginatedMetrics.md)\> *** -### getV1MiningBlocksRewardsByTimePeriod() +### metric() -> **getV1MiningBlocksRewardsByTimePeriod**(`time_period`): `Promise`\<[`BlockRewardsEntry`](../interfaces/BlockRewardsEntry.md)[]\> +> **metric**(`metric`, `index`): [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`unknown`\> -Defined in: [Developer/brk/modules/brk-client/index.js:7872](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7872) +Defined in: [Developer/brk/modules/brk-client/index.js:6119](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6119) -Block rewards +Create a dynamic metric endpoint builder for any metric/index combination. -Get average block rewards (coinbase = subsidy + fees) for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y +Use this for programmatic access when the metric name is determined at runtime. +For type-safe access, use the `metrics` tree instead. #### Parameters -##### time\_period +##### metric -[`TimePeriod`](../type-aliases/TimePeriod.md) +`string` + +The metric name + +##### index + +[`Index`](../type-aliases/Index.md) + +The index name #### Returns -`Promise`\<[`BlockRewardsEntry`](../interfaces/BlockRewardsEntry.md)[]\> +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`unknown`\> *** -### getV1MiningBlocksSizesWeightsByTimePeriod() +### searchMetrics() -> **getV1MiningBlocksSizesWeightsByTimePeriod**(`time_period`): `Promise`\<[`BlockSizesWeights`](../interfaces/BlockSizesWeights.md)\> +> **searchMetrics**(`metric`, `limit?`): `Promise`\<`string`[]\> -Defined in: [Developer/brk/modules/brk-client/index.js:7884](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7884) +Defined in: [Developer/brk/modules/brk-client/index.js:6528](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6528) -Block sizes and weights +Search metrics -Get average block sizes and weights for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y +Fuzzy search for metrics by name. Supports partial matches and typos. + +Endpoint: `GET /api/metrics/search/{metric}` #### Parameters -##### time\_period +##### metric -[`TimePeriod`](../type-aliases/TimePeriod.md) +`string` -#### Returns - -`Promise`\<[`BlockSizesWeights`](../interfaces/BlockSizesWeights.md)\> - -*** - -### getV1MiningBlocksTimestamp() - -> **getV1MiningBlocksTimestamp**(`timestamp`): `Promise`\<[`BlockTimestamp`](../interfaces/BlockTimestamp.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7896](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7896) - -Block by timestamp - -Find the block closest to a given UNIX timestamp. - -#### Parameters - -##### timestamp +##### limit? `number` #### Returns -`Promise`\<[`BlockTimestamp`](../interfaces/BlockTimestamp.md)\> +`Promise`\<`string`[]\> *** -### getV1MiningDifficultyAdjustments() +### validateAddress() -> **getV1MiningDifficultyAdjustments**(): `Promise`\<[`DifficultyAdjustmentEntry`](../interfaces/DifficultyAdjustmentEntry.md)[]\> +> **validateAddress**(`address`): `Promise`\<[`AddressValidation`](../interfaces/AddressValidation.md)\> -Defined in: [Developer/brk/modules/brk-client/index.js:7906](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7906) - -Difficulty adjustments (all time) - -Get historical difficulty adjustments. Returns array of [timestamp, height, difficulty, change_percent]. - -#### Returns - -`Promise`\<[`DifficultyAdjustmentEntry`](../interfaces/DifficultyAdjustmentEntry.md)[]\> - -*** - -### getV1MiningDifficultyAdjustmentsByTimePeriod() - -> **getV1MiningDifficultyAdjustmentsByTimePeriod**(`time_period`): `Promise`\<[`DifficultyAdjustmentEntry`](../interfaces/DifficultyAdjustmentEntry.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7918](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7918) - -Difficulty adjustments - -Get historical difficulty adjustments for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y. Returns array of [timestamp, height, difficulty, change_percent]. - -#### Parameters - -##### time\_period - -[`TimePeriod`](../type-aliases/TimePeriod.md) - -#### Returns - -`Promise`\<[`DifficultyAdjustmentEntry`](../interfaces/DifficultyAdjustmentEntry.md)[]\> - -*** - -### getV1MiningHashrate() - -> **getV1MiningHashrate**(): `Promise`\<[`HashrateSummary`](../interfaces/HashrateSummary.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7928](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7928) - -Network hashrate (all time) - -Get network hashrate and difficulty data for all time. - -#### Returns - -`Promise`\<[`HashrateSummary`](../interfaces/HashrateSummary.md)\> - -*** - -### getV1MiningHashrateByTimePeriod() - -> **getV1MiningHashrateByTimePeriod**(`time_period`): `Promise`\<[`HashrateSummary`](../interfaces/HashrateSummary.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7940](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7940) - -Network hashrate - -Get network hashrate and difficulty data for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y - -#### Parameters - -##### time\_period - -[`TimePeriod`](../type-aliases/TimePeriod.md) - -#### Returns - -`Promise`\<[`HashrateSummary`](../interfaces/HashrateSummary.md)\> - -*** - -### getV1MiningPoolBySlug() - -> **getV1MiningPoolBySlug**(`slug`): `Promise`\<[`PoolDetail`](../interfaces/PoolDetail.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7952](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7952) - -Mining pool details - -Get detailed information about a specific mining pool including block counts and shares for different time periods. - -#### Parameters - -##### slug - -[`PoolSlug`](../type-aliases/PoolSlug.md) - -#### Returns - -`Promise`\<[`PoolDetail`](../interfaces/PoolDetail.md)\> - -*** - -### getV1MiningPools() - -> **getV1MiningPools**(): `Promise`\<[`PoolInfo`](../interfaces/PoolInfo.md)[]\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7962](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7962) - -List all mining pools - -Get list of all known mining pools with their identifiers. - -#### Returns - -`Promise`\<[`PoolInfo`](../interfaces/PoolInfo.md)[]\> - -*** - -### getV1MiningPoolsByTimePeriod() - -> **getV1MiningPoolsByTimePeriod**(`time_period`): `Promise`\<[`PoolsSummary`](../interfaces/PoolsSummary.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7974](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7974) - -Mining pool statistics - -Get mining pool statistics for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y - -#### Parameters - -##### time\_period - -[`TimePeriod`](../type-aliases/TimePeriod.md) - -#### Returns - -`Promise`\<[`PoolsSummary`](../interfaces/PoolsSummary.md)\> - -*** - -### getV1MiningRewardStatsByBlockCount() - -> **getV1MiningRewardStatsByBlockCount**(`block_count`): `Promise`\<[`RewardStats`](../interfaces/RewardStats.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7986](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7986) - -Mining reward statistics - -Get mining reward statistics for the last N blocks including total rewards, fees, and transaction count. - -#### Parameters - -##### block\_count - -`number` - -Number of recent blocks to include - -#### Returns - -`Promise`\<[`RewardStats`](../interfaces/RewardStats.md)\> - -*** - -### getV1ValidateAddress() - -> **getV1ValidateAddress**(`address`): `Promise`\<[`AddressValidation`](../interfaces/AddressValidation.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:7998](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L7998) +Defined in: [Developer/brk/modules/brk-client/index.js:6897](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L6897) Validate address Validate a Bitcoin address and get information about its type and scriptPubKey. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-validate)* + +Endpoint: `GET /api/v1/validate-address/{address}` + #### Parameters ##### address @@ -1135,19 +1470,3 @@ Bitcoin address to validate (can be any string) #### Returns `Promise`\<[`AddressValidation`](../interfaces/AddressValidation.md)\> - -*** - -### getVersion() - -> **getVersion**(): `Promise`\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:8018](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L8018) - -API version - -Returns the current version of the API server - -#### Returns - -`Promise`\<`string`\> diff --git a/modules/brk-client/docs/classes/BrkError.md b/modules/brk-client/docs/classes/BrkError.md index 674a93847..88ff0afc2 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:532](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L532) +Defined in: [Developer/brk/modules/brk-client/index.js:817](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L817) 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:537](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L537) +Defined in: [Developer/brk/modules/brk-client/index.js:822](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L822) #### Parameters diff --git a/modules/brk-client/docs/globals.md b/modules/brk-client/docs/globals.md index baa19dd7f..0855f1c30 100644 --- a/modules/brk-client/docs/globals.md +++ b/modules/brk-client/docs/globals.md @@ -30,6 +30,7 @@ - [AddressTxidsParam](interfaces/AddressTxidsParam.md) - [AddressValidation](interfaces/AddressValidation.md) - [BitcoinPattern](interfaces/BitcoinPattern.md) +- [BitcoinPattern2](interfaces/BitcoinPattern2.md) - [BlockCountParam](interfaces/BlockCountParam.md) - [BlockCountPattern](interfaces/BlockCountPattern.md) - [BlockFeesEntry](interfaces/BlockFeesEntry.md) @@ -44,122 +45,6 @@ - [BlockTimestamp](interfaces/BlockTimestamp.md) - [BlockWeightEntry](interfaces/BlockWeightEntry.md) - [BrkClientOptions](interfaces/BrkClientOptions.md) -- [CatalogTree](interfaces/CatalogTree.md) -- [CatalogTree\_Addresses](interfaces/CatalogTree_Addresses.md) -- [CatalogTree\_Blocks](interfaces/CatalogTree_Blocks.md) -- [CatalogTree\_Blocks\_Count](interfaces/CatalogTree_Blocks_Count.md) -- [CatalogTree\_Blocks\_Difficulty](interfaces/CatalogTree_Blocks_Difficulty.md) -- [CatalogTree\_Blocks\_Halving](interfaces/CatalogTree_Blocks_Halving.md) -- [CatalogTree\_Blocks\_Interval](interfaces/CatalogTree_Blocks_Interval.md) -- [CatalogTree\_Blocks\_Mining](interfaces/CatalogTree_Blocks_Mining.md) -- [CatalogTree\_Blocks\_Rewards](interfaces/CatalogTree_Blocks_Rewards.md) -- [CatalogTree\_Blocks\_Rewards\_24hCoinbaseSum](interfaces/CatalogTree_Blocks_Rewards_24hCoinbaseSum.md) -- [CatalogTree\_Blocks\_Size](interfaces/CatalogTree_Blocks_Size.md) -- [CatalogTree\_Blocks\_Time](interfaces/CatalogTree_Blocks_Time.md) -- [CatalogTree\_Cointime](interfaces/CatalogTree_Cointime.md) -- [CatalogTree\_Cointime\_Activity](interfaces/CatalogTree_Cointime_Activity.md) -- [CatalogTree\_Cointime\_Adjusted](interfaces/CatalogTree_Cointime_Adjusted.md) -- [CatalogTree\_Cointime\_Cap](interfaces/CatalogTree_Cointime_Cap.md) -- [CatalogTree\_Cointime\_Pricing](interfaces/CatalogTree_Cointime_Pricing.md) -- [CatalogTree\_Cointime\_Supply](interfaces/CatalogTree_Cointime_Supply.md) -- [CatalogTree\_Cointime\_Value](interfaces/CatalogTree_Cointime_Value.md) -- [CatalogTree\_Constants](interfaces/CatalogTree_Constants.md) -- [CatalogTree\_Distribution](interfaces/CatalogTree_Distribution.md) -- [CatalogTree\_Distribution\_AddrCount](interfaces/CatalogTree_Distribution_AddrCount.md) -- [CatalogTree\_Distribution\_AddressCohorts](interfaces/CatalogTree_Distribution_AddressCohorts.md) -- [CatalogTree\_Distribution\_AddressCohorts\_AmountRange](interfaces/CatalogTree_Distribution_AddressCohorts_AmountRange.md) -- [CatalogTree\_Distribution\_AddressCohorts\_GeAmount](interfaces/CatalogTree_Distribution_AddressCohorts_GeAmount.md) -- [CatalogTree\_Distribution\_AddressCohorts\_LtAmount](interfaces/CatalogTree_Distribution_AddressCohorts_LtAmount.md) -- [CatalogTree\_Distribution\_AddressesData](interfaces/CatalogTree_Distribution_AddressesData.md) -- [CatalogTree\_Distribution\_AnyAddressIndexes](interfaces/CatalogTree_Distribution_AnyAddressIndexes.md) -- [CatalogTree\_Distribution\_EmptyAddrCount](interfaces/CatalogTree_Distribution_EmptyAddrCount.md) -- [CatalogTree\_Distribution\_UtxoCohorts](interfaces/CatalogTree_Distribution_UtxoCohorts.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_AgeRange](interfaces/CatalogTree_Distribution_UtxoCohorts_AgeRange.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_All](interfaces/CatalogTree_Distribution_UtxoCohorts_All.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_All\_CostBasis](interfaces/CatalogTree_Distribution_UtxoCohorts_All_CostBasis.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_All\_Relative](interfaces/CatalogTree_Distribution_UtxoCohorts_All_Relative.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_AmountRange](interfaces/CatalogTree_Distribution_UtxoCohorts_AmountRange.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_Epoch](interfaces/CatalogTree_Distribution_UtxoCohorts_Epoch.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_GeAmount](interfaces/CatalogTree_Distribution_UtxoCohorts_GeAmount.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_LtAmount](interfaces/CatalogTree_Distribution_UtxoCohorts_LtAmount.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_MaxAge](interfaces/CatalogTree_Distribution_UtxoCohorts_MaxAge.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_MinAge](interfaces/CatalogTree_Distribution_UtxoCohorts_MinAge.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_Term](interfaces/CatalogTree_Distribution_UtxoCohorts_Term.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_Term\_Long](interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Long.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_Term\_Long\_CostBasis](interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Long_CostBasis.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_Term\_Short](interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Short.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_Term\_Short\_CostBasis](interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Short_CostBasis.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_Type](interfaces/CatalogTree_Distribution_UtxoCohorts_Type.md) -- [CatalogTree\_Distribution\_UtxoCohorts\_Year](interfaces/CatalogTree_Distribution_UtxoCohorts_Year.md) -- [CatalogTree\_Indexes](interfaces/CatalogTree_Indexes.md) -- [CatalogTree\_Indexes\_Address](interfaces/CatalogTree_Indexes_Address.md) -- [CatalogTree\_Indexes\_Address\_Empty](interfaces/CatalogTree_Indexes_Address_Empty.md) -- [CatalogTree\_Indexes\_Address\_Opreturn](interfaces/CatalogTree_Indexes_Address_Opreturn.md) -- [CatalogTree\_Indexes\_Address\_P2a](interfaces/CatalogTree_Indexes_Address_P2a.md) -- [CatalogTree\_Indexes\_Address\_P2ms](interfaces/CatalogTree_Indexes_Address_P2ms.md) -- [CatalogTree\_Indexes\_Address\_P2pk33](interfaces/CatalogTree_Indexes_Address_P2pk33.md) -- [CatalogTree\_Indexes\_Address\_P2pk65](interfaces/CatalogTree_Indexes_Address_P2pk65.md) -- [CatalogTree\_Indexes\_Address\_P2pkh](interfaces/CatalogTree_Indexes_Address_P2pkh.md) -- [CatalogTree\_Indexes\_Address\_P2sh](interfaces/CatalogTree_Indexes_Address_P2sh.md) -- [CatalogTree\_Indexes\_Address\_P2tr](interfaces/CatalogTree_Indexes_Address_P2tr.md) -- [CatalogTree\_Indexes\_Address\_P2wpkh](interfaces/CatalogTree_Indexes_Address_P2wpkh.md) -- [CatalogTree\_Indexes\_Address\_P2wsh](interfaces/CatalogTree_Indexes_Address_P2wsh.md) -- [CatalogTree\_Indexes\_Address\_Unknown](interfaces/CatalogTree_Indexes_Address_Unknown.md) -- [CatalogTree\_Indexes\_Dateindex](interfaces/CatalogTree_Indexes_Dateindex.md) -- [CatalogTree\_Indexes\_Decadeindex](interfaces/CatalogTree_Indexes_Decadeindex.md) -- [CatalogTree\_Indexes\_Difficultyepoch](interfaces/CatalogTree_Indexes_Difficultyepoch.md) -- [CatalogTree\_Indexes\_Halvingepoch](interfaces/CatalogTree_Indexes_Halvingepoch.md) -- [CatalogTree\_Indexes\_Height](interfaces/CatalogTree_Indexes_Height.md) -- [CatalogTree\_Indexes\_Monthindex](interfaces/CatalogTree_Indexes_Monthindex.md) -- [CatalogTree\_Indexes\_Quarterindex](interfaces/CatalogTree_Indexes_Quarterindex.md) -- [CatalogTree\_Indexes\_Semesterindex](interfaces/CatalogTree_Indexes_Semesterindex.md) -- [CatalogTree\_Indexes\_Txindex](interfaces/CatalogTree_Indexes_Txindex.md) -- [CatalogTree\_Indexes\_Txinindex](interfaces/CatalogTree_Indexes_Txinindex.md) -- [CatalogTree\_Indexes\_Txoutindex](interfaces/CatalogTree_Indexes_Txoutindex.md) -- [CatalogTree\_Indexes\_Weekindex](interfaces/CatalogTree_Indexes_Weekindex.md) -- [CatalogTree\_Indexes\_Yearindex](interfaces/CatalogTree_Indexes_Yearindex.md) -- [CatalogTree\_Inputs](interfaces/CatalogTree_Inputs.md) -- [CatalogTree\_Inputs\_Spent](interfaces/CatalogTree_Inputs_Spent.md) -- [CatalogTree\_Market](interfaces/CatalogTree_Market.md) -- [CatalogTree\_Market\_Ath](interfaces/CatalogTree_Market_Ath.md) -- [CatalogTree\_Market\_Dca](interfaces/CatalogTree_Market_Dca.md) -- [CatalogTree\_Market\_Dca\_ClassAveragePrice](interfaces/CatalogTree_Market_Dca_ClassAveragePrice.md) -- [CatalogTree\_Market\_Dca\_ClassReturns](interfaces/CatalogTree_Market_Dca_ClassReturns.md) -- [CatalogTree\_Market\_Dca\_ClassStack](interfaces/CatalogTree_Market_Dca_ClassStack.md) -- [CatalogTree\_Market\_Indicators](interfaces/CatalogTree_Market_Indicators.md) -- [CatalogTree\_Market\_Lookback](interfaces/CatalogTree_Market_Lookback.md) -- [CatalogTree\_Market\_Lookback\_PriceAgo](interfaces/CatalogTree_Market_Lookback_PriceAgo.md) -- [CatalogTree\_Market\_MovingAverage](interfaces/CatalogTree_Market_MovingAverage.md) -- [CatalogTree\_Market\_Range](interfaces/CatalogTree_Market_Range.md) -- [CatalogTree\_Market\_Returns](interfaces/CatalogTree_Market_Returns.md) -- [CatalogTree\_Market\_Returns\_PriceReturns](interfaces/CatalogTree_Market_Returns_PriceReturns.md) -- [CatalogTree\_Market\_Volatility](interfaces/CatalogTree_Market_Volatility.md) -- [CatalogTree\_Outputs](interfaces/CatalogTree_Outputs.md) -- [CatalogTree\_Outputs\_Count](interfaces/CatalogTree_Outputs_Count.md) -- [CatalogTree\_Outputs\_Spent](interfaces/CatalogTree_Outputs_Spent.md) -- [CatalogTree\_Pools](interfaces/CatalogTree_Pools.md) -- [CatalogTree\_Pools\_Vecs](interfaces/CatalogTree_Pools_Vecs.md) -- [CatalogTree\_Positions](interfaces/CatalogTree_Positions.md) -- [CatalogTree\_Price](interfaces/CatalogTree_Price.md) -- [CatalogTree\_Price\_Cents](interfaces/CatalogTree_Price_Cents.md) -- [CatalogTree\_Price\_Cents\_Split](interfaces/CatalogTree_Price_Cents_Split.md) -- [CatalogTree\_Price\_Sats](interfaces/CatalogTree_Price_Sats.md) -- [CatalogTree\_Price\_Usd](interfaces/CatalogTree_Price_Usd.md) -- [CatalogTree\_Scripts](interfaces/CatalogTree_Scripts.md) -- [CatalogTree\_Scripts\_Count](interfaces/CatalogTree_Scripts_Count.md) -- [CatalogTree\_Scripts\_Value](interfaces/CatalogTree_Scripts_Value.md) -- [CatalogTree\_Supply](interfaces/CatalogTree_Supply.md) -- [CatalogTree\_Supply\_Burned](interfaces/CatalogTree_Supply_Burned.md) -- [CatalogTree\_Supply\_Circulating](interfaces/CatalogTree_Supply_Circulating.md) -- [CatalogTree\_Supply\_Velocity](interfaces/CatalogTree_Supply_Velocity.md) -- [CatalogTree\_Transactions](interfaces/CatalogTree_Transactions.md) -- [CatalogTree\_Transactions\_Count](interfaces/CatalogTree_Transactions_Count.md) -- [CatalogTree\_Transactions\_Fees](interfaces/CatalogTree_Transactions_Fees.md) -- [CatalogTree\_Transactions\_Fees\_Fee](interfaces/CatalogTree_Transactions_Fees_Fee.md) -- [CatalogTree\_Transactions\_Fees\_Fee\_Dollars](interfaces/CatalogTree_Transactions_Fees_Fee_Dollars.md) -- [CatalogTree\_Transactions\_Size](interfaces/CatalogTree_Transactions_Size.md) -- [CatalogTree\_Transactions\_Versions](interfaces/CatalogTree_Transactions_Versions.md) -- [CatalogTree\_Transactions\_Volume](interfaces/CatalogTree_Transactions_Volume.md) - [ClassAveragePricePattern](interfaces/ClassAveragePricePattern.md) - [CoinbasePattern](interfaces/CoinbasePattern.md) - [CoinbasePattern2](interfaces/CoinbasePattern2.md) @@ -170,6 +55,7 @@ - [DifficultyAdjustment](interfaces/DifficultyAdjustment.md) - [DifficultyAdjustmentEntry](interfaces/DifficultyAdjustmentEntry.md) - [DifficultyEntry](interfaces/DifficultyEntry.md) +- [DiskUsage](interfaces/DiskUsage.md) - [DollarsPattern](interfaces/DollarsPattern.md) - [EmptyAddressData](interfaces/EmptyAddressData.md) - [FeeRatePattern](interfaces/FeeRatePattern.md) @@ -181,16 +67,125 @@ - [IndexInfo](interfaces/IndexInfo.md) - [LimitParam](interfaces/LimitParam.md) - [LoadedAddressData](interfaces/LoadedAddressData.md) +- [LookbackPattern](interfaces/LookbackPattern.md) - [MempoolBlock](interfaces/MempoolBlock.md) - [MempoolInfo](interfaces/MempoolInfo.md) - [MetricCount](interfaces/MetricCount.md) - [MetricData](interfaces/MetricData.md) -- [MetricEndpoint](interfaces/MetricEndpoint.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\_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\_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\_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\_CostBasis](interfaces/MetricsTree_Distribution_UtxoCohorts_All_CostBasis.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\_ClassStack](interfaces/MetricsTree_Market_Dca_ClassStack.md) +- [MetricsTree\_Market\_Indicators](interfaces/MetricsTree_Market_Indicators.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\_Fees\_Fee\_Dollars](interfaces/MetricsTree_Transactions_Fees_Fee_Dollars.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) - [OHLCCents](interfaces/OHLCCents.md) - [OHLCDollars](interfaces/OHLCDollars.md) @@ -211,7 +206,7 @@ - [PoolsSummary](interfaces/PoolsSummary.md) - [PoolStats](interfaces/PoolStats.md) - [Price111dSmaPattern](interfaces/Price111dSmaPattern.md) -- [PriceAgoPattern](interfaces/PriceAgoPattern.md) +- [RangeBuilder](interfaces/RangeBuilder.md) - [Ratio1ySdPattern](interfaces/Ratio1ySdPattern.md) - [RealizedPattern](interfaces/RealizedPattern.md) - [RealizedPattern2](interfaces/RealizedPattern2.md) @@ -226,9 +221,12 @@ - [RewardStats](interfaces/RewardStats.md) - [SatsPattern](interfaces/SatsPattern.md) - [SegwitAdoptionPattern](interfaces/SegwitAdoptionPattern.md) +- [SingleItemBuilder](interfaces/SingleItemBuilder.md) +- [SkippedBuilder](interfaces/SkippedBuilder.md) - [SplitPattern2](interfaces/SplitPattern2.md) - [SupplyPattern2](interfaces/SupplyPattern2.md) - [SupplyState](interfaces/SupplyState.md) +- [SyncStatus](interfaces/SyncStatus.md) - [TimePeriodParam](interfaces/TimePeriodParam.md) - [TimestampParam](interfaces/TimestampParam.md) - [Transaction](interfaces/Transaction.md) @@ -248,7 +246,7 @@ - [Address](type-aliases/Address.md) - [AnyAddressIndex](type-aliases/AnyAddressIndex.md) - [AnyMetricData](type-aliases/AnyMetricData.md) -- [AnyMetricEndpoint](type-aliases/AnyMetricEndpoint.md) +- [AnyMetricEndpointBuilder](type-aliases/AnyMetricEndpointBuilder.md) - [AnyMetricPattern](type-aliases/AnyMetricPattern.md) - [Bitcoin](type-aliases/Bitcoin.md) - [BlkPosition](type-aliases/BlkPosition.md) @@ -340,6 +338,7 @@ - [StoredU16](type-aliases/StoredU16.md) - [StoredU32](type-aliases/StoredU32.md) - [StoredU64](type-aliases/StoredU64.md) +- [Thenable](type-aliases/Thenable.md) - [TimePeriod](type-aliases/TimePeriod.md) - [Timestamp](type-aliases/Timestamp.md) - [TreeNode](type-aliases/TreeNode.md) diff --git a/modules/brk-client/docs/interfaces/0satsPattern.md b/modules/brk-client/docs/interfaces/0satsPattern.md index 9e9c8a127..5eeed9493 100644 --- a/modules/brk-client/docs/interfaces/0satsPattern.md +++ b/modules/brk-client/docs/interfaces/0satsPattern.md @@ -6,7 +6,7 @@ # Interface: \_0satsPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3111](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3111) +Defined in: [Developer/brk/modules/brk-client/index.js:2283](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2283) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3111](https://github.com/ > **activity**: [`ActivityPattern2`](ActivityPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3112](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3112) +Defined in: [Developer/brk/modules/brk-client/index.js:2284](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2284) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3112](https://github.com/ > **addrCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3113](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3113) +Defined in: [Developer/brk/modules/brk-client/index.js:2285](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2285) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3113](https://github.com/ > **costBasis**: [`CostBasisPattern`](CostBasisPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3114](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3114) +Defined in: [Developer/brk/modules/brk-client/index.js:2286](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2286) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3114](https://github.com/ > **outputs**: [`OutputsPattern`](OutputsPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3115](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3115) +Defined in: [Developer/brk/modules/brk-client/index.js:2287](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2287) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3115](https://github.com/ > **realized**: [`RealizedPattern`](RealizedPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3116](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3116) +Defined in: [Developer/brk/modules/brk-client/index.js:2288](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2288) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3116](https://github.com/ > **relative**: [`RelativePattern`](RelativePattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3117](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3117) +Defined in: [Developer/brk/modules/brk-client/index.js:2289](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2289) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3117](https://github.com/ > **supply**: [`SupplyPattern2`](SupplyPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3118](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3118) +Defined in: [Developer/brk/modules/brk-client/index.js:2290](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2290) *** @@ -70,4 +70,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3118](https://github.com/ > **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3119](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3119) +Defined in: [Developer/brk/modules/brk-client/index.js:2291](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2291) diff --git a/modules/brk-client/docs/interfaces/0satsPattern2.md b/modules/brk-client/docs/interfaces/0satsPattern2.md index 6f466cf3c..729057ab1 100644 --- a/modules/brk-client/docs/interfaces/0satsPattern2.md +++ b/modules/brk-client/docs/interfaces/0satsPattern2.md @@ -6,7 +6,7 @@ # Interface: \_0satsPattern2 -Defined in: [Developer/brk/modules/brk-client/index.js:3273](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3273) +Defined in: [Developer/brk/modules/brk-client/index.js:2430](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2430) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3273](https://github.com/ > **activity**: [`ActivityPattern2`](ActivityPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3274](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3274) +Defined in: [Developer/brk/modules/brk-client/index.js:2431](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2431) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3274](https://github.com/ > **costBasis**: [`CostBasisPattern`](CostBasisPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3275](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3275) +Defined in: [Developer/brk/modules/brk-client/index.js:2432](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2432) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3275](https://github.com/ > **outputs**: [`OutputsPattern`](OutputsPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3276](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3276) +Defined in: [Developer/brk/modules/brk-client/index.js:2433](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2433) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3276](https://github.com/ > **realized**: [`RealizedPattern`](RealizedPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3277](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3277) +Defined in: [Developer/brk/modules/brk-client/index.js:2434](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2434) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3277](https://github.com/ > **relative**: [`RelativePattern4`](RelativePattern4.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3278](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3278) +Defined in: [Developer/brk/modules/brk-client/index.js:2435](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2435) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3278](https://github.com/ > **supply**: [`SupplyPattern2`](SupplyPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3279](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3279) +Defined in: [Developer/brk/modules/brk-client/index.js:2436](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2436) *** @@ -62,4 +62,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3279](https://github.com/ > **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3280](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3280) +Defined in: [Developer/brk/modules/brk-client/index.js:2437](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2437) diff --git a/modules/brk-client/docs/interfaces/100btcPattern.md b/modules/brk-client/docs/interfaces/100btcPattern.md index bb4d466a9..d5b4a5fe3 100644 --- a/modules/brk-client/docs/interfaces/100btcPattern.md +++ b/modules/brk-client/docs/interfaces/100btcPattern.md @@ -6,7 +6,7 @@ # Interface: \_100btcPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3215](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3215) +Defined in: [Developer/brk/modules/brk-client/index.js:2314](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2314) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3215](https://github.com/ > **activity**: [`ActivityPattern2`](ActivityPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3216](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3216) +Defined in: [Developer/brk/modules/brk-client/index.js:2315](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2315) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3216](https://github.com/ > **costBasis**: [`CostBasisPattern`](CostBasisPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3217](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3217) +Defined in: [Developer/brk/modules/brk-client/index.js:2316](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2316) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3217](https://github.com/ > **outputs**: [`OutputsPattern`](OutputsPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3218](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3218) +Defined in: [Developer/brk/modules/brk-client/index.js:2317](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2317) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3218](https://github.com/ > **realized**: [`RealizedPattern`](RealizedPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3219](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3219) +Defined in: [Developer/brk/modules/brk-client/index.js:2318](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2318) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3219](https://github.com/ > **relative**: [`RelativePattern`](RelativePattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3220](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3220) +Defined in: [Developer/brk/modules/brk-client/index.js:2319](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2319) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3220](https://github.com/ > **supply**: [`SupplyPattern2`](SupplyPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3221](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3221) +Defined in: [Developer/brk/modules/brk-client/index.js:2320](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2320) *** @@ -62,4 +62,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3221](https://github.com/ > **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3222](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3222) +Defined in: [Developer/brk/modules/brk-client/index.js:2321](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2321) diff --git a/modules/brk-client/docs/interfaces/10yPattern.md b/modules/brk-client/docs/interfaces/10yPattern.md index 7297a61ca..69137f360 100644 --- a/modules/brk-client/docs/interfaces/10yPattern.md +++ b/modules/brk-client/docs/interfaces/10yPattern.md @@ -6,7 +6,7 @@ # Interface: \_10yPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3302](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3302) +Defined in: [Developer/brk/modules/brk-client/index.js:2459](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2459) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3302](https://github.com/ > **activity**: [`ActivityPattern2`](ActivityPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3303](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3303) +Defined in: [Developer/brk/modules/brk-client/index.js:2460](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2460) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3303](https://github.com/ > **costBasis**: [`CostBasisPattern`](CostBasisPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3304](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3304) +Defined in: [Developer/brk/modules/brk-client/index.js:2461](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2461) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3304](https://github.com/ > **outputs**: [`OutputsPattern`](OutputsPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3305](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3305) +Defined in: [Developer/brk/modules/brk-client/index.js:2462](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2462) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3305](https://github.com/ > **realized**: [`RealizedPattern4`](RealizedPattern4.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3306](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3306) +Defined in: [Developer/brk/modules/brk-client/index.js:2463](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2463) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3306](https://github.com/ > **relative**: [`RelativePattern`](RelativePattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3307](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3307) +Defined in: [Developer/brk/modules/brk-client/index.js:2464](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2464) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3307](https://github.com/ > **supply**: [`SupplyPattern2`](SupplyPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3308](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3308) +Defined in: [Developer/brk/modules/brk-client/index.js:2465](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2465) *** @@ -62,4 +62,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3308](https://github.com/ > **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3309](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3309) +Defined in: [Developer/brk/modules/brk-client/index.js:2466](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2466) diff --git a/modules/brk-client/docs/interfaces/10yTo12yPattern.md b/modules/brk-client/docs/interfaces/10yTo12yPattern.md index 7dd7ec073..0617ad6c4 100644 --- a/modules/brk-client/docs/interfaces/10yTo12yPattern.md +++ b/modules/brk-client/docs/interfaces/10yTo12yPattern.md @@ -6,7 +6,7 @@ # Interface: \_10yTo12yPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3186](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3186) +Defined in: [Developer/brk/modules/brk-client/index.js:2401](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2401) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3186](https://github.com/ > **activity**: [`ActivityPattern2`](ActivityPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3187](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3187) +Defined in: [Developer/brk/modules/brk-client/index.js:2402](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2402) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3187](https://github.com/ > **costBasis**: [`CostBasisPattern2`](CostBasisPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3188](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3188) +Defined in: [Developer/brk/modules/brk-client/index.js:2403](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2403) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3188](https://github.com/ > **outputs**: [`OutputsPattern`](OutputsPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3189](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3189) +Defined in: [Developer/brk/modules/brk-client/index.js:2404](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2404) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3189](https://github.com/ > **realized**: [`RealizedPattern2`](RealizedPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3190](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3190) +Defined in: [Developer/brk/modules/brk-client/index.js:2405](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2405) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3190](https://github.com/ > **relative**: [`RelativePattern2`](RelativePattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3191](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3191) +Defined in: [Developer/brk/modules/brk-client/index.js:2406](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2406) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3191](https://github.com/ > **supply**: [`SupplyPattern2`](SupplyPattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3192](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3192) +Defined in: [Developer/brk/modules/brk-client/index.js:2407](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2407) *** @@ -62,4 +62,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3192](https://github.com/ > **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3193](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3193) +Defined in: [Developer/brk/modules/brk-client/index.js:2408](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2408) diff --git a/modules/brk-client/docs/interfaces/1dReturns1mSdPattern.md b/modules/brk-client/docs/interfaces/1dReturns1mSdPattern.md index 95cabafeb..eb87629a4 100644 --- a/modules/brk-client/docs/interfaces/1dReturns1mSdPattern.md +++ b/modules/brk-client/docs/interfaces/1dReturns1mSdPattern.md @@ -6,7 +6,7 @@ # Interface: \_1dReturns1mSdPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3603](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3603) +Defined in: [Developer/brk/modules/brk-client/index.js:2742](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2742) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3603](https://github.com/ > **sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3604](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3604) +Defined in: [Developer/brk/modules/brk-client/index.js:2743](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2743) *** @@ -22,4 +22,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3604](https://github.com/ > **sma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3605](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3605) +Defined in: [Developer/brk/modules/brk-client/index.js:2744](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2744) diff --git a/modules/brk-client/docs/interfaces/2015Pattern.md b/modules/brk-client/docs/interfaces/2015Pattern.md index 4bfb2333a..70a996f52 100644 --- a/modules/brk-client/docs/interfaces/2015Pattern.md +++ b/modules/brk-client/docs/interfaces/2015Pattern.md @@ -6,7 +6,7 @@ # Interface: \_2015Pattern -Defined in: [Developer/brk/modules/brk-client/index.js:3393](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3393) +Defined in: [Developer/brk/modules/brk-client/index.js:2538](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2538) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3393](https://github.com/ > **bitcoin**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3394](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3394) +Defined in: [Developer/brk/modules/brk-client/index.js:2539](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2539) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3394](https://github.com/ > **dollars**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3395](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3395) +Defined in: [Developer/brk/modules/brk-client/index.js:2540](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2540) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3395](https://github.com/ > **sats**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3396](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3396) +Defined in: [Developer/brk/modules/brk-client/index.js:2541](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2541) diff --git a/modules/brk-client/docs/interfaces/AaopoolPattern.md b/modules/brk-client/docs/interfaces/AaopoolPattern.md index 1d481f650..6e53f13b6 100644 --- a/modules/brk-client/docs/interfaces/AaopoolPattern.md +++ b/modules/brk-client/docs/interfaces/AaopoolPattern.md @@ -6,7 +6,7 @@ # Interface: AaopoolPattern -Defined in: [Developer/brk/modules/brk-client/index.js:2596](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2596) +Defined in: [Developer/brk/modules/brk-client/index.js:1792](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1792) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2596](https://github.com/ > **\_1mBlocksMined**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2597](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2597) +Defined in: [Developer/brk/modules/brk-client/index.js:1793](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1793) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2597](https://github.com/ > **\_1mDominance**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2598](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2598) +Defined in: [Developer/brk/modules/brk-client/index.js:1794](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1794) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2598](https://github.com/ > **\_1wBlocksMined**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2599](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2599) +Defined in: [Developer/brk/modules/brk-client/index.js:1795](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1795) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2599](https://github.com/ > **\_1wDominance**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2600](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2600) +Defined in: [Developer/brk/modules/brk-client/index.js:1796](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1796) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2600](https://github.com/ > **\_1yBlocksMined**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2601](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2601) +Defined in: [Developer/brk/modules/brk-client/index.js:1797](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1797) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2601](https://github.com/ > **\_1yDominance**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2602](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2602) +Defined in: [Developer/brk/modules/brk-client/index.js:1798](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1798) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2602](https://github.com/ > **\_24hBlocksMined**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2603](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2603) +Defined in: [Developer/brk/modules/brk-client/index.js:1799](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1799) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2603](https://github.com/ > **\_24hDominance**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2604](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2604) +Defined in: [Developer/brk/modules/brk-client/index.js:1800](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1800) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2604](https://github.com/ > **blocksMined**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2605](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2605) +Defined in: [Developer/brk/modules/brk-client/index.js:1801](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1801) *** @@ -86,7 +86,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2605](https://github.com/ > **coinbase**: [`CoinbasePattern2`](CoinbasePattern2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2606](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2606) +Defined in: [Developer/brk/modules/brk-client/index.js:1802](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1802) *** @@ -94,7 +94,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2606](https://github.com/ > **daysSinceBlock**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2607](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2607) +Defined in: [Developer/brk/modules/brk-client/index.js:1803](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1803) *** @@ -102,7 +102,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2607](https://github.com/ > **dominance**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2608](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2608) +Defined in: [Developer/brk/modules/brk-client/index.js:1804](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1804) *** @@ -110,7 +110,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2608](https://github.com/ > **fee**: [`UnclaimedRewardsPattern`](UnclaimedRewardsPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2609](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2609) +Defined in: [Developer/brk/modules/brk-client/index.js:1805](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1805) *** @@ -118,4 +118,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2609](https://github.com/ > **subsidy**: [`UnclaimedRewardsPattern`](UnclaimedRewardsPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2610](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2610) +Defined in: [Developer/brk/modules/brk-client/index.js:1806](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1806) diff --git a/modules/brk-client/docs/interfaces/ActivePriceRatioPattern.md b/modules/brk-client/docs/interfaces/ActivePriceRatioPattern.md index d211a33c4..cd2c86ad0 100644 --- a/modules/brk-client/docs/interfaces/ActivePriceRatioPattern.md +++ b/modules/brk-client/docs/interfaces/ActivePriceRatioPattern.md @@ -6,7 +6,7 @@ # Interface: ActivePriceRatioPattern -Defined in: [Developer/brk/modules/brk-client/index.js:2388](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2388) +Defined in: [Developer/brk/modules/brk-client/index.js:1635](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1635) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2388](https://github.com/ > **ratio**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2389](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2389) +Defined in: [Developer/brk/modules/brk-client/index.js:1636](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1636) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2389](https://github.com/ > **ratio1mSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2390](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2390) +Defined in: [Developer/brk/modules/brk-client/index.js:1637](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1637) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2390](https://github.com/ > **ratio1wSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2391](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2391) +Defined in: [Developer/brk/modules/brk-client/index.js:1638](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1638) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2391](https://github.com/ > **ratio1ySd**: [`Ratio1ySdPattern`](Ratio1ySdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2392](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2392) +Defined in: [Developer/brk/modules/brk-client/index.js:1639](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1639) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2392](https://github.com/ > **ratio2ySd**: [`Ratio1ySdPattern`](Ratio1ySdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2393](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2393) +Defined in: [Developer/brk/modules/brk-client/index.js:1640](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1640) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2393](https://github.com/ > **ratio4ySd**: [`Ratio1ySdPattern`](Ratio1ySdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2394](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2394) +Defined in: [Developer/brk/modules/brk-client/index.js:1641](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1641) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2394](https://github.com/ > **ratioPct1**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2395](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2395) +Defined in: [Developer/brk/modules/brk-client/index.js:1642](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1642) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2395](https://github.com/ > **ratioPct1Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2396](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2396) +Defined in: [Developer/brk/modules/brk-client/index.js:1643](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1643) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2396](https://github.com/ > **ratioPct2**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2397](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2397) +Defined in: [Developer/brk/modules/brk-client/index.js:1644](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1644) *** @@ -86,7 +86,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2397](https://github.com/ > **ratioPct2Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2398](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2398) +Defined in: [Developer/brk/modules/brk-client/index.js:1645](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1645) *** @@ -94,7 +94,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2398](https://github.com/ > **ratioPct5**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2399](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2399) +Defined in: [Developer/brk/modules/brk-client/index.js:1646](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1646) *** @@ -102,7 +102,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2399](https://github.com/ > **ratioPct5Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2400](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2400) +Defined in: [Developer/brk/modules/brk-client/index.js:1647](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1647) *** @@ -110,7 +110,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2400](https://github.com/ > **ratioPct95**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2401](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2401) +Defined in: [Developer/brk/modules/brk-client/index.js:1648](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1648) *** @@ -118,7 +118,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2401](https://github.com/ > **ratioPct95Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2402](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2402) +Defined in: [Developer/brk/modules/brk-client/index.js:1649](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1649) *** @@ -126,7 +126,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2402](https://github.com/ > **ratioPct98**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2403](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2403) +Defined in: [Developer/brk/modules/brk-client/index.js:1650](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1650) *** @@ -134,7 +134,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2403](https://github.com/ > **ratioPct98Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2404](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2404) +Defined in: [Developer/brk/modules/brk-client/index.js:1651](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1651) *** @@ -142,7 +142,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2404](https://github.com/ > **ratioPct99**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2405](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2405) +Defined in: [Developer/brk/modules/brk-client/index.js:1652](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1652) *** @@ -150,7 +150,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2405](https://github.com/ > **ratioPct99Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2406](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2406) +Defined in: [Developer/brk/modules/brk-client/index.js:1653](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1653) *** @@ -158,4 +158,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2406](https://github.com/ > **ratioSd**: [`Ratio1ySdPattern`](Ratio1ySdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2407](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2407) +Defined in: [Developer/brk/modules/brk-client/index.js:1654](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1654) diff --git a/modules/brk-client/docs/interfaces/ActiveSupplyPattern.md b/modules/brk-client/docs/interfaces/ActiveSupplyPattern.md index 253583ebd..28aea3d0d 100644 --- a/modules/brk-client/docs/interfaces/ActiveSupplyPattern.md +++ b/modules/brk-client/docs/interfaces/ActiveSupplyPattern.md @@ -6,7 +6,7 @@ # Interface: ActiveSupplyPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3456](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3456) +Defined in: [Developer/brk/modules/brk-client/index.js:2643](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2643) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3456](https://github.com/ > **bitcoin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3457](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3457) +Defined in: [Developer/brk/modules/brk-client/index.js:2644](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2644) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3457](https://github.com/ > **dollars**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3458](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3458) +Defined in: [Developer/brk/modules/brk-client/index.js:2645](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2645) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3458](https://github.com/ > **sats**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3459](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3459) +Defined in: [Developer/brk/modules/brk-client/index.js:2646](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2646) diff --git a/modules/brk-client/docs/interfaces/ActivityPattern2.md b/modules/brk-client/docs/interfaces/ActivityPattern2.md index 121b1d55d..a3664f7f1 100644 --- a/modules/brk-client/docs/interfaces/ActivityPattern2.md +++ b/modules/brk-client/docs/interfaces/ActivityPattern2.md @@ -6,7 +6,7 @@ # Interface: ActivityPattern2 -Defined in: [Developer/brk/modules/brk-client/index.js:3331](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3331) +Defined in: [Developer/brk/modules/brk-client/index.js:2488](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2488) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3331](https://github.com/ > **coinblocksDestroyed**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3332](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3332) +Defined in: [Developer/brk/modules/brk-client/index.js:2489](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2489) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3332](https://github.com/ > **coindaysDestroyed**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3333](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3333) +Defined in: [Developer/brk/modules/brk-client/index.js:2490](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2490) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3333](https://github.com/ > **satblocksDestroyed**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3334](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3334) +Defined in: [Developer/brk/modules/brk-client/index.js:2491](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2491) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3334](https://github.com/ > **satdaysDestroyed**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3335](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3335) +Defined in: [Developer/brk/modules/brk-client/index.js:2492](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2492) *** @@ -46,4 +46,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3335](https://github.com/ > **sent**: [`UnclaimedRewardsPattern`](UnclaimedRewardsPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3336](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3336) +Defined in: [Developer/brk/modules/brk-client/index.js:2493](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2493) diff --git a/modules/brk-client/docs/interfaces/AddrCountPattern.md b/modules/brk-client/docs/interfaces/AddrCountPattern.md index 10522ba96..1410af14b 100644 --- a/modules/brk-client/docs/interfaces/AddrCountPattern.md +++ b/modules/brk-client/docs/interfaces/AddrCountPattern.md @@ -6,7 +6,7 @@ # Interface: AddrCountPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3043](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3043) +Defined in: [Developer/brk/modules/brk-client/index.js:2180](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2180) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3043](https://github.com/ > **all**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3044](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3044) +Defined in: [Developer/brk/modules/brk-client/index.js:2181](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2181) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3044](https://github.com/ > **p2a**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3045](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3045) +Defined in: [Developer/brk/modules/brk-client/index.js:2182](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2182) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3045](https://github.com/ > **p2pk33**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3046](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3046) +Defined in: [Developer/brk/modules/brk-client/index.js:2183](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2183) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3046](https://github.com/ > **p2pk65**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3047](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3047) +Defined in: [Developer/brk/modules/brk-client/index.js:2184](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2184) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3047](https://github.com/ > **p2pkh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3048](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3048) +Defined in: [Developer/brk/modules/brk-client/index.js:2185](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2185) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3048](https://github.com/ > **p2sh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3049](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3049) +Defined in: [Developer/brk/modules/brk-client/index.js:2186](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2186) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3049](https://github.com/ > **p2tr**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3050](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3050) +Defined in: [Developer/brk/modules/brk-client/index.js:2187](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2187) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3050](https://github.com/ > **p2wpkh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3051](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3051) +Defined in: [Developer/brk/modules/brk-client/index.js:2188](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2188) *** @@ -78,4 +78,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3051](https://github.com/ > **p2wsh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3052](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3052) +Defined in: [Developer/brk/modules/brk-client/index.js:2189](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2189) diff --git a/modules/brk-client/docs/interfaces/AddressChainStats.md b/modules/brk-client/docs/interfaces/AddressChainStats.md index 15b9787d4..e1cd4d97b 100644 --- a/modules/brk-client/docs/interfaces/AddressChainStats.md +++ b/modules/brk-client/docs/interfaces/AddressChainStats.md @@ -6,7 +6,7 @@ # Interface: AddressChainStats -Defined in: [Developer/brk/modules/brk-client/index.js:8](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L8) +Defined in: [Developer/brk/modules/brk-client/index.js:16](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L16) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:8](https://github.com/bit > **fundedTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:9](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L9) +Defined in: [Developer/brk/modules/brk-client/index.js:17](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L17) + +Total number of transaction outputs that funded this address *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:9](https://github.com/bit > **fundedTxoSum**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:10](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L10) +Defined in: [Developer/brk/modules/brk-client/index.js:18](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L18) + +Total amount in satoshis received by this address across all funded outputs *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:10](https://github.com/bi > **spentTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:11](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L11) +Defined in: [Developer/brk/modules/brk-client/index.js:19](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L19) + +Total number of transaction outputs spent from this address *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:11](https://github.com/bi > **spentTxoSum**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:12](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L12) +Defined in: [Developer/brk/modules/brk-client/index.js:20](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L20) + +Total amount in satoshis spent from this address *** @@ -46,7 +54,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:12](https://github.com/bi > **txCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:13](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L13) +Defined in: [Developer/brk/modules/brk-client/index.js:21](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L21) + +Total number of confirmed transactions involving this address *** @@ -54,4 +64,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:13](https://github.com/bi > **typeIndex**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:14](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L14) +Defined in: [Developer/brk/modules/brk-client/index.js:22](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/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/AddressMempoolStats.md index c3a41c491..ef6fee697 100644 --- a/modules/brk-client/docs/interfaces/AddressMempoolStats.md +++ b/modules/brk-client/docs/interfaces/AddressMempoolStats.md @@ -6,7 +6,7 @@ # Interface: AddressMempoolStats -Defined in: [Developer/brk/modules/brk-client/index.js:17](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L17) +Defined in: [Developer/brk/modules/brk-client/index.js:29](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L29) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:17](https://github.com/bi > **fundedTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:18](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L18) +Defined in: [Developer/brk/modules/brk-client/index.js:30](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L30) + +Number of unconfirmed transaction outputs funding this address *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:18](https://github.com/bi > **fundedTxoSum**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:19](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L19) +Defined in: [Developer/brk/modules/brk-client/index.js:31](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L31) + +Total amount in satoshis being received in unconfirmed transactions *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:19](https://github.com/bi > **spentTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:20](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L20) +Defined in: [Developer/brk/modules/brk-client/index.js:32](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L32) + +Number of unconfirmed transaction inputs spending from this address *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:20](https://github.com/bi > **spentTxoSum**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:21](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L21) +Defined in: [Developer/brk/modules/brk-client/index.js:33](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L33) + +Total amount in satoshis being spent in unconfirmed transactions *** @@ -46,4 +54,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:21](https://github.com/bi > **txCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:22](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L22) +Defined in: [Developer/brk/modules/brk-client/index.js:34](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L34) + +Number of unconfirmed transactions involving this address diff --git a/modules/brk-client/docs/interfaces/AddressParam.md b/modules/brk-client/docs/interfaces/AddressParam.md index bb9023b65..ff8536df6 100644 --- a/modules/brk-client/docs/interfaces/AddressParam.md +++ b/modules/brk-client/docs/interfaces/AddressParam.md @@ -6,7 +6,7 @@ # Interface: AddressParam -Defined in: [Developer/brk/modules/brk-client/index.js:25](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L25) +Defined in: [Developer/brk/modules/brk-client/index.js:37](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L37) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:25](https://github.com/bi > **address**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:26](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L26) +Defined in: [Developer/brk/modules/brk-client/index.js:38](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L38) diff --git a/modules/brk-client/docs/interfaces/AddressStats.md b/modules/brk-client/docs/interfaces/AddressStats.md index 96a260f5c..5545d7d78 100644 --- a/modules/brk-client/docs/interfaces/AddressStats.md +++ b/modules/brk-client/docs/interfaces/AddressStats.md @@ -6,7 +6,7 @@ # Interface: AddressStats -Defined in: [Developer/brk/modules/brk-client/index.js:29](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L29) +Defined in: [Developer/brk/modules/brk-client/index.js:43](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L43) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:29](https://github.com/bi > **address**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:30](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L30) +Defined in: [Developer/brk/modules/brk-client/index.js:44](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L44) + +Bitcoin address string *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:30](https://github.com/bi > **chainStats**: [`AddressChainStats`](AddressChainStats.md) -Defined in: [Developer/brk/modules/brk-client/index.js:31](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L31) +Defined in: [Developer/brk/modules/brk-client/index.js:45](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L45) + +Statistics for confirmed transactions on the blockchain *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:31](https://github.com/bi > `optional` **mempoolStats**: [`AddressMempoolStats`](AddressMempoolStats.md) \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:32](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L32) +Defined in: [Developer/brk/modules/brk-client/index.js:46](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/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 index 56d071fd7..c2a2258cf 100644 --- a/modules/brk-client/docs/interfaces/AddressTxidsParam.md +++ b/modules/brk-client/docs/interfaces/AddressTxidsParam.md @@ -6,7 +6,7 @@ # Interface: AddressTxidsParam -Defined in: [Developer/brk/modules/brk-client/index.js:35](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L35) +Defined in: [Developer/brk/modules/brk-client/index.js:49](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L49) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:35](https://github.com/bi > `optional` **afterTxid**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:36](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L36) +Defined in: [Developer/brk/modules/brk-client/index.js:50](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L50) + +Txid to paginate from (return transactions before this one) *** @@ -22,4 +24,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:36](https://github.com/bi > `optional` **limit**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:37](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L37) +Defined in: [Developer/brk/modules/brk-client/index.js:51](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/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 index 436dd833f..91ee997ba 100644 --- a/modules/brk-client/docs/interfaces/AddressValidation.md +++ b/modules/brk-client/docs/interfaces/AddressValidation.md @@ -6,7 +6,7 @@ # Interface: AddressValidation -Defined in: [Developer/brk/modules/brk-client/index.js:40](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L40) +Defined in: [Developer/brk/modules/brk-client/index.js:56](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L56) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:40](https://github.com/bi > `optional` **address**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:41](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L41) +Defined in: [Developer/brk/modules/brk-client/index.js:58](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L58) + +The validated address *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:41](https://github.com/bi > `optional` **isscript**: `boolean` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:42](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L42) +Defined in: [Developer/brk/modules/brk-client/index.js:60](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L60) + +Whether this is a script address (P2SH) *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:42](https://github.com/bi > **isvalid**: `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:43](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L43) +Defined in: [Developer/brk/modules/brk-client/index.js:57](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L57) + +Whether the address is valid *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:43](https://github.com/bi > `optional` **iswitness**: `boolean` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:44](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L44) +Defined in: [Developer/brk/modules/brk-client/index.js:61](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L61) + +Whether this is a witness address *** @@ -46,7 +54,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:44](https://github.com/bi > `optional` **scriptPubKey**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:45](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L45) +Defined in: [Developer/brk/modules/brk-client/index.js:59](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L59) + +The scriptPubKey in hex *** @@ -54,7 +64,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:45](https://github.com/bi > `optional` **witnessProgram**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:46](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L46) +Defined in: [Developer/brk/modules/brk-client/index.js:63](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L63) + +Witness program in hex *** @@ -62,4 +74,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:46](https://github.com/bi > `optional` **witnessVersion**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:47](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L47) +Defined in: [Developer/brk/modules/brk-client/index.js:62](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L62) + +Witness version (0 for P2WPKH/P2WSH, 1 for P2TR) diff --git a/modules/brk-client/docs/interfaces/BitcoinPattern.md b/modules/brk-client/docs/interfaces/BitcoinPattern.md index 370eed94d..57b914ffc 100644 --- a/modules/brk-client/docs/interfaces/BitcoinPattern.md +++ b/modules/brk-client/docs/interfaces/BitcoinPattern.md @@ -4,28 +4,94 @@ [brk-client](../globals.md) / BitcoinPattern -# Interface: BitcoinPattern\ +# Interface: BitcoinPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3665](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3665) - -## Type Parameters - -### T - -`T` +Defined in: [Developer/brk/modules/brk-client/index.js:1958](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1958) ## Properties +### average + +> **average**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1959](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1959) + +*** + +### base + +> **base**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1960](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1960) + +*** + ### cumulative -> **cumulative**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> +> **cumulative**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3666](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3666) +Defined in: [Developer/brk/modules/brk-client/index.js:1961](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1961) + +*** + +### max + +> **max**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1962](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1962) + +*** + +### median + +> **median**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1963](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1963) + +*** + +### min + +> **min**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1964](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1964) + +*** + +### pct10 + +> **pct10**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1965](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1965) + +*** + +### pct25 + +> **pct25**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1966](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1966) + +*** + +### pct75 + +> **pct75**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1967](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1967) + +*** + +### pct90 + +> **pct90**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1968](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1968) *** ### sum -> **sum**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> +> **sum**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3667](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3667) +Defined in: [Developer/brk/modules/brk-client/index.js:1969](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1969) diff --git a/modules/brk-client/docs/interfaces/BitcoinPattern2.md b/modules/brk-client/docs/interfaces/BitcoinPattern2.md new file mode 100644 index 000000000..04399dbdf --- /dev/null +++ b/modules/brk-client/docs/interfaces/BitcoinPattern2.md @@ -0,0 +1,31 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / BitcoinPattern2 + +# Interface: BitcoinPattern2\ + +Defined in: [Developer/brk/modules/brk-client/index.js:2783](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2783) + +## Type Parameters + +### T + +`T` + +## Properties + +### cumulative + +> **cumulative**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2784](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2784) + +*** + +### sum + +> **sum**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2785](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2785) diff --git a/modules/brk-client/docs/interfaces/BlockCountParam.md b/modules/brk-client/docs/interfaces/BlockCountParam.md index b2ad287f4..f90683479 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:53](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L53) +Defined in: [Developer/brk/modules/brk-client/index.js:81](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L81) ## Properties @@ -14,4 +14,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:53](https://github.com/bi > **blockCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:54](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L54) +Defined in: [Developer/brk/modules/brk-client/index.js:82](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L82) + +Number of recent blocks to include diff --git a/modules/brk-client/docs/interfaces/BlockCountPattern.md b/modules/brk-client/docs/interfaces/BlockCountPattern.md index 4d42b0070..8ca6492eb 100644 --- a/modules/brk-client/docs/interfaces/BlockCountPattern.md +++ b/modules/brk-client/docs/interfaces/BlockCountPattern.md @@ -6,7 +6,7 @@ # Interface: BlockCountPattern\ -Defined in: [Developer/brk/modules/brk-client/index.js:3644](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3644) +Defined in: [Developer/brk/modules/brk-client/index.js:2762](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2762) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3644](https://github.com/ > **cumulative**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3645](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3645) +Defined in: [Developer/brk/modules/brk-client/index.js:2763](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2763) *** @@ -28,4 +28,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3645](https://github.com/ > **sum**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3646](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3646) +Defined in: [Developer/brk/modules/brk-client/index.js:2764](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2764) diff --git a/modules/brk-client/docs/interfaces/BlockFeesEntry.md b/modules/brk-client/docs/interfaces/BlockFeesEntry.md index f4f8184dd..dee600dc7 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:57](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L57) +Defined in: [Developer/brk/modules/brk-client/index.js:87](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L87) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:57](https://github.com/bi > **avgFees**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:58](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L58) +Defined in: [Developer/brk/modules/brk-client/index.js:90](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L90) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:58](https://github.com/bi > **avgHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:59](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L59) +Defined in: [Developer/brk/modules/brk-client/index.js:88](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L88) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:59](https://github.com/bi > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:60](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L60) +Defined in: [Developer/brk/modules/brk-client/index.js:89](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L89) diff --git a/modules/brk-client/docs/interfaces/BlockHashParam.md b/modules/brk-client/docs/interfaces/BlockHashParam.md index c34dfff04..512657c22 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:64](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L64) +Defined in: [Developer/brk/modules/brk-client/index.js:98](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L98) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:64](https://github.com/bi > **hash**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:65](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L65) +Defined in: [Developer/brk/modules/brk-client/index.js:99](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L99) diff --git a/modules/brk-client/docs/interfaces/BlockHashStartIndex.md b/modules/brk-client/docs/interfaces/BlockHashStartIndex.md index 1c5b12db8..83160dae6 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:68](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L68) +Defined in: [Developer/brk/modules/brk-client/index.js:102](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L102) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:68](https://github.com/bi > **hash**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:69](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L69) +Defined in: [Developer/brk/modules/brk-client/index.js:103](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L103) + +Bitcoin block hash *** @@ -22,4 +24,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:69](https://github.com/bi > **startIndex**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:70](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L70) +Defined in: [Developer/brk/modules/brk-client/index.js:104](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L104) + +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 1c22e83b2..7a4ec14ac 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:73](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L73) +Defined in: [Developer/brk/modules/brk-client/index.js:107](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L107) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:73](https://github.com/bi > **hash**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:74](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L74) +Defined in: [Developer/brk/modules/brk-client/index.js:108](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L108) + +Bitcoin block hash *** @@ -22,4 +24,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:74](https://github.com/bi > **index**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:75](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L75) +Defined in: [Developer/brk/modules/brk-client/index.js:109](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L109) + +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 c2eaff880..8318c5711 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:78](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L78) +Defined in: [Developer/brk/modules/brk-client/index.js:114](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L114) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:78](https://github.com/bi > **difficulty**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:79](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L79) +Defined in: [Developer/brk/modules/brk-client/index.js:121](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L121) + +Block difficulty as a floating point number *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:79](https://github.com/bi > **height**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:80](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L80) +Defined in: [Developer/brk/modules/brk-client/index.js:116](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L116) + +Block height *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:80](https://github.com/bi > **id**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:81](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L81) +Defined in: [Developer/brk/modules/brk-client/index.js:115](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L115) + +Block hash *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:81](https://github.com/bi > **size**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:82](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L82) +Defined in: [Developer/brk/modules/brk-client/index.js:118](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L118) + +Block size in bytes *** @@ -46,7 +54,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:82](https://github.com/bi > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:83](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L83) +Defined in: [Developer/brk/modules/brk-client/index.js:120](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L120) + +Block timestamp (Unix time) *** @@ -54,7 +64,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:83](https://github.com/bi > **txCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:84](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L84) +Defined in: [Developer/brk/modules/brk-client/index.js:117](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L117) + +Number of transactions in the block *** @@ -62,4 +74,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:84](https://github.com/bi > **weight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:85](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L85) +Defined in: [Developer/brk/modules/brk-client/index.js:119](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L119) + +Block weight in weight units diff --git a/modules/brk-client/docs/interfaces/BlockRewardsEntry.md b/modules/brk-client/docs/interfaces/BlockRewardsEntry.md index 91ac46241..daadab823 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:88](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L88) +Defined in: [Developer/brk/modules/brk-client/index.js:126](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L126) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:88](https://github.com/bi > **avgHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:89](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L89) +Defined in: [Developer/brk/modules/brk-client/index.js:127](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L127) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:89](https://github.com/bi > **avgRewards**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:90](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L90) +Defined in: [Developer/brk/modules/brk-client/index.js:129](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L129) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:90](https://github.com/bi > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:91](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L91) +Defined in: [Developer/brk/modules/brk-client/index.js:128](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L128) diff --git a/modules/brk-client/docs/interfaces/BlockSizeEntry.md b/modules/brk-client/docs/interfaces/BlockSizeEntry.md index 1b97e2e26..62b7cf19d 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:94](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L94) +Defined in: [Developer/brk/modules/brk-client/index.js:134](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L134) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:94](https://github.com/bi > **avgHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:95](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L95) +Defined in: [Developer/brk/modules/brk-client/index.js:135](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L135) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:95](https://github.com/bi > **avgSize**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:96](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L96) +Defined in: [Developer/brk/modules/brk-client/index.js:137](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L137) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:96](https://github.com/bi > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:97](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L97) +Defined in: [Developer/brk/modules/brk-client/index.js:136](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L136) diff --git a/modules/brk-client/docs/interfaces/BlockSizesWeights.md b/modules/brk-client/docs/interfaces/BlockSizesWeights.md index 95ca9d8f9..72b57a23c 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:100](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L100) +Defined in: [Developer/brk/modules/brk-client/index.js:142](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L142) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:100](https://github.com/b > **sizes**: [`BlockSizeEntry`](BlockSizeEntry.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:101](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L101) +Defined in: [Developer/brk/modules/brk-client/index.js:143](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L143) *** @@ -22,4 +22,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:101](https://github.com/b > **weights**: [`BlockWeightEntry`](BlockWeightEntry.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:102](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L102) +Defined in: [Developer/brk/modules/brk-client/index.js:144](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L144) diff --git a/modules/brk-client/docs/interfaces/BlockStatus.md b/modules/brk-client/docs/interfaces/BlockStatus.md index 6be58c8c5..049a2a6a5 100644 --- a/modules/brk-client/docs/interfaces/BlockStatus.md +++ b/modules/brk-client/docs/interfaces/BlockStatus.md @@ -6,7 +6,7 @@ # Interface: BlockStatus -Defined in: [Developer/brk/modules/brk-client/index.js:105](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L105) +Defined in: [Developer/brk/modules/brk-client/index.js:149](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L149) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:105](https://github.com/b > `optional` **height**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:106](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L106) +Defined in: [Developer/brk/modules/brk-client/index.js:151](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L151) + +Block height (only if in best chain) *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:106](https://github.com/b > **inBestChain**: `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:107](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L107) +Defined in: [Developer/brk/modules/brk-client/index.js:150](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L150) + +Whether this block is in the best chain *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:107](https://github.com/b > `optional` **nextBest**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:108](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L108) +Defined in: [Developer/brk/modules/brk-client/index.js:152](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L152) + +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 e39e01be2..a009e1f29 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:111](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L111) +Defined in: [Developer/brk/modules/brk-client/index.js:157](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L157) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:111](https://github.com/b > **hash**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:112](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L112) +Defined in: [Developer/brk/modules/brk-client/index.js:159](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L159) + +Block hash *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:112](https://github.com/b > **height**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:113](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L113) +Defined in: [Developer/brk/modules/brk-client/index.js:158](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L158) + +Block height *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:113](https://github.com/b > **timestamp**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:114](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L114) +Defined in: [Developer/brk/modules/brk-client/index.js:160](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L160) + +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 11c00db34..b7c102654 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:117](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L117) +Defined in: [Developer/brk/modules/brk-client/index.js:165](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L165) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:117](https://github.com/b > **avgHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:118](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L118) +Defined in: [Developer/brk/modules/brk-client/index.js:166](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L166) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:118](https://github.com/b > **avgWeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:119](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L119) +Defined in: [Developer/brk/modules/brk-client/index.js:168](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L168) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:119](https://github.com/b > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:120](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L120) +Defined in: [Developer/brk/modules/brk-client/index.js:167](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L167) diff --git a/modules/brk-client/docs/interfaces/BrkClientOptions.md b/modules/brk-client/docs/interfaces/BrkClientOptions.md index 591baf8c1..3bf57cb5a 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:515](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L515) +Defined in: [Developer/brk/modules/brk-client/index.js:794](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L794) ## Properties @@ -14,16 +14,26 @@ Defined in: [Developer/brk/modules/brk-client/index.js:515](https://github.com/b > **baseUrl**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:516](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L516) +Defined in: [Developer/brk/modules/brk-client/index.js:795](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L795) Base URL for the API *** +### cache? + +> `optional` **cache**: `string` \| `boolean` + +Defined in: [Developer/brk/modules/brk-client/index.js:797](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L797) + +Enable browser cache with default name (true), custom name (string), or disable (false). No effect in Node.js. Default: true + +*** + ### timeout? > `optional` **timeout**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:517](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L517) +Defined in: [Developer/brk/modules/brk-client/index.js:796](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L796) Request timeout in milliseconds diff --git a/modules/brk-client/docs/interfaces/CatalogTree.md b/modules/brk-client/docs/interfaces/CatalogTree.md deleted file mode 100644 index 280f6b0b0..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree - -# Interface: CatalogTree - -Defined in: [Developer/brk/modules/brk-client/index.js:3721](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3721) - -## Properties - -### addresses - -> **addresses**: [`CatalogTree_Addresses`](CatalogTree_Addresses.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3722](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3722) - -*** - -### blocks - -> **blocks**: [`CatalogTree_Blocks`](CatalogTree_Blocks.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3723](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3723) - -*** - -### cointime - -> **cointime**: [`CatalogTree_Cointime`](CatalogTree_Cointime.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3724](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3724) - -*** - -### constants - -> **constants**: [`CatalogTree_Constants`](CatalogTree_Constants.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3725](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3725) - -*** - -### distribution - -> **distribution**: [`CatalogTree_Distribution`](CatalogTree_Distribution.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3726](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3726) - -*** - -### indexes - -> **indexes**: [`CatalogTree_Indexes`](CatalogTree_Indexes.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3727](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3727) - -*** - -### inputs - -> **inputs**: [`CatalogTree_Inputs`](CatalogTree_Inputs.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3728](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3728) - -*** - -### market - -> **market**: [`CatalogTree_Market`](CatalogTree_Market.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3729](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3729) - -*** - -### outputs - -> **outputs**: [`CatalogTree_Outputs`](CatalogTree_Outputs.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3730](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3730) - -*** - -### pools - -> **pools**: [`CatalogTree_Pools`](CatalogTree_Pools.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3731](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3731) - -*** - -### positions - -> **positions**: [`CatalogTree_Positions`](CatalogTree_Positions.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3732](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3732) - -*** - -### price - -> **price**: [`CatalogTree_Price`](CatalogTree_Price.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3733](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3733) - -*** - -### scripts - -> **scripts**: [`CatalogTree_Scripts`](CatalogTree_Scripts.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3734](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3734) - -*** - -### supply - -> **supply**: [`CatalogTree_Supply`](CatalogTree_Supply.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3735](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3735) - -*** - -### transactions - -> **transactions**: [`CatalogTree_Transactions`](CatalogTree_Transactions.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3736](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3736) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Addresses.md b/modules/brk-client/docs/interfaces/CatalogTree_Addresses.md deleted file mode 100644 index 41ff9dee7..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Addresses.md +++ /dev/null @@ -1,137 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Addresses - -# Interface: CatalogTree\_Addresses - -Defined in: [Developer/brk/modules/brk-client/index.js:3740](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3740) - -## Properties - -### firstP2aaddressindex - -> **firstP2aaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3741](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3741) - -*** - -### firstP2pk33addressindex - -> **firstP2pk33addressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3742](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3742) - -*** - -### firstP2pk65addressindex - -> **firstP2pk65addressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3743](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3743) - -*** - -### firstP2pkhaddressindex - -> **firstP2pkhaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3744](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3744) - -*** - -### firstP2shaddressindex - -> **firstP2shaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3745](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3745) - -*** - -### firstP2traddressindex - -> **firstP2traddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3746](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3746) - -*** - -### firstP2wpkhaddressindex - -> **firstP2wpkhaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3747](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3747) - -*** - -### firstP2wshaddressindex - -> **firstP2wshaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3748](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3748) - -*** - -### p2abytes - -> **p2abytes**: [`MetricPattern16`](../type-aliases/MetricPattern16.md)\<[`U8x2`](../type-aliases/U8x2.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3749](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3749) - -*** - -### p2pk33bytes - -> **p2pk33bytes**: [`MetricPattern18`](../type-aliases/MetricPattern18.md)\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3750](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3750) - -*** - -### p2pk65bytes - -> **p2pk65bytes**: [`MetricPattern19`](../type-aliases/MetricPattern19.md)\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3751](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3751) - -*** - -### p2pkhbytes - -> **p2pkhbytes**: [`MetricPattern20`](../type-aliases/MetricPattern20.md)\<[`U8x20`](../type-aliases/U8x20.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3752](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3752) - -*** - -### p2shbytes - -> **p2shbytes**: [`MetricPattern21`](../type-aliases/MetricPattern21.md)\<[`U8x20`](../type-aliases/U8x20.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3753](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3753) - -*** - -### p2trbytes - -> **p2trbytes**: [`MetricPattern22`](../type-aliases/MetricPattern22.md)\<[`U8x32`](../type-aliases/U8x32.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3754](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3754) - -*** - -### p2wpkhbytes - -> **p2wpkhbytes**: [`MetricPattern23`](../type-aliases/MetricPattern23.md)\<[`U8x20`](../type-aliases/U8x20.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3755](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3755) - -*** - -### p2wshbytes - -> **p2wshbytes**: [`MetricPattern24`](../type-aliases/MetricPattern24.md)\<[`U8x32`](../type-aliases/U8x32.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3756](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3756) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Blocks.md b/modules/brk-client/docs/interfaces/CatalogTree_Blocks.md deleted file mode 100644 index 451cc7fb0..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Blocks.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Blocks - -# Interface: CatalogTree\_Blocks - -Defined in: [Developer/brk/modules/brk-client/index.js:3760](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3760) - -## Properties - -### blockhash - -> **blockhash**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3761](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3761) - -*** - -### count - -> **count**: [`CatalogTree_Blocks_Count`](CatalogTree_Blocks_Count.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3762](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3762) - -*** - -### difficulty - -> **difficulty**: [`CatalogTree_Blocks_Difficulty`](CatalogTree_Blocks_Difficulty.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3763](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3763) - -*** - -### fullness - -> **fullness**: [`FullnessPattern`](FullnessPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3764](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3764) - -*** - -### halving - -> **halving**: [`CatalogTree_Blocks_Halving`](CatalogTree_Blocks_Halving.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3765](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3765) - -*** - -### interval - -> **interval**: [`CatalogTree_Blocks_Interval`](CatalogTree_Blocks_Interval.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3766](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3766) - -*** - -### mining - -> **mining**: [`CatalogTree_Blocks_Mining`](CatalogTree_Blocks_Mining.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3767](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3767) - -*** - -### rewards - -> **rewards**: [`CatalogTree_Blocks_Rewards`](CatalogTree_Blocks_Rewards.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3768](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3768) - -*** - -### size - -> **size**: [`CatalogTree_Blocks_Size`](CatalogTree_Blocks_Size.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3769](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3769) - -*** - -### time - -> **time**: [`CatalogTree_Blocks_Time`](CatalogTree_Blocks_Time.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3770](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3770) - -*** - -### totalSize - -> **totalSize**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3771](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3771) - -*** - -### vbytes - -> **vbytes**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3772](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3772) - -*** - -### weight - -> **weight**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3773](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3773) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Count.md b/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Count.md deleted file mode 100644 index a2b21c0d3..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Count.md +++ /dev/null @@ -1,89 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Blocks\_Count - -# Interface: CatalogTree\_Blocks\_Count - -Defined in: [Developer/brk/modules/brk-client/index.js:3777](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3777) - -## Properties - -### \_1mBlockCount - -> **\_1mBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3778](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3778) - -*** - -### \_1mStart - -> **\_1mStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3779](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3779) - -*** - -### \_1wBlockCount - -> **\_1wBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3780](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3780) - -*** - -### \_1wStart - -> **\_1wStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3781](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3781) - -*** - -### \_1yBlockCount - -> **\_1yBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3782](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3782) - -*** - -### \_1yStart - -> **\_1yStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3783](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3783) - -*** - -### \_24hBlockCount - -> **\_24hBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3784](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3784) - -*** - -### \_24hStart - -> **\_24hStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3785](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3785) - -*** - -### blockCount - -> **blockCount**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3786](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3786) - -*** - -### blockCountTarget - -> **blockCountTarget**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3787](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3787) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Difficulty.md b/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Difficulty.md deleted file mode 100644 index 2b7660e98..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Difficulty.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Blocks\_Difficulty - -# Interface: CatalogTree\_Blocks\_Difficulty - -Defined in: [Developer/brk/modules/brk-client/index.js:3791](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3791) - -## Properties - -### adjustment - -> **adjustment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3792](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3792) - -*** - -### asHash - -> **asHash**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3793](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3793) - -*** - -### blocksBeforeNextAdjustment - -> **blocksBeforeNextAdjustment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3794](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3794) - -*** - -### daysBeforeNextAdjustment - -> **daysBeforeNextAdjustment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3795](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3795) - -*** - -### epoch - -> **epoch**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3796](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3796) - -*** - -### raw - -> **raw**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3797](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3797) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Halving.md b/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Halving.md deleted file mode 100644 index b543652f4..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Halving.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Blocks\_Halving - -# Interface: CatalogTree\_Blocks\_Halving - -Defined in: [Developer/brk/modules/brk-client/index.js:3801](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3801) - -## Properties - -### blocksBeforeNextHalving - -> **blocksBeforeNextHalving**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3802](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3802) - -*** - -### daysBeforeNextHalving - -> **daysBeforeNextHalving**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3803](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3803) - -*** - -### epoch - -> **epoch**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3804](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3804) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Interval.md b/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Interval.md deleted file mode 100644 index 72bf25c7e..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Interval.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Blocks\_Interval - -# Interface: CatalogTree\_Blocks\_Interval - -Defined in: [Developer/brk/modules/brk-client/index.js:3808](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3808) - -## Properties - -### average - -> **average**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3809](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3809) - -*** - -### base - -> **base**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3810](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3810) - -*** - -### max - -> **max**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3811](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3811) - -*** - -### median - -> **median**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3812](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3812) - -*** - -### min - -> **min**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3813](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3813) - -*** - -### pct10 - -> **pct10**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3814](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3814) - -*** - -### pct25 - -> **pct25**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3815](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3815) - -*** - -### pct75 - -> **pct75**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3816](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3816) - -*** - -### pct90 - -> **pct90**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3817](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3817) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Mining.md b/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Mining.md deleted file mode 100644 index 3aac32420..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Mining.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Blocks\_Mining - -# Interface: CatalogTree\_Blocks\_Mining - -Defined in: [Developer/brk/modules/brk-client/index.js:3821](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3821) - -## Properties - -### hashPricePhs - -> **hashPricePhs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3822](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3822) - -*** - -### hashPricePhsMin - -> **hashPricePhsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3823](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3823) - -*** - -### hashPriceRebound - -> **hashPriceRebound**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3824](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3824) - -*** - -### hashPriceThs - -> **hashPriceThs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3825](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3825) - -*** - -### hashPriceThsMin - -> **hashPriceThsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3826](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3826) - -*** - -### hashRate - -> **hashRate**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3827](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3827) - -*** - -### hashRate1mSma - -> **hashRate1mSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3828](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3828) - -*** - -### hashRate1wSma - -> **hashRate1wSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3829](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3829) - -*** - -### hashRate1ySma - -> **hashRate1ySma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3830](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3830) - -*** - -### hashRate2mSma - -> **hashRate2mSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3831](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3831) - -*** - -### hashValuePhs - -> **hashValuePhs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3832](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3832) - -*** - -### hashValuePhsMin - -> **hashValuePhsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3833](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3833) - -*** - -### hashValueRebound - -> **hashValueRebound**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3834](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3834) - -*** - -### hashValueThs - -> **hashValueThs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3835](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3835) - -*** - -### hashValueThsMin - -> **hashValueThsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3836](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3836) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Rewards.md b/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Rewards.md deleted file mode 100644 index 451c5a8c2..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Rewards.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Blocks\_Rewards - -# Interface: CatalogTree\_Blocks\_Rewards - -Defined in: [Developer/brk/modules/brk-client/index.js:3840](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3840) - -## Properties - -### \_24hCoinbaseSum - -> **\_24hCoinbaseSum**: [`CatalogTree_Blocks_Rewards_24hCoinbaseSum`](CatalogTree_Blocks_Rewards_24hCoinbaseSum.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3841](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3841) - -*** - -### coinbase - -> **coinbase**: [`CoinbasePattern`](CoinbasePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3842](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3842) - -*** - -### feeDominance - -> **feeDominance**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3843](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3843) - -*** - -### subsidy - -> **subsidy**: [`CoinbasePattern`](CoinbasePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3844](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3844) - -*** - -### subsidyDominance - -> **subsidyDominance**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3845](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3845) - -*** - -### subsidyUsd1ySma - -> **subsidyUsd1ySma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3846](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3846) - -*** - -### unclaimedRewards - -> **unclaimedRewards**: [`UnclaimedRewardsPattern`](UnclaimedRewardsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3847](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3847) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Rewards_24hCoinbaseSum.md b/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Rewards_24hCoinbaseSum.md deleted file mode 100644 index d127d1bfa..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Rewards_24hCoinbaseSum.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Blocks\_Rewards\_24hCoinbaseSum - -# Interface: CatalogTree\_Blocks\_Rewards\_24hCoinbaseSum - -Defined in: [Developer/brk/modules/brk-client/index.js:3851](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3851) - -## Properties - -### bitcoin - -> **bitcoin**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3852](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3852) - -*** - -### dollars - -> **dollars**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3853](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3853) - -*** - -### sats - -> **sats**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3854](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3854) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Size.md b/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Size.md deleted file mode 100644 index efe14ca8a..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Size.md +++ /dev/null @@ -1,89 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Blocks\_Size - -# Interface: CatalogTree\_Blocks\_Size - -Defined in: [Developer/brk/modules/brk-client/index.js:3858](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3858) - -## Properties - -### average - -> **average**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3859](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3859) - -*** - -### cumulative - -> **cumulative**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3860](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3860) - -*** - -### max - -> **max**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3861](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3861) - -*** - -### median - -> **median**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3862](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3862) - -*** - -### min - -> **min**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3863](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3863) - -*** - -### pct10 - -> **pct10**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3864](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3864) - -*** - -### pct25 - -> **pct25**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3865](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3865) - -*** - -### pct75 - -> **pct75**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3866](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3866) - -*** - -### pct90 - -> **pct90**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3867](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3867) - -*** - -### sum - -> **sum**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3868](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3868) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Time.md b/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Time.md deleted file mode 100644 index 2701874e0..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Blocks_Time.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Blocks\_Time - -# Interface: CatalogTree\_Blocks\_Time - -Defined in: [Developer/brk/modules/brk-client/index.js:3872](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3872) - -## Properties - -### date - -> **date**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3873](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3873) - -*** - -### dateFixed - -> **dateFixed**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3874](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3874) - -*** - -### timestamp - -> **timestamp**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3875](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3875) - -*** - -### timestampFixed - -> **timestampFixed**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3876](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3876) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Cointime.md b/modules/brk-client/docs/interfaces/CatalogTree_Cointime.md deleted file mode 100644 index 6013de5c8..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Cointime.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Cointime - -# Interface: CatalogTree\_Cointime - -Defined in: [Developer/brk/modules/brk-client/index.js:3880](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3880) - -## Properties - -### activity - -> **activity**: [`CatalogTree_Cointime_Activity`](CatalogTree_Cointime_Activity.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3881](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3881) - -*** - -### adjusted - -> **adjusted**: [`CatalogTree_Cointime_Adjusted`](CatalogTree_Cointime_Adjusted.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3882](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3882) - -*** - -### cap - -> **cap**: [`CatalogTree_Cointime_Cap`](CatalogTree_Cointime_Cap.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3883](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3883) - -*** - -### pricing - -> **pricing**: [`CatalogTree_Cointime_Pricing`](CatalogTree_Cointime_Pricing.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3884](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3884) - -*** - -### supply - -> **supply**: [`CatalogTree_Cointime_Supply`](CatalogTree_Cointime_Supply.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3885](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3885) - -*** - -### value - -> **value**: [`CatalogTree_Cointime_Value`](CatalogTree_Cointime_Value.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3886](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3886) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Activity.md b/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Activity.md deleted file mode 100644 index af728da3e..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Activity.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Cointime\_Activity - -# Interface: CatalogTree\_Cointime\_Activity - -Defined in: [Developer/brk/modules/brk-client/index.js:3890](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3890) - -## Properties - -### activityToVaultednessRatio - -> **activityToVaultednessRatio**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3891](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3891) - -*** - -### coinblocksCreated - -> **coinblocksCreated**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3892](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3892) - -*** - -### coinblocksStored - -> **coinblocksStored**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3893](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3893) - -*** - -### liveliness - -> **liveliness**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3894](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3894) - -*** - -### vaultedness - -> **vaultedness**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3895](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3895) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Adjusted.md b/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Adjusted.md deleted file mode 100644 index 57e4d6364..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Adjusted.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Cointime\_Adjusted - -# Interface: CatalogTree\_Cointime\_Adjusted - -Defined in: [Developer/brk/modules/brk-client/index.js:3899](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3899) - -## Properties - -### cointimeAdjInflationRate - -> **cointimeAdjInflationRate**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3900](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3900) - -*** - -### cointimeAdjTxBtcVelocity - -> **cointimeAdjTxBtcVelocity**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3901](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3901) - -*** - -### cointimeAdjTxUsdVelocity - -> **cointimeAdjTxUsdVelocity**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3902](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3902) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Cap.md b/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Cap.md deleted file mode 100644 index 42829b633..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Cap.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Cointime\_Cap - -# Interface: CatalogTree\_Cointime\_Cap - -Defined in: [Developer/brk/modules/brk-client/index.js:3906](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3906) - -## Properties - -### activeCap - -> **activeCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3907](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3907) - -*** - -### cointimeCap - -> **cointimeCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3908](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3908) - -*** - -### investorCap - -> **investorCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3909](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3909) - -*** - -### thermoCap - -> **thermoCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3910](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3910) - -*** - -### vaultedCap - -> **vaultedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3911](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3911) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Pricing.md b/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Pricing.md deleted file mode 100644 index 2efbd3486..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Pricing.md +++ /dev/null @@ -1,73 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Cointime\_Pricing - -# Interface: CatalogTree\_Cointime\_Pricing - -Defined in: [Developer/brk/modules/brk-client/index.js:3915](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3915) - -## Properties - -### activePrice - -> **activePrice**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3916](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3916) - -*** - -### activePriceRatio - -> **activePriceRatio**: [`ActivePriceRatioPattern`](ActivePriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3917](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3917) - -*** - -### cointimePrice - -> **cointimePrice**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3918](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3918) - -*** - -### cointimePriceRatio - -> **cointimePriceRatio**: [`ActivePriceRatioPattern`](ActivePriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3919](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3919) - -*** - -### trueMarketMean - -> **trueMarketMean**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3920](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3920) - -*** - -### trueMarketMeanRatio - -> **trueMarketMeanRatio**: [`ActivePriceRatioPattern`](ActivePriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3921](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3921) - -*** - -### vaultedPrice - -> **vaultedPrice**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3922](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3922) - -*** - -### vaultedPriceRatio - -> **vaultedPriceRatio**: [`ActivePriceRatioPattern`](ActivePriceRatioPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3923](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3923) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Supply.md b/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Supply.md deleted file mode 100644 index 21f2038ae..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Supply.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Cointime\_Supply - -# Interface: CatalogTree\_Cointime\_Supply - -Defined in: [Developer/brk/modules/brk-client/index.js:3927](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3927) - -## Properties - -### activeSupply - -> **activeSupply**: [`ActiveSupplyPattern`](ActiveSupplyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3928](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3928) - -*** - -### vaultedSupply - -> **vaultedSupply**: [`ActiveSupplyPattern`](ActiveSupplyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3929](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3929) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Value.md b/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Value.md deleted file mode 100644 index 46bca13e8..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Cointime_Value.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Cointime\_Value - -# Interface: CatalogTree\_Cointime\_Value - -Defined in: [Developer/brk/modules/brk-client/index.js:3933](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3933) - -## Properties - -### cointimeValueCreated - -> **cointimeValueCreated**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3934](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3934) - -*** - -### cointimeValueDestroyed - -> **cointimeValueDestroyed**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3935](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3935) - -*** - -### cointimeValueStored - -> **cointimeValueStored**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3936](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3936) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Constants.md b/modules/brk-client/docs/interfaces/CatalogTree_Constants.md deleted file mode 100644 index 6f65c7aec..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Constants.md +++ /dev/null @@ -1,153 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Constants - -# Interface: CatalogTree\_Constants - -Defined in: [Developer/brk/modules/brk-client/index.js:3940](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3940) - -## Properties - -### constant0 - -> **constant0**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3941](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3941) - -*** - -### constant1 - -> **constant1**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3942](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3942) - -*** - -### constant100 - -> **constant100**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3943](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3943) - -*** - -### constant2 - -> **constant2**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3944](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3944) - -*** - -### constant20 - -> **constant20**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3945](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3945) - -*** - -### constant3 - -> **constant3**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3946](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3946) - -*** - -### constant30 - -> **constant30**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3947](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3947) - -*** - -### constant382 - -> **constant382**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3948](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3948) - -*** - -### constant4 - -> **constant4**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3949](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3949) - -*** - -### constant50 - -> **constant50**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3950](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3950) - -*** - -### constant600 - -> **constant600**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3951](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3951) - -*** - -### constant618 - -> **constant618**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3952](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3952) - -*** - -### constant70 - -> **constant70**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3953](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3953) - -*** - -### constant80 - -> **constant80**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3954](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3954) - -*** - -### constantMinus1 - -> **constantMinus1**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3955](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3955) - -*** - -### constantMinus2 - -> **constantMinus2**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3956](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3956) - -*** - -### constantMinus3 - -> **constantMinus3**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3957](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3957) - -*** - -### constantMinus4 - -> **constantMinus4**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3958](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3958) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution.md deleted file mode 100644 index 6b887fdef..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution - -# Interface: CatalogTree\_Distribution - -Defined in: [Developer/brk/modules/brk-client/index.js:3962](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3962) - -## Properties - -### addrCount - -> **addrCount**: [`CatalogTree_Distribution_AddrCount`](CatalogTree_Distribution_AddrCount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3963](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3963) - -*** - -### addressCohorts - -> **addressCohorts**: [`CatalogTree_Distribution_AddressCohorts`](CatalogTree_Distribution_AddressCohorts.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3964](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3964) - -*** - -### addressesData - -> **addressesData**: [`CatalogTree_Distribution_AddressesData`](CatalogTree_Distribution_AddressesData.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3965](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3965) - -*** - -### anyAddressIndexes - -> **anyAddressIndexes**: [`CatalogTree_Distribution_AnyAddressIndexes`](CatalogTree_Distribution_AnyAddressIndexes.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3966](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3966) - -*** - -### chainState - -> **chainState**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<[`SupplyState`](SupplyState.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3967](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3967) - -*** - -### emptyAddrCount - -> **emptyAddrCount**: [`CatalogTree_Distribution_EmptyAddrCount`](CatalogTree_Distribution_EmptyAddrCount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3968](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3968) - -*** - -### emptyaddressindex - -> **emptyaddressindex**: [`MetricPattern32`](../type-aliases/MetricPattern32.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3969](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3969) - -*** - -### loadedaddressindex - -> **loadedaddressindex**: [`MetricPattern31`](../type-aliases/MetricPattern31.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3970](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3970) - -*** - -### utxoCohorts - -> **utxoCohorts**: [`CatalogTree_Distribution_UtxoCohorts`](CatalogTree_Distribution_UtxoCohorts.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3971](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3971) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddrCount.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddrCount.md deleted file mode 100644 index 6cb62df83..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddrCount.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_AddrCount - -# Interface: CatalogTree\_Distribution\_AddrCount - -Defined in: [Developer/brk/modules/brk-client/index.js:3975](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3975) - -## Properties - -### all - -> **all**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3976](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3976) - -*** - -### p2a - -> **p2a**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3977](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3977) - -*** - -### p2pk33 - -> **p2pk33**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3978](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3978) - -*** - -### p2pk65 - -> **p2pk65**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3979](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3979) - -*** - -### p2pkh - -> **p2pkh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3980](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3980) - -*** - -### p2sh - -> **p2sh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3981](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3981) - -*** - -### p2tr - -> **p2tr**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3982](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3982) - -*** - -### p2wpkh - -> **p2wpkh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3983](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3983) - -*** - -### p2wsh - -> **p2wsh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:3984](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3984) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts.md deleted file mode 100644 index 0eb1fa7fb..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_AddressCohorts - -# Interface: CatalogTree\_Distribution\_AddressCohorts - -Defined in: [Developer/brk/modules/brk-client/index.js:3988](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3988) - -## Properties - -### amountRange - -> **amountRange**: [`CatalogTree_Distribution_AddressCohorts_AmountRange`](CatalogTree_Distribution_AddressCohorts_AmountRange.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3989](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3989) - -*** - -### geAmount - -> **geAmount**: [`CatalogTree_Distribution_AddressCohorts_GeAmount`](CatalogTree_Distribution_AddressCohorts_GeAmount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3990](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3990) - -*** - -### ltAmount - -> **ltAmount**: [`CatalogTree_Distribution_AddressCohorts_LtAmount`](CatalogTree_Distribution_AddressCohorts_LtAmount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3991](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3991) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts_AmountRange.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts_AmountRange.md deleted file mode 100644 index 1f415f48d..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts_AmountRange.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_AddressCohorts\_AmountRange - -# Interface: CatalogTree\_Distribution\_AddressCohorts\_AmountRange - -Defined in: [Developer/brk/modules/brk-client/index.js:3995](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3995) - -## Properties - -### \_0sats - -> **\_0sats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3996](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3996) - -*** - -### \_100btcTo1kBtc - -> **\_100btcTo1kBtc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3997](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3997) - -*** - -### \_100kBtcOrMore - -> **\_100kBtcOrMore**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3998](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3998) - -*** - -### \_100kSatsTo1mSats - -> **\_100kSatsTo1mSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:3999](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3999) - -*** - -### \_100satsTo1kSats - -> **\_100satsTo1kSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4000](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4000) - -*** - -### \_10btcTo100btc - -> **\_10btcTo100btc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4001](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4001) - -*** - -### \_10kBtcTo100kBtc - -> **\_10kBtcTo100kBtc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4002](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4002) - -*** - -### \_10kSatsTo100kSats - -> **\_10kSatsTo100kSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4003](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4003) - -*** - -### \_10mSatsTo1btc - -> **\_10mSatsTo1btc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4004](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4004) - -*** - -### \_10satsTo100sats - -> **\_10satsTo100sats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4005](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4005) - -*** - -### \_1btcTo10btc - -> **\_1btcTo10btc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4006](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4006) - -*** - -### \_1kBtcTo10kBtc - -> **\_1kBtcTo10kBtc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4007](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4007) - -*** - -### \_1kSatsTo10kSats - -> **\_1kSatsTo10kSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4008](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4008) - -*** - -### \_1mSatsTo10mSats - -> **\_1mSatsTo10mSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4009](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4009) - -*** - -### \_1satTo10sats - -> **\_1satTo10sats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4010](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4010) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts_GeAmount.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts_GeAmount.md deleted file mode 100644 index 37caebdd4..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts_GeAmount.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_AddressCohorts\_GeAmount - -# Interface: CatalogTree\_Distribution\_AddressCohorts\_GeAmount - -Defined in: [Developer/brk/modules/brk-client/index.js:4014](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4014) - -## Properties - -### \_100btc - -> **\_100btc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4015](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4015) - -*** - -### \_100kSats - -> **\_100kSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4016](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4016) - -*** - -### \_100sats - -> **\_100sats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4017](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4017) - -*** - -### \_10btc - -> **\_10btc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4018](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4018) - -*** - -### \_10kBtc - -> **\_10kBtc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4019](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4019) - -*** - -### \_10kSats - -> **\_10kSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4020](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4020) - -*** - -### \_10mSats - -> **\_10mSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4021](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4021) - -*** - -### \_10sats - -> **\_10sats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4022](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4022) - -*** - -### \_1btc - -> **\_1btc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4023](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4023) - -*** - -### \_1kBtc - -> **\_1kBtc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4024](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4024) - -*** - -### \_1kSats - -> **\_1kSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4025](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4025) - -*** - -### \_1mSats - -> **\_1mSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4026](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4026) - -*** - -### \_1sat - -> **\_1sat**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4027](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4027) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts_LtAmount.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts_LtAmount.md deleted file mode 100644 index c76ce6b7d..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressCohorts_LtAmount.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_AddressCohorts\_LtAmount - -# Interface: CatalogTree\_Distribution\_AddressCohorts\_LtAmount - -Defined in: [Developer/brk/modules/brk-client/index.js:4031](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4031) - -## Properties - -### \_100btc - -> **\_100btc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4032](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4032) - -*** - -### \_100kBtc - -> **\_100kBtc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4033](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4033) - -*** - -### \_100kSats - -> **\_100kSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4034](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4034) - -*** - -### \_100sats - -> **\_100sats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4035](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4035) - -*** - -### \_10btc - -> **\_10btc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4036](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4036) - -*** - -### \_10kBtc - -> **\_10kBtc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4037](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4037) - -*** - -### \_10kSats - -> **\_10kSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4038](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4038) - -*** - -### \_10mSats - -> **\_10mSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4039](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4039) - -*** - -### \_10sats - -> **\_10sats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4040](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4040) - -*** - -### \_1btc - -> **\_1btc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4041](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4041) - -*** - -### \_1kBtc - -> **\_1kBtc**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4042](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4042) - -*** - -### \_1kSats - -> **\_1kSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4043](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4043) - -*** - -### \_1mSats - -> **\_1mSats**: [`_0satsPattern`](0satsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4044](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4044) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressesData.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressesData.md deleted file mode 100644 index f98457dff..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AddressesData.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_AddressesData - -# Interface: CatalogTree\_Distribution\_AddressesData - -Defined in: [Developer/brk/modules/brk-client/index.js:4048](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4048) - -## Properties - -### empty - -> **empty**: [`MetricPattern32`](../type-aliases/MetricPattern32.md)\<[`EmptyAddressData`](EmptyAddressData.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4049](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4049) - -*** - -### loaded - -> **loaded**: [`MetricPattern31`](../type-aliases/MetricPattern31.md)\<[`LoadedAddressData`](LoadedAddressData.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4050](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4050) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AnyAddressIndexes.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AnyAddressIndexes.md deleted file mode 100644 index 14213a759..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_AnyAddressIndexes.md +++ /dev/null @@ -1,73 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_AnyAddressIndexes - -# Interface: CatalogTree\_Distribution\_AnyAddressIndexes - -Defined in: [Developer/brk/modules/brk-client/index.js:4054](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4054) - -## Properties - -### p2a - -> **p2a**: [`MetricPattern16`](../type-aliases/MetricPattern16.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4055](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4055) - -*** - -### p2pk33 - -> **p2pk33**: [`MetricPattern18`](../type-aliases/MetricPattern18.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4056](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4056) - -*** - -### p2pk65 - -> **p2pk65**: [`MetricPattern19`](../type-aliases/MetricPattern19.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4057](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4057) - -*** - -### p2pkh - -> **p2pkh**: [`MetricPattern20`](../type-aliases/MetricPattern20.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4058](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4058) - -*** - -### p2sh - -> **p2sh**: [`MetricPattern21`](../type-aliases/MetricPattern21.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4059](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4059) - -*** - -### p2tr - -> **p2tr**: [`MetricPattern22`](../type-aliases/MetricPattern22.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4060](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4060) - -*** - -### p2wpkh - -> **p2wpkh**: [`MetricPattern23`](../type-aliases/MetricPattern23.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4061](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4061) - -*** - -### p2wsh - -> **p2wsh**: [`MetricPattern24`](../type-aliases/MetricPattern24.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4062](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4062) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_EmptyAddrCount.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_EmptyAddrCount.md deleted file mode 100644 index 8272e2408..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_EmptyAddrCount.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_EmptyAddrCount - -# Interface: CatalogTree\_Distribution\_EmptyAddrCount - -Defined in: [Developer/brk/modules/brk-client/index.js:4066](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4066) - -## Properties - -### all - -> **all**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4067](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4067) - -*** - -### p2a - -> **p2a**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4068](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4068) - -*** - -### p2pk33 - -> **p2pk33**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4069](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4069) - -*** - -### p2pk65 - -> **p2pk65**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4070](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4070) - -*** - -### p2pkh - -> **p2pkh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4071](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4071) - -*** - -### p2sh - -> **p2sh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4072](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4072) - -*** - -### p2tr - -> **p2tr**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4073](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4073) - -*** - -### p2wpkh - -> **p2wpkh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4074](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4074) - -*** - -### p2wsh - -> **p2wsh**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4075](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4075) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts.md deleted file mode 100644 index 94bf6d104..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts.md +++ /dev/null @@ -1,97 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts - -# Interface: CatalogTree\_Distribution\_UtxoCohorts - -Defined in: [Developer/brk/modules/brk-client/index.js:4079](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4079) - -## Properties - -### ageRange - -> **ageRange**: [`CatalogTree_Distribution_UtxoCohorts_AgeRange`](CatalogTree_Distribution_UtxoCohorts_AgeRange.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4080](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4080) - -*** - -### all - -> **all**: [`CatalogTree_Distribution_UtxoCohorts_All`](CatalogTree_Distribution_UtxoCohorts_All.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4081](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4081) - -*** - -### amountRange - -> **amountRange**: [`CatalogTree_Distribution_UtxoCohorts_AmountRange`](CatalogTree_Distribution_UtxoCohorts_AmountRange.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4082](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4082) - -*** - -### epoch - -> **epoch**: [`CatalogTree_Distribution_UtxoCohorts_Epoch`](CatalogTree_Distribution_UtxoCohorts_Epoch.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4083](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4083) - -*** - -### geAmount - -> **geAmount**: [`CatalogTree_Distribution_UtxoCohorts_GeAmount`](CatalogTree_Distribution_UtxoCohorts_GeAmount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4084](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4084) - -*** - -### ltAmount - -> **ltAmount**: [`CatalogTree_Distribution_UtxoCohorts_LtAmount`](CatalogTree_Distribution_UtxoCohorts_LtAmount.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4085](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4085) - -*** - -### maxAge - -> **maxAge**: [`CatalogTree_Distribution_UtxoCohorts_MaxAge`](CatalogTree_Distribution_UtxoCohorts_MaxAge.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4086](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4086) - -*** - -### minAge - -> **minAge**: [`CatalogTree_Distribution_UtxoCohorts_MinAge`](CatalogTree_Distribution_UtxoCohorts_MinAge.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4087](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4087) - -*** - -### term - -> **term**: [`CatalogTree_Distribution_UtxoCohorts_Term`](CatalogTree_Distribution_UtxoCohorts_Term.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4088](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4088) - -*** - -### type - -> **type**: [`CatalogTree_Distribution_UtxoCohorts_Type`](CatalogTree_Distribution_UtxoCohorts_Type.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4089](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4089) - -*** - -### year - -> **year**: [`CatalogTree_Distribution_UtxoCohorts_Year`](CatalogTree_Distribution_UtxoCohorts_Year.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4090](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4090) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_AgeRange.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_AgeRange.md deleted file mode 100644 index 343aa2e81..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_AgeRange.md +++ /dev/null @@ -1,177 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_AgeRange - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_AgeRange - -Defined in: [Developer/brk/modules/brk-client/index.js:4094](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4094) - -## Properties - -### \_10yTo12y - -> **\_10yTo12y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4095](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4095) - -*** - -### \_12yTo15y - -> **\_12yTo15y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4096](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4096) - -*** - -### \_1dTo1w - -> **\_1dTo1w**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4097](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4097) - -*** - -### \_1hTo1d - -> **\_1hTo1d**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4098](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4098) - -*** - -### \_1mTo2m - -> **\_1mTo2m**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4099](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4099) - -*** - -### \_1wTo1m - -> **\_1wTo1m**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4100](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4100) - -*** - -### \_1yTo2y - -> **\_1yTo2y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4101](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4101) - -*** - -### \_2mTo3m - -> **\_2mTo3m**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4102](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4102) - -*** - -### \_2yTo3y - -> **\_2yTo3y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4103](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4103) - -*** - -### \_3mTo4m - -> **\_3mTo4m**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4104](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4104) - -*** - -### \_3yTo4y - -> **\_3yTo4y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4105](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4105) - -*** - -### \_4mTo5m - -> **\_4mTo5m**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4106](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4106) - -*** - -### \_4yTo5y - -> **\_4yTo5y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4107](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4107) - -*** - -### \_5mTo6m - -> **\_5mTo6m**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4108](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4108) - -*** - -### \_5yTo6y - -> **\_5yTo6y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4109](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4109) - -*** - -### \_6mTo1y - -> **\_6mTo1y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4110](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4110) - -*** - -### \_6yTo7y - -> **\_6yTo7y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4111](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4111) - -*** - -### \_7yTo8y - -> **\_7yTo8y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4112](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4112) - -*** - -### \_8yTo10y - -> **\_8yTo10y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4113](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4113) - -*** - -### from15y - -> **from15y**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4114](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4114) - -*** - -### upTo1h - -> **upTo1h**: [`_10yTo12yPattern`](10yTo12yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4115](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4115) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_All.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_All.md deleted file mode 100644 index b6ca58d03..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_All.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_All - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_All - -Defined in: [Developer/brk/modules/brk-client/index.js:4119](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4119) - -## Properties - -### activity - -> **activity**: [`ActivityPattern2`](ActivityPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4120](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4120) - -*** - -### costBasis - -> **costBasis**: [`CatalogTree_Distribution_UtxoCohorts_All_CostBasis`](CatalogTree_Distribution_UtxoCohorts_All_CostBasis.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4121](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4121) - -*** - -### outputs - -> **outputs**: [`OutputsPattern`](OutputsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4122](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4122) - -*** - -### realized - -> **realized**: [`RealizedPattern3`](RealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4123](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4123) - -*** - -### relative - -> **relative**: [`CatalogTree_Distribution_UtxoCohorts_All_Relative`](CatalogTree_Distribution_UtxoCohorts_All_Relative.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4124](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4124) - -*** - -### supply - -> **supply**: [`SupplyPattern2`](SupplyPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4125](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4125) - -*** - -### unrealized - -> **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4126](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4126) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_All_CostBasis.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_All_CostBasis.md deleted file mode 100644 index 95465a8d7..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_All_CostBasis.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_All\_CostBasis - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_All\_CostBasis - -Defined in: [Developer/brk/modules/brk-client/index.js:4130](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4130) - -## Properties - -### max - -> **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4131](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4131) - -*** - -### min - -> **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4132](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4132) - -*** - -### percentiles - -> **percentiles**: [`PercentilesPattern`](PercentilesPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4133](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4133) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_All_Relative.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_All_Relative.md deleted file mode 100644 index 01c6b002c..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_All_Relative.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_All\_Relative - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_All\_Relative - -Defined in: [Developer/brk/modules/brk-client/index.js:4137](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4137) - -## Properties - -### negUnrealizedLossRelToOwnTotalUnrealizedPnl - -> **negUnrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4138](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4138) - -*** - -### netUnrealizedPnlRelToOwnTotalUnrealizedPnl - -> **netUnrealizedPnlRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4139](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4139) - -*** - -### supplyInLossRelToOwnSupply - -> **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4140](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4140) - -*** - -### supplyInProfitRelToOwnSupply - -> **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4141](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4141) - -*** - -### unrealizedLossRelToOwnTotalUnrealizedPnl - -> **unrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4142](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4142) - -*** - -### unrealizedProfitRelToOwnTotalUnrealizedPnl - -> **unrealizedProfitRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4143](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4143) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_AmountRange.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_AmountRange.md deleted file mode 100644 index 440c4ca84..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_AmountRange.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_AmountRange - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_AmountRange - -Defined in: [Developer/brk/modules/brk-client/index.js:4147](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4147) - -## Properties - -### \_0sats - -> **\_0sats**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4148](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4148) - -*** - -### \_100btcTo1kBtc - -> **\_100btcTo1kBtc**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4149](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4149) - -*** - -### \_100kBtcOrMore - -> **\_100kBtcOrMore**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4150](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4150) - -*** - -### \_100kSatsTo1mSats - -> **\_100kSatsTo1mSats**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4151](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4151) - -*** - -### \_100satsTo1kSats - -> **\_100satsTo1kSats**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4152](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4152) - -*** - -### \_10btcTo100btc - -> **\_10btcTo100btc**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4153](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4153) - -*** - -### \_10kBtcTo100kBtc - -> **\_10kBtcTo100kBtc**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4154](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4154) - -*** - -### \_10kSatsTo100kSats - -> **\_10kSatsTo100kSats**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4155](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4155) - -*** - -### \_10mSatsTo1btc - -> **\_10mSatsTo1btc**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4156](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4156) - -*** - -### \_10satsTo100sats - -> **\_10satsTo100sats**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4157](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4157) - -*** - -### \_1btcTo10btc - -> **\_1btcTo10btc**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4158](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4158) - -*** - -### \_1kBtcTo10kBtc - -> **\_1kBtcTo10kBtc**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4159](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4159) - -*** - -### \_1kSatsTo10kSats - -> **\_1kSatsTo10kSats**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4160](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4160) - -*** - -### \_1mSatsTo10mSats - -> **\_1mSatsTo10mSats**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4161](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4161) - -*** - -### \_1satTo10sats - -> **\_1satTo10sats**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4162](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4162) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Epoch.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Epoch.md deleted file mode 100644 index c3d7ec15b..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Epoch.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_Epoch - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_Epoch - -Defined in: [Developer/brk/modules/brk-client/index.js:4166](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4166) - -## Properties - -### \_0 - -> **\_0**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4167](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4167) - -*** - -### \_1 - -> **\_1**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4168](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4168) - -*** - -### \_2 - -> **\_2**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4169](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4169) - -*** - -### \_3 - -> **\_3**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4170](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4170) - -*** - -### \_4 - -> **\_4**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4171](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4171) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_GeAmount.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_GeAmount.md deleted file mode 100644 index dc0c65e72..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_GeAmount.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_GeAmount - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_GeAmount - -Defined in: [Developer/brk/modules/brk-client/index.js:4175](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4175) - -## Properties - -### \_100btc - -> **\_100btc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4176](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4176) - -*** - -### \_100kSats - -> **\_100kSats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4177](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4177) - -*** - -### \_100sats - -> **\_100sats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4178](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4178) - -*** - -### \_10btc - -> **\_10btc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4179](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4179) - -*** - -### \_10kBtc - -> **\_10kBtc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4180](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4180) - -*** - -### \_10kSats - -> **\_10kSats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4181](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4181) - -*** - -### \_10mSats - -> **\_10mSats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4182](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4182) - -*** - -### \_10sats - -> **\_10sats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4183](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4183) - -*** - -### \_1btc - -> **\_1btc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4184](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4184) - -*** - -### \_1kBtc - -> **\_1kBtc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4185](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4185) - -*** - -### \_1kSats - -> **\_1kSats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4186](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4186) - -*** - -### \_1mSats - -> **\_1mSats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4187](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4187) - -*** - -### \_1sat - -> **\_1sat**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4188](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4188) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_LtAmount.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_LtAmount.md deleted file mode 100644 index 518fb7080..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_LtAmount.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_LtAmount - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_LtAmount - -Defined in: [Developer/brk/modules/brk-client/index.js:4192](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4192) - -## Properties - -### \_100btc - -> **\_100btc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4193](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4193) - -*** - -### \_100kBtc - -> **\_100kBtc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4194](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4194) - -*** - -### \_100kSats - -> **\_100kSats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4195](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4195) - -*** - -### \_100sats - -> **\_100sats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4196](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4196) - -*** - -### \_10btc - -> **\_10btc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4197](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4197) - -*** - -### \_10kBtc - -> **\_10kBtc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4198](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4198) - -*** - -### \_10kSats - -> **\_10kSats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4199](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4199) - -*** - -### \_10mSats - -> **\_10mSats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4200](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4200) - -*** - -### \_10sats - -> **\_10sats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4201](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4201) - -*** - -### \_1btc - -> **\_1btc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4202](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4202) - -*** - -### \_1kBtc - -> **\_1kBtc**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4203](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4203) - -*** - -### \_1kSats - -> **\_1kSats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4204](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4204) - -*** - -### \_1mSats - -> **\_1mSats**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4205](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4205) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_MaxAge.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_MaxAge.md deleted file mode 100644 index 9e76fe282..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_MaxAge.md +++ /dev/null @@ -1,153 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_MaxAge - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_MaxAge - -Defined in: [Developer/brk/modules/brk-client/index.js:4209](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4209) - -## Properties - -### \_10y - -> **\_10y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4210](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4210) - -*** - -### \_12y - -> **\_12y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4211](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4211) - -*** - -### \_15y - -> **\_15y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4212](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4212) - -*** - -### \_1m - -> **\_1m**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4213](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4213) - -*** - -### \_1w - -> **\_1w**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4214](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4214) - -*** - -### \_1y - -> **\_1y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4215](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4215) - -*** - -### \_2m - -> **\_2m**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4216](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4216) - -*** - -### \_2y - -> **\_2y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4217](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4217) - -*** - -### \_3m - -> **\_3m**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4218](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4218) - -*** - -### \_3y - -> **\_3y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4219](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4219) - -*** - -### \_4m - -> **\_4m**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4220](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4220) - -*** - -### \_4y - -> **\_4y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4221](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4221) - -*** - -### \_5m - -> **\_5m**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4222](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4222) - -*** - -### \_5y - -> **\_5y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4223](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4223) - -*** - -### \_6m - -> **\_6m**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4224](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4224) - -*** - -### \_6y - -> **\_6y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4225](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4225) - -*** - -### \_7y - -> **\_7y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4226](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4226) - -*** - -### \_8y - -> **\_8y**: [`_10yPattern`](10yPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4227](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4227) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_MinAge.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_MinAge.md deleted file mode 100644 index ef6e63559..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_MinAge.md +++ /dev/null @@ -1,153 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_MinAge - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_MinAge - -Defined in: [Developer/brk/modules/brk-client/index.js:4231](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4231) - -## Properties - -### \_10y - -> **\_10y**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4232](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4232) - -*** - -### \_12y - -> **\_12y**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4233](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4233) - -*** - -### \_1d - -> **\_1d**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4234](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4234) - -*** - -### \_1m - -> **\_1m**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4235](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4235) - -*** - -### \_1w - -> **\_1w**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4236](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4236) - -*** - -### \_1y - -> **\_1y**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4237](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4237) - -*** - -### \_2m - -> **\_2m**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4238](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4238) - -*** - -### \_2y - -> **\_2y**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4239](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4239) - -*** - -### \_3m - -> **\_3m**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4240](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4240) - -*** - -### \_3y - -> **\_3y**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4241](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4241) - -*** - -### \_4m - -> **\_4m**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4242](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4242) - -*** - -### \_4y - -> **\_4y**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4243](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4243) - -*** - -### \_5m - -> **\_5m**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4244](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4244) - -*** - -### \_5y - -> **\_5y**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4245](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4245) - -*** - -### \_6m - -> **\_6m**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4246](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4246) - -*** - -### \_6y - -> **\_6y**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4247](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4247) - -*** - -### \_7y - -> **\_7y**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4248](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4248) - -*** - -### \_8y - -> **\_8y**: [`_100btcPattern`](100btcPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4249](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4249) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term.md deleted file mode 100644 index 4664bf5b7..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_Term - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_Term - -Defined in: [Developer/brk/modules/brk-client/index.js:4253](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4253) - -## Properties - -### long - -> **long**: [`CatalogTree_Distribution_UtxoCohorts_Term_Long`](CatalogTree_Distribution_UtxoCohorts_Term_Long.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4254](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4254) - -*** - -### short - -> **short**: [`CatalogTree_Distribution_UtxoCohorts_Term_Short`](CatalogTree_Distribution_UtxoCohorts_Term_Short.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4255](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4255) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Long.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Long.md deleted file mode 100644 index 55fd028a9..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Long.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_Term\_Long - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_Term\_Long - -Defined in: [Developer/brk/modules/brk-client/index.js:4259](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4259) - -## Properties - -### activity - -> **activity**: [`ActivityPattern2`](ActivityPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4260](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4260) - -*** - -### costBasis - -> **costBasis**: [`CatalogTree_Distribution_UtxoCohorts_Term_Long_CostBasis`](CatalogTree_Distribution_UtxoCohorts_Term_Long_CostBasis.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4261](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4261) - -*** - -### outputs - -> **outputs**: [`OutputsPattern`](OutputsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4262](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4262) - -*** - -### realized - -> **realized**: [`RealizedPattern2`](RealizedPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4263](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4263) - -*** - -### relative - -> **relative**: [`RelativePattern5`](RelativePattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4264](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4264) - -*** - -### supply - -> **supply**: [`SupplyPattern2`](SupplyPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4265](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4265) - -*** - -### unrealized - -> **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4266](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4266) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Long_CostBasis.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Long_CostBasis.md deleted file mode 100644 index 25e9c361b..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Long_CostBasis.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_Term\_Long\_CostBasis - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_Term\_Long\_CostBasis - -Defined in: [Developer/brk/modules/brk-client/index.js:4270](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4270) - -## Properties - -### max - -> **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4271](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4271) - -*** - -### min - -> **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4272](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4272) - -*** - -### percentiles - -> **percentiles**: [`PercentilesPattern`](PercentilesPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4273](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4273) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Short.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Short.md deleted file mode 100644 index 8cb1815be..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Short.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_Term\_Short - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_Term\_Short - -Defined in: [Developer/brk/modules/brk-client/index.js:4277](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4277) - -## Properties - -### activity - -> **activity**: [`ActivityPattern2`](ActivityPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4278](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4278) - -*** - -### costBasis - -> **costBasis**: [`CatalogTree_Distribution_UtxoCohorts_Term_Short_CostBasis`](CatalogTree_Distribution_UtxoCohorts_Term_Short_CostBasis.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4279](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4279) - -*** - -### outputs - -> **outputs**: [`OutputsPattern`](OutputsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4280](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4280) - -*** - -### realized - -> **realized**: [`RealizedPattern3`](RealizedPattern3.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4281](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4281) - -*** - -### relative - -> **relative**: [`RelativePattern5`](RelativePattern5.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4282](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4282) - -*** - -### supply - -> **supply**: [`SupplyPattern2`](SupplyPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4283](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4283) - -*** - -### unrealized - -> **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4284](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4284) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Short_CostBasis.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Short_CostBasis.md deleted file mode 100644 index 9c09b5828..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Term_Short_CostBasis.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_Term\_Short\_CostBasis - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_Term\_Short\_CostBasis - -Defined in: [Developer/brk/modules/brk-client/index.js:4288](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4288) - -## Properties - -### max - -> **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4289](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4289) - -*** - -### min - -> **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4290](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4290) - -*** - -### percentiles - -> **percentiles**: [`PercentilesPattern`](PercentilesPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4291](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4291) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Type.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Type.md deleted file mode 100644 index 14f9a5f98..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Type.md +++ /dev/null @@ -1,97 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_Type - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_Type - -Defined in: [Developer/brk/modules/brk-client/index.js:4295](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4295) - -## Properties - -### empty - -> **empty**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4296](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4296) - -*** - -### p2a - -> **p2a**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4297](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4297) - -*** - -### p2ms - -> **p2ms**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4298](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4298) - -*** - -### p2pk33 - -> **p2pk33**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4299](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4299) - -*** - -### p2pk65 - -> **p2pk65**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4300](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4300) - -*** - -### p2pkh - -> **p2pkh**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4301](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4301) - -*** - -### p2sh - -> **p2sh**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4302](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4302) - -*** - -### p2tr - -> **p2tr**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4303](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4303) - -*** - -### p2wpkh - -> **p2wpkh**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4304](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4304) - -*** - -### p2wsh - -> **p2wsh**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4305](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4305) - -*** - -### unknown - -> **unknown**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4306](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4306) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Year.md b/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Year.md deleted file mode 100644 index 40dfbe2e8..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Distribution_UtxoCohorts_Year.md +++ /dev/null @@ -1,153 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Distribution\_UtxoCohorts\_Year - -# Interface: CatalogTree\_Distribution\_UtxoCohorts\_Year - -Defined in: [Developer/brk/modules/brk-client/index.js:4310](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4310) - -## Properties - -### \_2009 - -> **\_2009**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4311](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4311) - -*** - -### \_2010 - -> **\_2010**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4312](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4312) - -*** - -### \_2011 - -> **\_2011**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4313](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4313) - -*** - -### \_2012 - -> **\_2012**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4314](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4314) - -*** - -### \_2013 - -> **\_2013**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4315](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4315) - -*** - -### \_2014 - -> **\_2014**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4316](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4316) - -*** - -### \_2015 - -> **\_2015**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4317](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4317) - -*** - -### \_2016 - -> **\_2016**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4318](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4318) - -*** - -### \_2017 - -> **\_2017**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4319](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4319) - -*** - -### \_2018 - -> **\_2018**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4320](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4320) - -*** - -### \_2019 - -> **\_2019**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4321](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4321) - -*** - -### \_2020 - -> **\_2020**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4322](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4322) - -*** - -### \_2021 - -> **\_2021**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4323](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4323) - -*** - -### \_2022 - -> **\_2022**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4324](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4324) - -*** - -### \_2023 - -> **\_2023**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4325](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4325) - -*** - -### \_2024 - -> **\_2024**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4326](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4326) - -*** - -### \_2025 - -> **\_2025**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4327](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4327) - -*** - -### \_2026 - -> **\_2026**: [`_0satsPattern2`](0satsPattern2.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4328](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4328) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes.md deleted file mode 100644 index 670e6adce..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes.md +++ /dev/null @@ -1,121 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes - -# Interface: CatalogTree\_Indexes - -Defined in: [Developer/brk/modules/brk-client/index.js:4332](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4332) - -## Properties - -### address - -> **address**: [`CatalogTree_Indexes_Address`](CatalogTree_Indexes_Address.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4333](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4333) - -*** - -### dateindex - -> **dateindex**: [`CatalogTree_Indexes_Dateindex`](CatalogTree_Indexes_Dateindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4334](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4334) - -*** - -### decadeindex - -> **decadeindex**: [`CatalogTree_Indexes_Decadeindex`](CatalogTree_Indexes_Decadeindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4335](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4335) - -*** - -### difficultyepoch - -> **difficultyepoch**: [`CatalogTree_Indexes_Difficultyepoch`](CatalogTree_Indexes_Difficultyepoch.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4336](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4336) - -*** - -### halvingepoch - -> **halvingepoch**: [`CatalogTree_Indexes_Halvingepoch`](CatalogTree_Indexes_Halvingepoch.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4337](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4337) - -*** - -### height - -> **height**: [`CatalogTree_Indexes_Height`](CatalogTree_Indexes_Height.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4338](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4338) - -*** - -### monthindex - -> **monthindex**: [`CatalogTree_Indexes_Monthindex`](CatalogTree_Indexes_Monthindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4339](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4339) - -*** - -### quarterindex - -> **quarterindex**: [`CatalogTree_Indexes_Quarterindex`](CatalogTree_Indexes_Quarterindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4340](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4340) - -*** - -### semesterindex - -> **semesterindex**: [`CatalogTree_Indexes_Semesterindex`](CatalogTree_Indexes_Semesterindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4341](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4341) - -*** - -### txindex - -> **txindex**: [`CatalogTree_Indexes_Txindex`](CatalogTree_Indexes_Txindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4342](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4342) - -*** - -### txinindex - -> **txinindex**: [`CatalogTree_Indexes_Txinindex`](CatalogTree_Indexes_Txinindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4343](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4343) - -*** - -### txoutindex - -> **txoutindex**: [`CatalogTree_Indexes_Txoutindex`](CatalogTree_Indexes_Txoutindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4344](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4344) - -*** - -### weekindex - -> **weekindex**: [`CatalogTree_Indexes_Weekindex`](CatalogTree_Indexes_Weekindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4345](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4345) - -*** - -### yearindex - -> **yearindex**: [`CatalogTree_Indexes_Yearindex`](CatalogTree_Indexes_Yearindex.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4346](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4346) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address.md deleted file mode 100644 index e6e8326a2..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address.md +++ /dev/null @@ -1,105 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address - -# Interface: CatalogTree\_Indexes\_Address - -Defined in: [Developer/brk/modules/brk-client/index.js:4350](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4350) - -## Properties - -### empty - -> **empty**: [`CatalogTree_Indexes_Address_Empty`](CatalogTree_Indexes_Address_Empty.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4351](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4351) - -*** - -### opreturn - -> **opreturn**: [`CatalogTree_Indexes_Address_Opreturn`](CatalogTree_Indexes_Address_Opreturn.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4352](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4352) - -*** - -### p2a - -> **p2a**: [`CatalogTree_Indexes_Address_P2a`](CatalogTree_Indexes_Address_P2a.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4353](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4353) - -*** - -### p2ms - -> **p2ms**: [`CatalogTree_Indexes_Address_P2ms`](CatalogTree_Indexes_Address_P2ms.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4354](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4354) - -*** - -### p2pk33 - -> **p2pk33**: [`CatalogTree_Indexes_Address_P2pk33`](CatalogTree_Indexes_Address_P2pk33.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4355](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4355) - -*** - -### p2pk65 - -> **p2pk65**: [`CatalogTree_Indexes_Address_P2pk65`](CatalogTree_Indexes_Address_P2pk65.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4356](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4356) - -*** - -### p2pkh - -> **p2pkh**: [`CatalogTree_Indexes_Address_P2pkh`](CatalogTree_Indexes_Address_P2pkh.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4357](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4357) - -*** - -### p2sh - -> **p2sh**: [`CatalogTree_Indexes_Address_P2sh`](CatalogTree_Indexes_Address_P2sh.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4358](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4358) - -*** - -### p2tr - -> **p2tr**: [`CatalogTree_Indexes_Address_P2tr`](CatalogTree_Indexes_Address_P2tr.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4359](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4359) - -*** - -### p2wpkh - -> **p2wpkh**: [`CatalogTree_Indexes_Address_P2wpkh`](CatalogTree_Indexes_Address_P2wpkh.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4360](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4360) - -*** - -### p2wsh - -> **p2wsh**: [`CatalogTree_Indexes_Address_P2wsh`](CatalogTree_Indexes_Address_P2wsh.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4361](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4361) - -*** - -### unknown - -> **unknown**: [`CatalogTree_Indexes_Address_Unknown`](CatalogTree_Indexes_Address_Unknown.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4362](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4362) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_Empty.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_Empty.md deleted file mode 100644 index 395893edc..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_Empty.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_Empty - -# Interface: CatalogTree\_Indexes\_Address\_Empty - -Defined in: [Developer/brk/modules/brk-client/index.js:4366](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4366) - -## Properties - -### identity - -> **identity**: [`MetricPattern9`](../type-aliases/MetricPattern9.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4367](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4367) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_Opreturn.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_Opreturn.md deleted file mode 100644 index 7c35222e8..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_Opreturn.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_Opreturn - -# Interface: CatalogTree\_Indexes\_Address\_Opreturn - -Defined in: [Developer/brk/modules/brk-client/index.js:4371](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4371) - -## Properties - -### identity - -> **identity**: [`MetricPattern14`](../type-aliases/MetricPattern14.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4372](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4372) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2a.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2a.md deleted file mode 100644 index 24a7ef03d..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2a.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_P2a - -# Interface: CatalogTree\_Indexes\_Address\_P2a - -Defined in: [Developer/brk/modules/brk-client/index.js:4376](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4376) - -## Properties - -### identity - -> **identity**: [`MetricPattern16`](../type-aliases/MetricPattern16.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4377](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4377) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2ms.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2ms.md deleted file mode 100644 index 65be09e9a..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2ms.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_P2ms - -# Interface: CatalogTree\_Indexes\_Address\_P2ms - -Defined in: [Developer/brk/modules/brk-client/index.js:4381](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4381) - -## Properties - -### identity - -> **identity**: [`MetricPattern17`](../type-aliases/MetricPattern17.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4382](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4382) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2pk33.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2pk33.md deleted file mode 100644 index 75b6e2d75..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2pk33.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_P2pk33 - -# Interface: CatalogTree\_Indexes\_Address\_P2pk33 - -Defined in: [Developer/brk/modules/brk-client/index.js:4386](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4386) - -## Properties - -### identity - -> **identity**: [`MetricPattern18`](../type-aliases/MetricPattern18.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4387](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4387) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2pk65.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2pk65.md deleted file mode 100644 index 8e781c87c..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2pk65.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_P2pk65 - -# Interface: CatalogTree\_Indexes\_Address\_P2pk65 - -Defined in: [Developer/brk/modules/brk-client/index.js:4391](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4391) - -## Properties - -### identity - -> **identity**: [`MetricPattern19`](../type-aliases/MetricPattern19.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4392](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4392) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2pkh.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2pkh.md deleted file mode 100644 index 8d60c735a..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2pkh.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_P2pkh - -# Interface: CatalogTree\_Indexes\_Address\_P2pkh - -Defined in: [Developer/brk/modules/brk-client/index.js:4396](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4396) - -## Properties - -### identity - -> **identity**: [`MetricPattern20`](../type-aliases/MetricPattern20.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4397](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4397) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2sh.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2sh.md deleted file mode 100644 index 338b9e085..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2sh.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_P2sh - -# Interface: CatalogTree\_Indexes\_Address\_P2sh - -Defined in: [Developer/brk/modules/brk-client/index.js:4401](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4401) - -## Properties - -### identity - -> **identity**: [`MetricPattern21`](../type-aliases/MetricPattern21.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4402](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4402) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2tr.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2tr.md deleted file mode 100644 index bb665d1d0..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2tr.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_P2tr - -# Interface: CatalogTree\_Indexes\_Address\_P2tr - -Defined in: [Developer/brk/modules/brk-client/index.js:4406](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4406) - -## Properties - -### identity - -> **identity**: [`MetricPattern22`](../type-aliases/MetricPattern22.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4407](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4407) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2wpkh.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2wpkh.md deleted file mode 100644 index 36fecf966..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2wpkh.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_P2wpkh - -# Interface: CatalogTree\_Indexes\_Address\_P2wpkh - -Defined in: [Developer/brk/modules/brk-client/index.js:4411](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4411) - -## Properties - -### identity - -> **identity**: [`MetricPattern23`](../type-aliases/MetricPattern23.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4412](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4412) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2wsh.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2wsh.md deleted file mode 100644 index 295e025d6..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_P2wsh.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_P2wsh - -# Interface: CatalogTree\_Indexes\_Address\_P2wsh - -Defined in: [Developer/brk/modules/brk-client/index.js:4416](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4416) - -## Properties - -### identity - -> **identity**: [`MetricPattern24`](../type-aliases/MetricPattern24.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4417](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4417) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_Unknown.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_Unknown.md deleted file mode 100644 index 3d13e78ef..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Address_Unknown.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Address\_Unknown - -# Interface: CatalogTree\_Indexes\_Address\_Unknown - -Defined in: [Developer/brk/modules/brk-client/index.js:4421](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4421) - -## Properties - -### identity - -> **identity**: [`MetricPattern28`](../type-aliases/MetricPattern28.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4422](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4422) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Dateindex.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Dateindex.md deleted file mode 100644 index 8cdf626e4..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Dateindex.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Dateindex - -# Interface: CatalogTree\_Indexes\_Dateindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4426](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4426) - -## Properties - -### date - -> **date**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4427](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4427) - -*** - -### firstHeight - -> **firstHeight**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4428](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4428) - -*** - -### heightCount - -> **heightCount**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4429](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4429) - -*** - -### identity - -> **identity**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4430](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4430) - -*** - -### monthindex - -> **monthindex**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4431](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4431) - -*** - -### weekindex - -> **weekindex**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4432](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4432) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Decadeindex.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Decadeindex.md deleted file mode 100644 index 65e2ef484..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Decadeindex.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Decadeindex - -# Interface: CatalogTree\_Indexes\_Decadeindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4436](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4436) - -## Properties - -### firstYearindex - -> **firstYearindex**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4437](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4437) - -*** - -### identity - -> **identity**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4438](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4438) - -*** - -### yearindexCount - -> **yearindexCount**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4439](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4439) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Difficultyepoch.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Difficultyepoch.md deleted file mode 100644 index 3770cb5b8..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Difficultyepoch.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Difficultyepoch - -# Interface: CatalogTree\_Indexes\_Difficultyepoch - -Defined in: [Developer/brk/modules/brk-client/index.js:4443](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4443) - -## Properties - -### firstHeight - -> **firstHeight**: [`MetricPattern8`](../type-aliases/MetricPattern8.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4444](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4444) - -*** - -### heightCount - -> **heightCount**: [`MetricPattern8`](../type-aliases/MetricPattern8.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4445](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4445) - -*** - -### identity - -> **identity**: [`MetricPattern8`](../type-aliases/MetricPattern8.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4446](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4446) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Halvingepoch.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Halvingepoch.md deleted file mode 100644 index 284e9c83c..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Halvingepoch.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Halvingepoch - -# Interface: CatalogTree\_Indexes\_Halvingepoch - -Defined in: [Developer/brk/modules/brk-client/index.js:4450](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4450) - -## Properties - -### firstHeight - -> **firstHeight**: [`MetricPattern10`](../type-aliases/MetricPattern10.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4451](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4451) - -*** - -### identity - -> **identity**: [`MetricPattern10`](../type-aliases/MetricPattern10.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4452](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4452) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Height.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Height.md deleted file mode 100644 index 48e82b2cd..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Height.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Height - -# Interface: CatalogTree\_Indexes\_Height - -Defined in: [Developer/brk/modules/brk-client/index.js:4456](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4456) - -## Properties - -### dateindex - -> **dateindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4457](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4457) - -*** - -### difficultyepoch - -> **difficultyepoch**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4458](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4458) - -*** - -### halvingepoch - -> **halvingepoch**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4459](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4459) - -*** - -### identity - -> **identity**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4460](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4460) - -*** - -### txindexCount - -> **txindexCount**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4461](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4461) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Monthindex.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Monthindex.md deleted file mode 100644 index e3ff2f485..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Monthindex.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Monthindex - -# Interface: CatalogTree\_Indexes\_Monthindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4465](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4465) - -## Properties - -### dateindexCount - -> **dateindexCount**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4466](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4466) - -*** - -### firstDateindex - -> **firstDateindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4467](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4467) - -*** - -### identity - -> **identity**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4468](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4468) - -*** - -### quarterindex - -> **quarterindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4469](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4469) - -*** - -### semesterindex - -> **semesterindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4470](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4470) - -*** - -### yearindex - -> **yearindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4471](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4471) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Quarterindex.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Quarterindex.md deleted file mode 100644 index 965f084c9..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Quarterindex.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Quarterindex - -# Interface: CatalogTree\_Indexes\_Quarterindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4475](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4475) - -## Properties - -### firstMonthindex - -> **firstMonthindex**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4476](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4476) - -*** - -### identity - -> **identity**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4477](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4477) - -*** - -### monthindexCount - -> **monthindexCount**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4478](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4478) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Semesterindex.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Semesterindex.md deleted file mode 100644 index 1c0dc85d0..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Semesterindex.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Semesterindex - -# Interface: CatalogTree\_Indexes\_Semesterindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4482](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4482) - -## Properties - -### firstMonthindex - -> **firstMonthindex**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4483](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4483) - -*** - -### identity - -> **identity**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4484](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4484) - -*** - -### monthindexCount - -> **monthindexCount**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4485](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4485) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Txindex.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Txindex.md deleted file mode 100644 index d26eeda27..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Txindex.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Txindex - -# Interface: CatalogTree\_Indexes\_Txindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4489](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4489) - -## Properties - -### identity - -> **identity**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4490](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4490) - -*** - -### inputCount - -> **inputCount**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4491](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4491) - -*** - -### outputCount - -> **outputCount**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4492](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4492) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Txinindex.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Txinindex.md deleted file mode 100644 index 6398b423a..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Txinindex.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Txinindex - -# Interface: CatalogTree\_Indexes\_Txinindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4496](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4496) - -## Properties - -### identity - -> **identity**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4497](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4497) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Txoutindex.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Txoutindex.md deleted file mode 100644 index 23fcf7b3f..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Txoutindex.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Txoutindex - -# Interface: CatalogTree\_Indexes\_Txoutindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4501](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4501) - -## Properties - -### identity - -> **identity**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4502](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4502) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Weekindex.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Weekindex.md deleted file mode 100644 index 5ed7286f4..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Weekindex.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Weekindex - -# Interface: CatalogTree\_Indexes\_Weekindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4506](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4506) - -## Properties - -### dateindexCount - -> **dateindexCount**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4507](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4507) - -*** - -### firstDateindex - -> **firstDateindex**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4508](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4508) - -*** - -### identity - -> **identity**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4509](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4509) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Yearindex.md b/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Yearindex.md deleted file mode 100644 index 8b9bdb817..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Indexes_Yearindex.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Indexes\_Yearindex - -# Interface: CatalogTree\_Indexes\_Yearindex - -Defined in: [Developer/brk/modules/brk-client/index.js:4513](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4513) - -## Properties - -### decadeindex - -> **decadeindex**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4514](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4514) - -*** - -### firstMonthindex - -> **firstMonthindex**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4515](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4515) - -*** - -### identity - -> **identity**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4516](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4516) - -*** - -### monthindexCount - -> **monthindexCount**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4517](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4517) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Inputs.md b/modules/brk-client/docs/interfaces/CatalogTree_Inputs.md deleted file mode 100644 index 319ab8e8d..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Inputs.md +++ /dev/null @@ -1,73 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Inputs - -# Interface: CatalogTree\_Inputs - -Defined in: [Developer/brk/modules/brk-client/index.js:4521](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4521) - -## Properties - -### count - -> **count**: [`CountPattern2`](CountPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4522](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4522) - -*** - -### firstTxinindex - -> **firstTxinindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4523](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4523) - -*** - -### outpoint - -> **outpoint**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4524](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4524) - -*** - -### outputtype - -> **outputtype**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<[`OutputType`](../type-aliases/OutputType.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4525](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4525) - -*** - -### spent - -> **spent**: [`CatalogTree_Inputs_Spent`](CatalogTree_Inputs_Spent.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4526](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4526) - -*** - -### txindex - -> **txindex**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4527](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4527) - -*** - -### typeindex - -> **typeindex**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4528](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4528) - -*** - -### witnessSize - -> **witnessSize**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4529](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4529) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Inputs_Spent.md b/modules/brk-client/docs/interfaces/CatalogTree_Inputs_Spent.md deleted file mode 100644 index 602b2b99b..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Inputs_Spent.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Inputs\_Spent - -# Interface: CatalogTree\_Inputs\_Spent - -Defined in: [Developer/brk/modules/brk-client/index.js:4533](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4533) - -## Properties - -### txoutindex - -> **txoutindex**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4534](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4534) - -*** - -### value - -> **value**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4535](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4535) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market.md b/modules/brk-client/docs/interfaces/CatalogTree_Market.md deleted file mode 100644 index 23d3e06d5..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market.md +++ /dev/null @@ -1,73 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market - -# Interface: CatalogTree\_Market - -Defined in: [Developer/brk/modules/brk-client/index.js:4539](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4539) - -## Properties - -### ath - -> **ath**: [`CatalogTree_Market_Ath`](CatalogTree_Market_Ath.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4540](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4540) - -*** - -### dca - -> **dca**: [`CatalogTree_Market_Dca`](CatalogTree_Market_Dca.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4541](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4541) - -*** - -### indicators - -> **indicators**: [`CatalogTree_Market_Indicators`](CatalogTree_Market_Indicators.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4542](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4542) - -*** - -### lookback - -> **lookback**: [`CatalogTree_Market_Lookback`](CatalogTree_Market_Lookback.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4543](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4543) - -*** - -### movingAverage - -> **movingAverage**: [`CatalogTree_Market_MovingAverage`](CatalogTree_Market_MovingAverage.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4544](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4544) - -*** - -### range - -> **range**: [`CatalogTree_Market_Range`](CatalogTree_Market_Range.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4545](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4545) - -*** - -### returns - -> **returns**: [`CatalogTree_Market_Returns`](CatalogTree_Market_Returns.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4546](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4546) - -*** - -### volatility - -> **volatility**: [`CatalogTree_Market_Volatility`](CatalogTree_Market_Volatility.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4547](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4547) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Ath.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Ath.md deleted file mode 100644 index ba44355d0..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Ath.md +++ /dev/null @@ -1,57 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Ath - -# Interface: CatalogTree\_Market\_Ath - -Defined in: [Developer/brk/modules/brk-client/index.js:4551](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4551) - -## Properties - -### daysSincePriceAth - -> **daysSincePriceAth**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4552](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4552) - -*** - -### maxDaysBetweenPriceAths - -> **maxDaysBetweenPriceAths**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4553](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4553) - -*** - -### maxYearsBetweenPriceAths - -> **maxYearsBetweenPriceAths**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4554](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4554) - -*** - -### priceAth - -> **priceAth**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4555](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4555) - -*** - -### priceDrawdown - -> **priceDrawdown**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4556](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4556) - -*** - -### yearsSincePriceAth - -> **yearsSincePriceAth**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4557](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4557) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca.md deleted file mode 100644 index a6b5a2a54..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca.md +++ /dev/null @@ -1,73 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Dca - -# Interface: CatalogTree\_Market\_Dca - -Defined in: [Developer/brk/modules/brk-client/index.js:4561](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4561) - -## Properties - -### classAveragePrice - -> **classAveragePrice**: [`CatalogTree_Market_Dca_ClassAveragePrice`](CatalogTree_Market_Dca_ClassAveragePrice.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4562](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4562) - -*** - -### classReturns - -> **classReturns**: [`CatalogTree_Market_Dca_ClassReturns`](CatalogTree_Market_Dca_ClassReturns.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4563](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4563) - -*** - -### classStack - -> **classStack**: [`CatalogTree_Market_Dca_ClassStack`](CatalogTree_Market_Dca_ClassStack.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4564](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4564) - -*** - -### periodAveragePrice - -> **periodAveragePrice**: [`PeriodAveragePricePattern`](PeriodAveragePricePattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4565](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4565) - -*** - -### periodCagr - -> **periodCagr**: [`PeriodCagrPattern`](PeriodCagrPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4566](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4566) - -*** - -### periodLumpSumStack - -> **periodLumpSumStack**: [`PeriodLumpSumStackPattern`](PeriodLumpSumStackPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4567](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4567) - -*** - -### periodReturns - -> **periodReturns**: [`PeriodAveragePricePattern`](PeriodAveragePricePattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4568](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4568) - -*** - -### periodStack - -> **periodStack**: [`PeriodLumpSumStackPattern`](PeriodLumpSumStackPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4569](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4569) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca_ClassAveragePrice.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca_ClassAveragePrice.md deleted file mode 100644 index ce5ccf8c9..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca_ClassAveragePrice.md +++ /dev/null @@ -1,97 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Dca\_ClassAveragePrice - -# Interface: CatalogTree\_Market\_Dca\_ClassAveragePrice - -Defined in: [Developer/brk/modules/brk-client/index.js:4573](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4573) - -## Properties - -### \_2015 - -> **\_2015**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4574](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4574) - -*** - -### \_2016 - -> **\_2016**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4575](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4575) - -*** - -### \_2017 - -> **\_2017**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4576](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4576) - -*** - -### \_2018 - -> **\_2018**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4577](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4577) - -*** - -### \_2019 - -> **\_2019**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4578](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4578) - -*** - -### \_2020 - -> **\_2020**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4579](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4579) - -*** - -### \_2021 - -> **\_2021**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4580](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4580) - -*** - -### \_2022 - -> **\_2022**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4581](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4581) - -*** - -### \_2023 - -> **\_2023**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4582](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4582) - -*** - -### \_2024 - -> **\_2024**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4583](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4583) - -*** - -### \_2025 - -> **\_2025**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4584](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4584) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca_ClassReturns.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca_ClassReturns.md deleted file mode 100644 index e75c1ae2c..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca_ClassReturns.md +++ /dev/null @@ -1,97 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Dca\_ClassReturns - -# Interface: CatalogTree\_Market\_Dca\_ClassReturns - -Defined in: [Developer/brk/modules/brk-client/index.js:4588](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4588) - -## Properties - -### \_2015 - -> **\_2015**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4589](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4589) - -*** - -### \_2016 - -> **\_2016**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4590](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4590) - -*** - -### \_2017 - -> **\_2017**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4591](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4591) - -*** - -### \_2018 - -> **\_2018**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4592](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4592) - -*** - -### \_2019 - -> **\_2019**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4593](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4593) - -*** - -### \_2020 - -> **\_2020**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4594](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4594) - -*** - -### \_2021 - -> **\_2021**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4595](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4595) - -*** - -### \_2022 - -> **\_2022**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4596](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4596) - -*** - -### \_2023 - -> **\_2023**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4597](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4597) - -*** - -### \_2024 - -> **\_2024**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4598](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4598) - -*** - -### \_2025 - -> **\_2025**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4599](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4599) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca_ClassStack.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca_ClassStack.md deleted file mode 100644 index 61623c3b1..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Dca_ClassStack.md +++ /dev/null @@ -1,97 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Dca\_ClassStack - -# Interface: CatalogTree\_Market\_Dca\_ClassStack - -Defined in: [Developer/brk/modules/brk-client/index.js:4603](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4603) - -## Properties - -### \_2015 - -> **\_2015**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4604](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4604) - -*** - -### \_2016 - -> **\_2016**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4605](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4605) - -*** - -### \_2017 - -> **\_2017**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4606](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4606) - -*** - -### \_2018 - -> **\_2018**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4607](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4607) - -*** - -### \_2019 - -> **\_2019**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4608](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4608) - -*** - -### \_2020 - -> **\_2020**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4609](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4609) - -*** - -### \_2021 - -> **\_2021**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4610](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4610) - -*** - -### \_2022 - -> **\_2022**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4611](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4611) - -*** - -### \_2023 - -> **\_2023**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4612](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4612) - -*** - -### \_2024 - -> **\_2024**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4613](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4613) - -*** - -### \_2025 - -> **\_2025**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4614](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4614) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Indicators.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Indicators.md deleted file mode 100644 index e70cb06bf..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Indicators.md +++ /dev/null @@ -1,161 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Indicators - -# Interface: CatalogTree\_Market\_Indicators - -Defined in: [Developer/brk/modules/brk-client/index.js:4618](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4618) - -## Properties - -### gini - -> **gini**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4619](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4619) - -*** - -### macdHistogram - -> **macdHistogram**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4620](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4620) - -*** - -### macdLine - -> **macdLine**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4621](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4621) - -*** - -### macdSignal - -> **macdSignal**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4622](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4622) - -*** - -### nvt - -> **nvt**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4623](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4623) - -*** - -### piCycle - -> **piCycle**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4624](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4624) - -*** - -### puellMultiple - -> **puellMultiple**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4625](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4625) - -*** - -### rsi14d - -> **rsi14d**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4626](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4626) - -*** - -### rsi14dMax - -> **rsi14dMax**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4627](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4627) - -*** - -### rsi14dMin - -> **rsi14dMin**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4628](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4628) - -*** - -### rsiAverageGain14d - -> **rsiAverageGain14d**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4629](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4629) - -*** - -### rsiAverageLoss14d - -> **rsiAverageLoss14d**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4630](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4630) - -*** - -### rsiGains - -> **rsiGains**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4631](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4631) - -*** - -### rsiLosses - -> **rsiLosses**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4632](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4632) - -*** - -### stochD - -> **stochD**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4633](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4633) - -*** - -### stochK - -> **stochK**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4634](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4634) - -*** - -### stochRsi - -> **stochRsi**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4635](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4635) - -*** - -### stochRsiD - -> **stochRsiD**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4636](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4636) - -*** - -### stochRsiK - -> **stochRsiK**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4637](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4637) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Lookback.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Lookback.md deleted file mode 100644 index 4d543aa0b..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Lookback.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Lookback - -# Interface: CatalogTree\_Market\_Lookback - -Defined in: [Developer/brk/modules/brk-client/index.js:4641](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4641) - -## Properties - -### priceAgo - -> **priceAgo**: [`CatalogTree_Market_Lookback_PriceAgo`](CatalogTree_Market_Lookback_PriceAgo.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4642](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4642) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Lookback_PriceAgo.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Lookback_PriceAgo.md deleted file mode 100644 index 5aa3dc3d4..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Lookback_PriceAgo.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Lookback\_PriceAgo - -# Interface: CatalogTree\_Market\_Lookback\_PriceAgo - -Defined in: [Developer/brk/modules/brk-client/index.js:4646](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4646) - -## Properties - -### \_10y - -> **\_10y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4647](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4647) - -*** - -### \_1d - -> **\_1d**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4648](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4648) - -*** - -### \_1m - -> **\_1m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4649](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4649) - -*** - -### \_1w - -> **\_1w**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4650](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4650) - -*** - -### \_1y - -> **\_1y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4651](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4651) - -*** - -### \_2y - -> **\_2y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4652](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4652) - -*** - -### \_3m - -> **\_3m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4653](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4653) - -*** - -### \_3y - -> **\_3y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4654](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4654) - -*** - -### \_4y - -> **\_4y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4655](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4655) - -*** - -### \_5y - -> **\_5y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4656](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4656) - -*** - -### \_6m - -> **\_6m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4657](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4657) - -*** - -### \_6y - -> **\_6y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4658](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4658) - -*** - -### \_8y - -> **\_8y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4659](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4659) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_MovingAverage.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_MovingAverage.md deleted file mode 100644 index df035bf95..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_MovingAverage.md +++ /dev/null @@ -1,289 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_MovingAverage - -# Interface: CatalogTree\_Market\_MovingAverage - -Defined in: [Developer/brk/modules/brk-client/index.js:4663](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4663) - -## Properties - -### price111dSma - -> **price111dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4664](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4664) - -*** - -### price12dEma - -> **price12dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4665](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4665) - -*** - -### price13dEma - -> **price13dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4666](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4666) - -*** - -### price13dSma - -> **price13dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4667](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4667) - -*** - -### price144dEma - -> **price144dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4668](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4668) - -*** - -### price144dSma - -> **price144dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4669](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4669) - -*** - -### price1mEma - -> **price1mEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4670](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4670) - -*** - -### price1mSma - -> **price1mSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4671](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4671) - -*** - -### price1wEma - -> **price1wEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4672](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4672) - -*** - -### price1wSma - -> **price1wSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4673](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4673) - -*** - -### price1yEma - -> **price1yEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4674](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4674) - -*** - -### price1ySma - -> **price1ySma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4675](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4675) - -*** - -### price200dEma - -> **price200dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4676](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4676) - -*** - -### price200dSma - -> **price200dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4677](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4677) - -*** - -### price200dSmaX08 - -> **price200dSmaX08**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4678](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4678) - -*** - -### price200dSmaX24 - -> **price200dSmaX24**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4679](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4679) - -*** - -### price200wEma - -> **price200wEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4680](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4680) - -*** - -### price200wSma - -> **price200wSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4681](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4681) - -*** - -### price21dEma - -> **price21dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4682](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4682) - -*** - -### price21dSma - -> **price21dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4683](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4683) - -*** - -### price26dEma - -> **price26dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4684](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4684) - -*** - -### price2yEma - -> **price2yEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4685](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4685) - -*** - -### price2ySma - -> **price2ySma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4686](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4686) - -*** - -### price34dEma - -> **price34dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4687](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4687) - -*** - -### price34dSma - -> **price34dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4688](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4688) - -*** - -### price350dSma - -> **price350dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4689](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4689) - -*** - -### price350dSmaX2 - -> **price350dSmaX2**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4690](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4690) - -*** - -### price4yEma - -> **price4yEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4691](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4691) - -*** - -### price4ySma - -> **price4ySma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4692](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4692) - -*** - -### price55dEma - -> **price55dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4693](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4693) - -*** - -### price55dSma - -> **price55dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4694](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4694) - -*** - -### price89dEma - -> **price89dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4695](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4695) - -*** - -### price89dSma - -> **price89dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4696](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4696) - -*** - -### price8dEma - -> **price8dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4697](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4697) - -*** - -### price8dSma - -> **price8dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4698](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4698) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Range.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Range.md deleted file mode 100644 index b97bd1b6a..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Range.md +++ /dev/null @@ -1,97 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Range - -# Interface: CatalogTree\_Market\_Range - -Defined in: [Developer/brk/modules/brk-client/index.js:4702](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4702) - -## Properties - -### price1mMax - -> **price1mMax**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4703](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4703) - -*** - -### price1mMin - -> **price1mMin**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4704](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4704) - -*** - -### price1wMax - -> **price1wMax**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4705](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4705) - -*** - -### price1wMin - -> **price1wMin**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4706](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4706) - -*** - -### price1yMax - -> **price1yMax**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4707](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4707) - -*** - -### price1yMin - -> **price1yMin**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4708](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4708) - -*** - -### price2wChoppinessIndex - -> **price2wChoppinessIndex**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4709](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4709) - -*** - -### price2wMax - -> **price2wMax**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4710](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4710) - -*** - -### price2wMin - -> **price2wMin**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4711](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4711) - -*** - -### priceTrueRange - -> **priceTrueRange**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4712](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4712) - -*** - -### priceTrueRange2wSum - -> **priceTrueRange2wSum**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4713](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4713) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Returns.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Returns.md deleted file mode 100644 index 266d1e1f5..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Returns.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Returns - -# Interface: CatalogTree\_Market\_Returns - -Defined in: [Developer/brk/modules/brk-client/index.js:4717](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4717) - -## Properties - -### \_1dReturns1mSd - -> **\_1dReturns1mSd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4718](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4718) - -*** - -### \_1dReturns1wSd - -> **\_1dReturns1wSd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4719](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4719) - -*** - -### \_1dReturns1ySd - -> **\_1dReturns1ySd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4720](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4720) - -*** - -### cagr - -> **cagr**: [`PeriodCagrPattern`](PeriodCagrPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4721](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4721) - -*** - -### downside1mSd - -> **downside1mSd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4722](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4722) - -*** - -### downside1wSd - -> **downside1wSd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4723](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4723) - -*** - -### downside1ySd - -> **downside1ySd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4724](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4724) - -*** - -### downsideReturns - -> **downsideReturns**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4725](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4725) - -*** - -### priceReturns - -> **priceReturns**: [`CatalogTree_Market_Returns_PriceReturns`](CatalogTree_Market_Returns_PriceReturns.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4726](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4726) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Returns_PriceReturns.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Returns_PriceReturns.md deleted file mode 100644 index da37fdc8e..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Returns_PriceReturns.md +++ /dev/null @@ -1,113 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Returns\_PriceReturns - -# Interface: CatalogTree\_Market\_Returns\_PriceReturns - -Defined in: [Developer/brk/modules/brk-client/index.js:4730](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4730) - -## Properties - -### \_10y - -> **\_10y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4731](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4731) - -*** - -### \_1d - -> **\_1d**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4732](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4732) - -*** - -### \_1m - -> **\_1m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4733](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4733) - -*** - -### \_1w - -> **\_1w**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4734](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4734) - -*** - -### \_1y - -> **\_1y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4735](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4735) - -*** - -### \_2y - -> **\_2y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4736](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4736) - -*** - -### \_3m - -> **\_3m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4737](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4737) - -*** - -### \_3y - -> **\_3y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4738](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4738) - -*** - -### \_4y - -> **\_4y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4739](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4739) - -*** - -### \_5y - -> **\_5y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4740](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4740) - -*** - -### \_6m - -> **\_6m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4741](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4741) - -*** - -### \_6y - -> **\_6y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4742](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4742) - -*** - -### \_8y - -> **\_8y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4743](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4743) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Market_Volatility.md b/modules/brk-client/docs/interfaces/CatalogTree_Market_Volatility.md deleted file mode 100644 index c33b94882..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Market_Volatility.md +++ /dev/null @@ -1,81 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Market\_Volatility - -# Interface: CatalogTree\_Market\_Volatility - -Defined in: [Developer/brk/modules/brk-client/index.js:4747](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4747) - -## Properties - -### price1mVolatility - -> **price1mVolatility**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4748](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4748) - -*** - -### price1wVolatility - -> **price1wVolatility**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4749](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4749) - -*** - -### price1yVolatility - -> **price1yVolatility**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4750](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4750) - -*** - -### sharpe1m - -> **sharpe1m**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4751](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4751) - -*** - -### sharpe1w - -> **sharpe1w**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4752](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4752) - -*** - -### sharpe1y - -> **sharpe1y**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4753](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4753) - -*** - -### sortino1m - -> **sortino1m**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4754](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4754) - -*** - -### sortino1w - -> **sortino1w**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4755](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4755) - -*** - -### sortino1y - -> **sortino1y**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4756](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4756) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Outputs.md b/modules/brk-client/docs/interfaces/CatalogTree_Outputs.md deleted file mode 100644 index 09edcd563..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Outputs.md +++ /dev/null @@ -1,65 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Outputs - -# Interface: CatalogTree\_Outputs - -Defined in: [Developer/brk/modules/brk-client/index.js:4760](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4760) - -## Properties - -### count - -> **count**: [`CatalogTree_Outputs_Count`](CatalogTree_Outputs_Count.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4761](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4761) - -*** - -### firstTxoutindex - -> **firstTxoutindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4762](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4762) - -*** - -### outputtype - -> **outputtype**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<[`OutputType`](../type-aliases/OutputType.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4763](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4763) - -*** - -### spent - -> **spent**: [`CatalogTree_Outputs_Spent`](CatalogTree_Outputs_Spent.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4764](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4764) - -*** - -### txindex - -> **txindex**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4765](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4765) - -*** - -### typeindex - -> **typeindex**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4766](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4766) - -*** - -### value - -> **value**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4767](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4767) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Outputs_Count.md b/modules/brk-client/docs/interfaces/CatalogTree_Outputs_Count.md deleted file mode 100644 index ae2ae64a0..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Outputs_Count.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Outputs\_Count - -# Interface: CatalogTree\_Outputs\_Count - -Defined in: [Developer/brk/modules/brk-client/index.js:4771](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4771) - -## Properties - -### totalCount - -> **totalCount**: [`CountPattern2`](CountPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4772](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4772) - -*** - -### utxoCount - -> **utxoCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4773](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4773) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Outputs_Spent.md b/modules/brk-client/docs/interfaces/CatalogTree_Outputs_Spent.md deleted file mode 100644 index 87f34976e..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Outputs_Spent.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Outputs\_Spent - -# Interface: CatalogTree\_Outputs\_Spent - -Defined in: [Developer/brk/modules/brk-client/index.js:4777](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4777) - -## Properties - -### txinindex - -> **txinindex**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4778](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4778) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Pools.md b/modules/brk-client/docs/interfaces/CatalogTree_Pools.md deleted file mode 100644 index bbcef3eec..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Pools.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Pools - -# Interface: CatalogTree\_Pools - -Defined in: [Developer/brk/modules/brk-client/index.js:4782](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4782) - -## Properties - -### heightToPool - -> **heightToPool**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<[`PoolSlug`](../type-aliases/PoolSlug.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4783](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4783) - -*** - -### vecs - -> **vecs**: [`CatalogTree_Pools_Vecs`](CatalogTree_Pools_Vecs.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4784](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4784) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Pools_Vecs.md b/modules/brk-client/docs/interfaces/CatalogTree_Pools_Vecs.md deleted file mode 100644 index aa65d9a74..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Pools_Vecs.md +++ /dev/null @@ -1,1273 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Pools\_Vecs - -# Interface: CatalogTree\_Pools\_Vecs - -Defined in: [Developer/brk/modules/brk-client/index.js:4788](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4788) - -## Properties - -### aaopool - -> **aaopool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4789](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4789) - -*** - -### antpool - -> **antpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4790](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4790) - -*** - -### arkpool - -> **arkpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4791](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4791) - -*** - -### asicminer - -> **asicminer**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4792](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4792) - -*** - -### axbt - -> **axbt**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4793](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4793) - -*** - -### batpool - -> **batpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4794](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4794) - -*** - -### bcmonster - -> **bcmonster**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4795](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4795) - -*** - -### bcpoolio - -> **bcpoolio**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4796](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4796) - -*** - -### binancepool - -> **binancepool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4797](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4797) - -*** - -### bitalo - -> **bitalo**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4798](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4798) - -*** - -### bitclub - -> **bitclub**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4799](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4799) - -*** - -### bitcoinaffiliatenetwork - -> **bitcoinaffiliatenetwork**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4800](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4800) - -*** - -### bitcoincom - -> **bitcoincom**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4801](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4801) - -*** - -### bitcoinindia - -> **bitcoinindia**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4802](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4802) - -*** - -### bitcoinrussia - -> **bitcoinrussia**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4803](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4803) - -*** - -### bitcoinukraine - -> **bitcoinukraine**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4804](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4804) - -*** - -### bitfarms - -> **bitfarms**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4805](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4805) - -*** - -### bitfufupool - -> **bitfufupool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4806](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4806) - -*** - -### bitfury - -> **bitfury**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4807](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4807) - -*** - -### bitminter - -> **bitminter**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4808](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4808) - -*** - -### bitparking - -> **bitparking**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4809](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4809) - -*** - -### bitsolo - -> **bitsolo**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4810](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4810) - -*** - -### bixin - -> **bixin**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4811](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4811) - -*** - -### blockfills - -> **blockfills**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4812](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4812) - -*** - -### braiinspool - -> **braiinspool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4813](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4813) - -*** - -### bravomining - -> **bravomining**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4814](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4814) - -*** - -### btcc - -> **btcc**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4815](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4815) - -*** - -### btccom - -> **btccom**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4816](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4816) - -*** - -### btcdig - -> **btcdig**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4817](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4817) - -*** - -### btcguild - -> **btcguild**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4818](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4818) - -*** - -### btclab - -> **btclab**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4819](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4819) - -*** - -### btcmp - -> **btcmp**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4820](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4820) - -*** - -### btcnuggets - -> **btcnuggets**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4821](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4821) - -*** - -### btcpoolparty - -> **btcpoolparty**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4822](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4822) - -*** - -### btcserv - -> **btcserv**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4823](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4823) - -*** - -### btctop - -> **btctop**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4824](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4824) - -*** - -### btpool - -> **btpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4825](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4825) - -*** - -### bwpool - -> **bwpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4826](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4826) - -*** - -### bytepool - -> **bytepool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4827](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4827) - -*** - -### canoe - -> **canoe**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4828](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4828) - -*** - -### canoepool - -> **canoepool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4829](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4829) - -*** - -### carbonnegative - -> **carbonnegative**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4830](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4830) - -*** - -### ckpool - -> **ckpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4831](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4831) - -*** - -### cloudhashing - -> **cloudhashing**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4832](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4832) - -*** - -### coinlab - -> **coinlab**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4833](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4833) - -*** - -### cointerra - -> **cointerra**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4834](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4834) - -*** - -### connectbtc - -> **connectbtc**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4835](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4835) - -*** - -### dcex - -> **dcex**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4836](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4836) - -*** - -### dcexploration - -> **dcexploration**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4837](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4837) - -*** - -### digitalbtc - -> **digitalbtc**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4838](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4838) - -*** - -### digitalxmintsy - -> **digitalxmintsy**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4839](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4839) - -*** - -### dpool - -> **dpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4840](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4840) - -*** - -### eclipsemc - -> **eclipsemc**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4841](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4841) - -*** - -### eightbaochi - -> **eightbaochi**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4842](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4842) - -*** - -### ekanembtc - -> **ekanembtc**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4843](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4843) - -*** - -### eligius - -> **eligius**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4844](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4844) - -*** - -### emcdpool - -> **emcdpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4845](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4845) - -*** - -### entrustcharitypool - -> **entrustcharitypool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4846](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4846) - -*** - -### eobot - -> **eobot**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4847](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4847) - -*** - -### exxbw - -> **exxbw**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4848](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4848) - -*** - -### f2pool - -> **f2pool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4849](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4849) - -*** - -### fiftyeightcoin - -> **fiftyeightcoin**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4850](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4850) - -*** - -### foundryusa - -> **foundryusa**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4851](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4851) - -*** - -### futurebitapollosolo - -> **futurebitapollosolo**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4852](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4852) - -*** - -### gbminers - -> **gbminers**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4853](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4853) - -*** - -### ghashio - -> **ghashio**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4854](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4854) - -*** - -### givemecoins - -> **givemecoins**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4855](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4855) - -*** - -### gogreenlight - -> **gogreenlight**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4856](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4856) - -*** - -### haominer - -> **haominer**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4857](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4857) - -*** - -### haozhuzhu - -> **haozhuzhu**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4858](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4858) - -*** - -### hashbx - -> **hashbx**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4859](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4859) - -*** - -### hashpool - -> **hashpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4860](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4860) - -*** - -### helix - -> **helix**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4861](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4861) - -*** - -### hhtt - -> **hhtt**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4862](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4862) - -*** - -### hotpool - -> **hotpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4863](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4863) - -*** - -### hummerpool - -> **hummerpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4864](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4864) - -*** - -### huobipool - -> **huobipool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4865](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4865) - -*** - -### innopolistech - -> **innopolistech**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4866](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4866) - -*** - -### kanopool - -> **kanopool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4867](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4867) - -*** - -### kncminer - -> **kncminer**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4868](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4868) - -*** - -### kucoinpool - -> **kucoinpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4869](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4869) - -*** - -### lubiancom - -> **lubiancom**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4870](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4870) - -*** - -### luckypool - -> **luckypool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4871](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4871) - -*** - -### luxor - -> **luxor**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4872](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4872) - -*** - -### marapool - -> **marapool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4873](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4873) - -*** - -### maxbtc - -> **maxbtc**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4874](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4874) - -*** - -### maxipool - -> **maxipool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4875](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4875) - -*** - -### megabigpower - -> **megabigpower**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4876](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4876) - -*** - -### minerium - -> **minerium**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4877](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4877) - -*** - -### miningcity - -> **miningcity**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4878](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4878) - -*** - -### miningdutch - -> **miningdutch**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4879](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4879) - -*** - -### miningkings - -> **miningkings**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4880](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4880) - -*** - -### miningsquared - -> **miningsquared**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4881](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4881) - -*** - -### mmpool - -> **mmpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4882](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4882) - -*** - -### mtred - -> **mtred**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4883](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4883) - -*** - -### multicoinco - -> **multicoinco**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4884](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4884) - -*** - -### multipool - -> **multipool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4885](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4885) - -*** - -### mybtccoinpool - -> **mybtccoinpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4886](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4886) - -*** - -### neopool - -> **neopool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4887](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4887) - -*** - -### nexious - -> **nexious**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4888](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4888) - -*** - -### nicehash - -> **nicehash**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4889](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4889) - -*** - -### nmcbit - -> **nmcbit**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4890](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4890) - -*** - -### novablock - -> **novablock**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4891](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4891) - -*** - -### ocean - -> **ocean**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4892](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4892) - -*** - -### okexpool - -> **okexpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4893](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4893) - -*** - -### okkong - -> **okkong**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4894](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4894) - -*** - -### okminer - -> **okminer**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4895](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4895) - -*** - -### okpooltop - -> **okpooltop**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4896](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4896) - -*** - -### onehash - -> **onehash**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4897](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4897) - -*** - -### onem1x - -> **onem1x**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4898](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4898) - -*** - -### onethash - -> **onethash**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4899](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4899) - -*** - -### ozcoin - -> **ozcoin**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4900](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4900) - -*** - -### parasite - -> **parasite**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4901](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4901) - -*** - -### patels - -> **patels**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4902](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4902) - -*** - -### pegapool - -> **pegapool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4903](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4903) - -*** - -### phashio - -> **phashio**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4904](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4904) - -*** - -### phoenix - -> **phoenix**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4905](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4905) - -*** - -### polmine - -> **polmine**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4906](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4906) - -*** - -### pool175btc - -> **pool175btc**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4907](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4907) - -*** - -### pool50btc - -> **pool50btc**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4908](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4908) - -*** - -### poolin - -> **poolin**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4909](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4909) - -*** - -### portlandhodl - -> **portlandhodl**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4910](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4910) - -*** - -### publicpool - -> **publicpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4911](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4911) - -*** - -### purebtccom - -> **purebtccom**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4912](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4912) - -*** - -### rawpool - -> **rawpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4913](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4913) - -*** - -### rigpool - -> **rigpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4914](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4914) - -*** - -### sbicrypto - -> **sbicrypto**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4915](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4915) - -*** - -### secpool - -> **secpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4916](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4916) - -*** - -### secretsuperstar - -> **secretsuperstar**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4917](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4917) - -*** - -### sevenpool - -> **sevenpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4918](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4918) - -*** - -### shawnp0wers - -> **shawnp0wers**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4919](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4919) - -*** - -### sigmapoolcom - -> **sigmapoolcom**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4920](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4920) - -*** - -### simplecoinus - -> **simplecoinus**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4921](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4921) - -*** - -### solock - -> **solock**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4922](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4922) - -*** - -### spiderpool - -> **spiderpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4923](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4923) - -*** - -### stminingcorp - -> **stminingcorp**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4924](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4924) - -*** - -### tangpool - -> **tangpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4925](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4925) - -*** - -### tatmaspool - -> **tatmaspool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4926](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4926) - -*** - -### tbdice - -> **tbdice**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4927](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4927) - -*** - -### telco214 - -> **telco214**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4928](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4928) - -*** - -### terrapool - -> **terrapool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4929](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4929) - -*** - -### tiger - -> **tiger**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4930](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4930) - -*** - -### tigerpoolnet - -> **tigerpoolnet**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4931](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4931) - -*** - -### titan - -> **titan**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4932](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4932) - -*** - -### transactioncoinmining - -> **transactioncoinmining**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4933](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4933) - -*** - -### trickysbtcpool - -> **trickysbtcpool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4934](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4934) - -*** - -### triplemining - -> **triplemining**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4935](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4935) - -*** - -### twentyoneinc - -> **twentyoneinc**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4936](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4936) - -*** - -### ultimuspool - -> **ultimuspool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4937](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4937) - -*** - -### unknown - -> **unknown**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4938](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4938) - -*** - -### unomp - -> **unomp**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4939](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4939) - -*** - -### viabtc - -> **viabtc**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4940](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4940) - -*** - -### waterhole - -> **waterhole**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4941](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4941) - -*** - -### wayicn - -> **wayicn**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4942](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4942) - -*** - -### whitepool - -> **whitepool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4943](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4943) - -*** - -### wk057 - -> **wk057**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4944](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4944) - -*** - -### yourbtcnet - -> **yourbtcnet**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4945](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4945) - -*** - -### zulupool - -> **zulupool**: [`AaopoolPattern`](AaopoolPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4946](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4946) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Positions.md b/modules/brk-client/docs/interfaces/CatalogTree_Positions.md deleted file mode 100644 index 8ed59a8fa..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Positions.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Positions - -# Interface: CatalogTree\_Positions - -Defined in: [Developer/brk/modules/brk-client/index.js:4950](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4950) - -## Properties - -### blockPosition - -> **blockPosition**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4951](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4951) - -*** - -### txPosition - -> **txPosition**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4952](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4952) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Price.md b/modules/brk-client/docs/interfaces/CatalogTree_Price.md deleted file mode 100644 index 80f1853f4..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Price.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Price - -# Interface: CatalogTree\_Price - -Defined in: [Developer/brk/modules/brk-client/index.js:4956](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4956) - -## Properties - -### cents - -> **cents**: [`CatalogTree_Price_Cents`](CatalogTree_Price_Cents.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4957](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4957) - -*** - -### sats - -> **sats**: [`CatalogTree_Price_Sats`](CatalogTree_Price_Sats.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4958](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4958) - -*** - -### usd - -> **usd**: [`CatalogTree_Price_Usd`](CatalogTree_Price_Usd.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4959](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4959) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Price_Cents.md b/modules/brk-client/docs/interfaces/CatalogTree_Price_Cents.md deleted file mode 100644 index cdbd0c1ac..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Price_Cents.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Price\_Cents - -# Interface: CatalogTree\_Price\_Cents - -Defined in: [Developer/brk/modules/brk-client/index.js:4963](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4963) - -## Properties - -### ohlc - -> **ohlc**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<[`OHLCCents`](OHLCCents.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4964](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4964) - -*** - -### split - -> **split**: [`CatalogTree_Price_Cents_Split`](CatalogTree_Price_Cents_Split.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4965](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4965) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Price_Cents_Split.md b/modules/brk-client/docs/interfaces/CatalogTree_Price_Cents_Split.md deleted file mode 100644 index 1a72154fd..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Price_Cents_Split.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Price\_Cents\_Split - -# Interface: CatalogTree\_Price\_Cents\_Split - -Defined in: [Developer/brk/modules/brk-client/index.js:4969](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4969) - -## Properties - -### close - -> **close**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4970](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4970) - -*** - -### high - -> **high**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4971](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4971) - -*** - -### low - -> **low**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4972](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4972) - -*** - -### open - -> **open**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4973](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4973) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Price_Sats.md b/modules/brk-client/docs/interfaces/CatalogTree_Price_Sats.md deleted file mode 100644 index f212eb7c3..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Price_Sats.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Price\_Sats - -# Interface: CatalogTree\_Price\_Sats - -Defined in: [Developer/brk/modules/brk-client/index.js:4977](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4977) - -## Properties - -### ohlc - -> **ohlc**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<[`OHLCSats`](OHLCSats.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4978](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4978) - -*** - -### split - -> **split**: [`SplitPattern2`](SplitPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4979](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4979) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Price_Usd.md b/modules/brk-client/docs/interfaces/CatalogTree_Price_Usd.md deleted file mode 100644 index aae116c96..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Price_Usd.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Price\_Usd - -# Interface: CatalogTree\_Price\_Usd - -Defined in: [Developer/brk/modules/brk-client/index.js:4983](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4983) - -## Properties - -### ohlc - -> **ohlc**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<[`OHLCDollars`](OHLCDollars.md)\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4984](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4984) - -*** - -### split - -> **split**: [`SplitPattern2`](SplitPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4985](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4985) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Scripts.md b/modules/brk-client/docs/interfaces/CatalogTree_Scripts.md deleted file mode 100644 index db8202150..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Scripts.md +++ /dev/null @@ -1,89 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Scripts - -# Interface: CatalogTree\_Scripts - -Defined in: [Developer/brk/modules/brk-client/index.js:4989](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4989) - -## Properties - -### count - -> **count**: [`CatalogTree_Scripts_Count`](CatalogTree_Scripts_Count.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4990](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4990) - -*** - -### emptyToTxindex - -> **emptyToTxindex**: [`MetricPattern9`](../type-aliases/MetricPattern9.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4991](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4991) - -*** - -### firstEmptyoutputindex - -> **firstEmptyoutputindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4992](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4992) - -*** - -### firstOpreturnindex - -> **firstOpreturnindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4993](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4993) - -*** - -### firstP2msoutputindex - -> **firstP2msoutputindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4994](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4994) - -*** - -### firstUnknownoutputindex - -> **firstUnknownoutputindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4995](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4995) - -*** - -### opreturnToTxindex - -> **opreturnToTxindex**: [`MetricPattern14`](../type-aliases/MetricPattern14.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4996](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4996) - -*** - -### p2msToTxindex - -> **p2msToTxindex**: [`MetricPattern17`](../type-aliases/MetricPattern17.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4997](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4997) - -*** - -### unknownToTxindex - -> **unknownToTxindex**: [`MetricPattern28`](../type-aliases/MetricPattern28.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:4998](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4998) - -*** - -### value - -> **value**: [`CatalogTree_Scripts_Value`](CatalogTree_Scripts_Value.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:4999](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L4999) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Scripts_Count.md b/modules/brk-client/docs/interfaces/CatalogTree_Scripts_Count.md deleted file mode 100644 index 309d954a6..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Scripts_Count.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Scripts\_Count - -# Interface: CatalogTree\_Scripts\_Count - -Defined in: [Developer/brk/modules/brk-client/index.js:5003](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5003) - -## Properties - -### emptyoutput - -> **emptyoutput**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5004](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5004) - -*** - -### opreturn - -> **opreturn**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5005](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5005) - -*** - -### p2a - -> **p2a**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5006](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5006) - -*** - -### p2ms - -> **p2ms**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5007](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5007) - -*** - -### p2pk33 - -> **p2pk33**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5008](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5008) - -*** - -### p2pk65 - -> **p2pk65**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5009](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5009) - -*** - -### p2pkh - -> **p2pkh**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5010](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5010) - -*** - -### p2sh - -> **p2sh**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5011](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5011) - -*** - -### p2tr - -> **p2tr**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5012](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5012) - -*** - -### p2wpkh - -> **p2wpkh**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5013](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5013) - -*** - -### p2wsh - -> **p2wsh**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5014](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5014) - -*** - -### segwit - -> **segwit**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5015](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5015) - -*** - -### segwitAdoption - -> **segwitAdoption**: [`SegwitAdoptionPattern`](SegwitAdoptionPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5016](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5016) - -*** - -### taprootAdoption - -> **taprootAdoption**: [`SegwitAdoptionPattern`](SegwitAdoptionPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5017](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5017) - -*** - -### unknownoutput - -> **unknownoutput**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5018](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5018) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Scripts_Value.md b/modules/brk-client/docs/interfaces/CatalogTree_Scripts_Value.md deleted file mode 100644 index b79beb992..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Scripts_Value.md +++ /dev/null @@ -1,17 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Scripts\_Value - -# Interface: CatalogTree\_Scripts\_Value - -Defined in: [Developer/brk/modules/brk-client/index.js:5022](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5022) - -## Properties - -### opreturn - -> **opreturn**: [`CoinbasePattern`](CoinbasePattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5023](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5023) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Supply.md b/modules/brk-client/docs/interfaces/CatalogTree_Supply.md deleted file mode 100644 index 457e31f01..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Supply.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Supply - -# Interface: CatalogTree\_Supply - -Defined in: [Developer/brk/modules/brk-client/index.js:5027](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5027) - -## Properties - -### burned - -> **burned**: [`CatalogTree_Supply_Burned`](CatalogTree_Supply_Burned.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5028](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5028) - -*** - -### circulating - -> **circulating**: [`CatalogTree_Supply_Circulating`](CatalogTree_Supply_Circulating.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5029](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5029) - -*** - -### inflation - -> **inflation**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5030](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5030) - -*** - -### marketCap - -> **marketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5031](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5031) - -*** - -### velocity - -> **velocity**: [`CatalogTree_Supply_Velocity`](CatalogTree_Supply_Velocity.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5032](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5032) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Supply_Burned.md b/modules/brk-client/docs/interfaces/CatalogTree_Supply_Burned.md deleted file mode 100644 index 3b43ed783..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Supply_Burned.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Supply\_Burned - -# Interface: CatalogTree\_Supply\_Burned - -Defined in: [Developer/brk/modules/brk-client/index.js:5036](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5036) - -## Properties - -### opreturn - -> **opreturn**: [`UnclaimedRewardsPattern`](UnclaimedRewardsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5037](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5037) - -*** - -### unspendable - -> **unspendable**: [`UnclaimedRewardsPattern`](UnclaimedRewardsPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5038](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5038) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Supply_Circulating.md b/modules/brk-client/docs/interfaces/CatalogTree_Supply_Circulating.md deleted file mode 100644 index 920400b16..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Supply_Circulating.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Supply\_Circulating - -# Interface: CatalogTree\_Supply\_Circulating - -Defined in: [Developer/brk/modules/brk-client/index.js:5042](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5042) - -## Properties - -### bitcoin - -> **bitcoin**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5043](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5043) - -*** - -### dollars - -> **dollars**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5044](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5044) - -*** - -### sats - -> **sats**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5045](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5045) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Supply_Velocity.md b/modules/brk-client/docs/interfaces/CatalogTree_Supply_Velocity.md deleted file mode 100644 index 3fbbd8a8c..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Supply_Velocity.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Supply\_Velocity - -# Interface: CatalogTree\_Supply\_Velocity - -Defined in: [Developer/brk/modules/brk-client/index.js:5049](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5049) - -## Properties - -### btc - -> **btc**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5050](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5050) - -*** - -### usd - -> **usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5051](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5051) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Transactions.md b/modules/brk-client/docs/interfaces/CatalogTree_Transactions.md deleted file mode 100644 index e6fda6b28..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Transactions.md +++ /dev/null @@ -1,129 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Transactions - -# Interface: CatalogTree\_Transactions - -Defined in: [Developer/brk/modules/brk-client/index.js:5055](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5055) - -## Properties - -### baseSize - -> **baseSize**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5056](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5056) - -*** - -### count - -> **count**: [`CatalogTree_Transactions_Count`](CatalogTree_Transactions_Count.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5057](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5057) - -*** - -### fees - -> **fees**: [`CatalogTree_Transactions_Fees`](CatalogTree_Transactions_Fees.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5058](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5058) - -*** - -### firstTxindex - -> **firstTxindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5059](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5059) - -*** - -### firstTxinindex - -> **firstTxinindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5060](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5060) - -*** - -### firstTxoutindex - -> **firstTxoutindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5061](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5061) - -*** - -### height - -> **height**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5062](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5062) - -*** - -### isExplicitlyRbf - -> **isExplicitlyRbf**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5063](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5063) - -*** - -### rawlocktime - -> **rawlocktime**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5064](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5064) - -*** - -### size - -> **size**: [`CatalogTree_Transactions_Size`](CatalogTree_Transactions_Size.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5065](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5065) - -*** - -### totalSize - -> **totalSize**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5066](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5066) - -*** - -### txid - -> **txid**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`string`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5067](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5067) - -*** - -### txversion - -> **txversion**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5068](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5068) - -*** - -### versions - -> **versions**: [`CatalogTree_Transactions_Versions`](CatalogTree_Transactions_Versions.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5069](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5069) - -*** - -### volume - -> **volume**: [`CatalogTree_Transactions_Volume`](CatalogTree_Transactions_Volume.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5070](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5070) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Count.md b/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Count.md deleted file mode 100644 index 0280453b4..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Count.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Transactions\_Count - -# Interface: CatalogTree\_Transactions\_Count - -Defined in: [Developer/brk/modules/brk-client/index.js:5074](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5074) - -## Properties - -### isCoinbase - -> **isCoinbase**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5075](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5075) - -*** - -### txCount - -> **txCount**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5076](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5076) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Fees.md b/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Fees.md deleted file mode 100644 index 123481447..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Fees.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Transactions\_Fees - -# Interface: CatalogTree\_Transactions\_Fees - -Defined in: [Developer/brk/modules/brk-client/index.js:5080](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5080) - -## Properties - -### fee - -> **fee**: [`CatalogTree_Transactions_Fees_Fee`](CatalogTree_Transactions_Fees_Fee.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5081](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5081) - -*** - -### feeRate - -> **feeRate**: [`FeeRatePattern`](FeeRatePattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5082](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5082) - -*** - -### inputValue - -> **inputValue**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5083](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5083) - -*** - -### outputValue - -> **outputValue**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5084](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5084) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Fees_Fee.md b/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Fees_Fee.md deleted file mode 100644 index 4a380b820..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Fees_Fee.md +++ /dev/null @@ -1,41 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Transactions\_Fees\_Fee - -# Interface: CatalogTree\_Transactions\_Fees\_Fee - -Defined in: [Developer/brk/modules/brk-client/index.js:5088](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5088) - -## Properties - -### bitcoin - -> **bitcoin**: [`CountPattern2`](CountPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5089](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5089) - -*** - -### dollars - -> **dollars**: [`CatalogTree_Transactions_Fees_Fee_Dollars`](CatalogTree_Transactions_Fees_Fee_Dollars.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5090](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5090) - -*** - -### sats - -> **sats**: [`CountPattern2`](CountPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5091](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5091) - -*** - -### txindex - -> **txindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5092](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5092) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Fees_Fee_Dollars.md b/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Fees_Fee_Dollars.md deleted file mode 100644 index c1bc138a3..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Fees_Fee_Dollars.md +++ /dev/null @@ -1,97 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Transactions\_Fees\_Fee\_Dollars - -# Interface: CatalogTree\_Transactions\_Fees\_Fee\_Dollars - -Defined in: [Developer/brk/modules/brk-client/index.js:5096](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5096) - -## Properties - -### average - -> **average**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5097](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5097) - -*** - -### cumulative - -> **cumulative**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5098](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5098) - -*** - -### heightCumulative - -> **heightCumulative**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5099](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5099) - -*** - -### max - -> **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5100](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5100) - -*** - -### median - -> **median**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5101](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5101) - -*** - -### min - -> **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5102](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5102) - -*** - -### pct10 - -> **pct10**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5103](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5103) - -*** - -### pct25 - -> **pct25**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5104](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5104) - -*** - -### pct75 - -> **pct75**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5105](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5105) - -*** - -### pct90 - -> **pct90**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5106](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5106) - -*** - -### sum - -> **sum**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5107](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5107) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Size.md b/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Size.md deleted file mode 100644 index 8cf4562f9..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Size.md +++ /dev/null @@ -1,25 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Transactions\_Size - -# Interface: CatalogTree\_Transactions\_Size - -Defined in: [Developer/brk/modules/brk-client/index.js:5111](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5111) - -## Properties - -### vsize - -> **vsize**: [`FeeRatePattern`](FeeRatePattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5112](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5112) - -*** - -### weight - -> **weight**: [`FeeRatePattern`](FeeRatePattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5113](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5113) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Versions.md b/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Versions.md deleted file mode 100644 index 9a3046a00..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Versions.md +++ /dev/null @@ -1,33 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Transactions\_Versions - -# Interface: CatalogTree\_Transactions\_Versions - -Defined in: [Developer/brk/modules/brk-client/index.js:5117](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5117) - -## Properties - -### v1 - -> **v1**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5118](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5118) - -*** - -### v2 - -> **v2**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5119](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5119) - -*** - -### v3 - -> **v3**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5120](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5120) diff --git a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Volume.md b/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Volume.md deleted file mode 100644 index 62014d374..000000000 --- a/modules/brk-client/docs/interfaces/CatalogTree_Transactions_Volume.md +++ /dev/null @@ -1,49 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / CatalogTree\_Transactions\_Volume - -# Interface: CatalogTree\_Transactions\_Volume - -Defined in: [Developer/brk/modules/brk-client/index.js:5124](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5124) - -## Properties - -### annualizedVolume - -> **annualizedVolume**: [`_2015Pattern`](2015Pattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5125](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5125) - -*** - -### inputsPerSec - -> **inputsPerSec**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5126](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5126) - -*** - -### outputsPerSec - -> **outputsPerSec**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5127](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5127) - -*** - -### sentSum - -> **sentSum**: [`ActiveSupplyPattern`](ActiveSupplyPattern.md) - -Defined in: [Developer/brk/modules/brk-client/index.js:5128](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5128) - -*** - -### txPerSec - -> **txPerSec**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:5129](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L5129) diff --git a/modules/brk-client/docs/interfaces/ClassAveragePricePattern.md b/modules/brk-client/docs/interfaces/ClassAveragePricePattern.md index b707a9538..47aadb84f 100644 --- a/modules/brk-client/docs/interfaces/ClassAveragePricePattern.md +++ b/modules/brk-client/docs/interfaces/ClassAveragePricePattern.md @@ -6,7 +6,7 @@ # Interface: ClassAveragePricePattern\ -Defined in: [Developer/brk/modules/brk-client/index.js:2802](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2802) +Defined in: [Developer/brk/modules/brk-client/index.js:1996](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1996) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2802](https://github.com/ > **\_2015**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2803](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2803) +Defined in: [Developer/brk/modules/brk-client/index.js:1997](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1997) *** @@ -28,7 +28,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2803](https://github.com/ > **\_2016**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2804](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2804) +Defined in: [Developer/brk/modules/brk-client/index.js:1998](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1998) *** @@ -36,7 +36,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2804](https://github.com/ > **\_2017**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2805](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2805) +Defined in: [Developer/brk/modules/brk-client/index.js:1999](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1999) *** @@ -44,7 +44,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2805](https://github.com/ > **\_2018**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2806](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2806) +Defined in: [Developer/brk/modules/brk-client/index.js:2000](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2000) *** @@ -52,7 +52,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2806](https://github.com/ > **\_2019**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2807](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2807) +Defined in: [Developer/brk/modules/brk-client/index.js:2001](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2001) *** @@ -60,7 +60,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2807](https://github.com/ > **\_2020**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2808](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2808) +Defined in: [Developer/brk/modules/brk-client/index.js:2002](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2002) *** @@ -68,7 +68,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2808](https://github.com/ > **\_2021**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2809](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2809) +Defined in: [Developer/brk/modules/brk-client/index.js:2003](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2003) *** @@ -76,7 +76,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2809](https://github.com/ > **\_2022**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2810](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2810) +Defined in: [Developer/brk/modules/brk-client/index.js:2004](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2004) *** @@ -84,7 +84,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2810](https://github.com/ > **\_2023**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2811](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2811) +Defined in: [Developer/brk/modules/brk-client/index.js:2005](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2005) *** @@ -92,7 +92,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2811](https://github.com/ > **\_2024**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2812](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2812) +Defined in: [Developer/brk/modules/brk-client/index.js:2006](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2006) *** @@ -100,4 +100,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2812](https://github.com/ > **\_2025**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2813](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2813) +Defined in: [Developer/brk/modules/brk-client/index.js:2007](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2007) diff --git a/modules/brk-client/docs/interfaces/CoinbasePattern.md b/modules/brk-client/docs/interfaces/CoinbasePattern.md index c56526bb7..9e43db6b1 100644 --- a/modules/brk-client/docs/interfaces/CoinbasePattern.md +++ b/modules/brk-client/docs/interfaces/CoinbasePattern.md @@ -6,15 +6,15 @@ # Interface: CoinbasePattern -Defined in: [Developer/brk/modules/brk-client/index.js:3414](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3414) +Defined in: [Developer/brk/modules/brk-client/index.js:2559](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2559) ## Properties ### bitcoin -> **bitcoin**: [`FullnessPattern`](FullnessPattern.md)\<`number`\> +> **bitcoin**: [`BitcoinPattern`](BitcoinPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3415](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3415) +Defined in: [Developer/brk/modules/brk-client/index.js:2560](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2560) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3415](https://github.com/ > **dollars**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3416](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3416) +Defined in: [Developer/brk/modules/brk-client/index.js:2561](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2561) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3416](https://github.com/ > **sats**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3417](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3417) +Defined in: [Developer/brk/modules/brk-client/index.js:2562](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2562) diff --git a/modules/brk-client/docs/interfaces/CoinbasePattern2.md b/modules/brk-client/docs/interfaces/CoinbasePattern2.md index 506936a4b..df39b978b 100644 --- a/modules/brk-client/docs/interfaces/CoinbasePattern2.md +++ b/modules/brk-client/docs/interfaces/CoinbasePattern2.md @@ -6,7 +6,7 @@ # Interface: CoinbasePattern2 -Defined in: [Developer/brk/modules/brk-client/index.js:3435](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3435) +Defined in: [Developer/brk/modules/brk-client/index.js:2580](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2580) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3435](https://github.com/ > **bitcoin**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3436](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3436) +Defined in: [Developer/brk/modules/brk-client/index.js:2581](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2581) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3436](https://github.com/ > **dollars**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3437](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3437) +Defined in: [Developer/brk/modules/brk-client/index.js:2582](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2582) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3437](https://github.com/ > **sats**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3438](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3438) +Defined in: [Developer/brk/modules/brk-client/index.js:2583](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2583) diff --git a/modules/brk-client/docs/interfaces/CostBasisPattern.md b/modules/brk-client/docs/interfaces/CostBasisPattern.md index 87e92bfc0..a6bd0ee5e 100644 --- a/modules/brk-client/docs/interfaces/CostBasisPattern.md +++ b/modules/brk-client/docs/interfaces/CostBasisPattern.md @@ -6,7 +6,7 @@ # Interface: CostBasisPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3559](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3559) +Defined in: [Developer/brk/modules/brk-client/index.js:2685](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2685) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3559](https://github.com/ > **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3560](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3560) +Defined in: [Developer/brk/modules/brk-client/index.js:2686](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2686) *** @@ -22,4 +22,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3560](https://github.com/ > **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3561](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3561) +Defined in: [Developer/brk/modules/brk-client/index.js:2687](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2687) diff --git a/modules/brk-client/docs/interfaces/CostBasisPattern2.md b/modules/brk-client/docs/interfaces/CostBasisPattern2.md index 0365c90df..f80850619 100644 --- a/modules/brk-client/docs/interfaces/CostBasisPattern2.md +++ b/modules/brk-client/docs/interfaces/CostBasisPattern2.md @@ -6,7 +6,7 @@ # Interface: CostBasisPattern2 -Defined in: [Developer/brk/modules/brk-client/index.js:3477](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3477) +Defined in: [Developer/brk/modules/brk-client/index.js:2622](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2622) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3477](https://github.com/ > **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3478](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3478) +Defined in: [Developer/brk/modules/brk-client/index.js:2623](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2623) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3478](https://github.com/ > **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3479](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3479) +Defined in: [Developer/brk/modules/brk-client/index.js:2624](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2624) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3479](https://github.com/ > **percentiles**: [`PercentilesPattern`](PercentilesPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3480](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3480) +Defined in: [Developer/brk/modules/brk-client/index.js:2625](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2625) diff --git a/modules/brk-client/docs/interfaces/CountPattern2.md b/modules/brk-client/docs/interfaces/CountPattern2.md index 2997aad12..a34784b5a 100644 --- a/modules/brk-client/docs/interfaces/CountPattern2.md +++ b/modules/brk-client/docs/interfaces/CountPattern2.md @@ -6,7 +6,7 @@ # Interface: CountPattern2\ -Defined in: [Developer/brk/modules/brk-client/index.js:3007](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3007) +Defined in: [Developer/brk/modules/brk-client/index.js:2144](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2144) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3007](https://github.com/ > **average**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3008](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3008) +Defined in: [Developer/brk/modules/brk-client/index.js:2145](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2145) *** @@ -28,7 +28,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3008](https://github.com/ > **cumulative**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3009](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3009) +Defined in: [Developer/brk/modules/brk-client/index.js:2146](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2146) *** @@ -36,7 +36,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3009](https://github.com/ > **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3010](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3010) +Defined in: [Developer/brk/modules/brk-client/index.js:2147](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2147) *** @@ -44,7 +44,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3010](https://github.com/ > **median**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3011](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3011) +Defined in: [Developer/brk/modules/brk-client/index.js:2148](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2148) *** @@ -52,7 +52,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3011](https://github.com/ > **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3012](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3012) +Defined in: [Developer/brk/modules/brk-client/index.js:2149](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2149) *** @@ -60,7 +60,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3012](https://github.com/ > **pct10**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3013](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3013) +Defined in: [Developer/brk/modules/brk-client/index.js:2150](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2150) *** @@ -68,7 +68,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3013](https://github.com/ > **pct25**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3014](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3014) +Defined in: [Developer/brk/modules/brk-client/index.js:2151](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2151) *** @@ -76,7 +76,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3014](https://github.com/ > **pct75**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3015](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3015) +Defined in: [Developer/brk/modules/brk-client/index.js:2152](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2152) *** @@ -84,7 +84,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3015](https://github.com/ > **pct90**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3016](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3016) +Defined in: [Developer/brk/modules/brk-client/index.js:2153](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2153) *** @@ -92,4 +92,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3016](https://github.com/ > **sum**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3017](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3017) +Defined in: [Developer/brk/modules/brk-client/index.js:2154](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2154) diff --git a/modules/brk-client/docs/interfaces/DataRangeFormat.md b/modules/brk-client/docs/interfaces/DataRangeFormat.md index 77196768d..37b9ffd57 100644 --- a/modules/brk-client/docs/interfaces/DataRangeFormat.md +++ b/modules/brk-client/docs/interfaces/DataRangeFormat.md @@ -6,15 +6,17 @@ # Interface: DataRangeFormat -Defined in: [Developer/brk/modules/brk-client/index.js:125](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L125) +Defined in: [Developer/brk/modules/brk-client/index.js:179](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L179) ## Properties -### count? +### end? -> `optional` **count**: `number` \| `null` +> `optional` **end**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:126](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L126) +Defined in: [Developer/brk/modules/brk-client/index.js:181](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L181) + +Exclusive ending index, if negative counts from end *** @@ -22,20 +24,26 @@ Defined in: [Developer/brk/modules/brk-client/index.js:126](https://github.com/b > `optional` **format**: [`Format`](../type-aliases/Format.md) -Defined in: [Developer/brk/modules/brk-client/index.js:127](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L127) +Defined in: [Developer/brk/modules/brk-client/index.js:183](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L183) + +Format of the output *** -### from? +### limit? -> `optional` **from**: `number` \| `null` +> `optional` **limit**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:128](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L128) +Defined in: [Developer/brk/modules/brk-client/index.js:182](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L182) + +Maximum number of values to return (ignored if `end` is set) *** -### to? +### start? -> `optional` **to**: `number` \| `null` +> `optional` **start**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:129](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L129) +Defined in: [Developer/brk/modules/brk-client/index.js:180](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L180) + +Inclusive starting index, if negative counts from end diff --git a/modules/brk-client/docs/interfaces/DifficultyAdjustment.md b/modules/brk-client/docs/interfaces/DifficultyAdjustment.md index 758fa1215..049a6f4a5 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:135](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L135) +Defined in: [Developer/brk/modules/brk-client/index.js:195](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L195) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:135](https://github.com/b > **adjustedTimeAvg**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:136](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L136) +Defined in: [Developer/brk/modules/brk-client/index.js:204](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L204) + +Time-adjusted average (accounting for timestamp manipulation) *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:136](https://github.com/b > **difficultyChange**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:137](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L137) +Defined in: [Developer/brk/modules/brk-client/index.js:197](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L197) + +Estimated difficulty change at next retarget (%) *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:137](https://github.com/b > **estimatedRetargetDate**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:138](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L138) +Defined in: [Developer/brk/modules/brk-client/index.js:198](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L198) + +Estimated Unix timestamp of next retarget *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:138](https://github.com/b > **nextRetargetHeight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:139](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L139) +Defined in: [Developer/brk/modules/brk-client/index.js:202](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L202) + +Height of next retarget *** @@ -46,7 +54,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:139](https://github.com/b > **previousRetarget**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:140](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L140) +Defined in: [Developer/brk/modules/brk-client/index.js:201](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L201) + +Previous difficulty adjustment (%) *** @@ -54,7 +64,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:140](https://github.com/b > **progressPercent**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:141](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L141) +Defined in: [Developer/brk/modules/brk-client/index.js:196](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L196) + +Progress through current difficulty epoch (0-100%) *** @@ -62,7 +74,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:141](https://github.com/b > **remainingBlocks**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:142](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L142) +Defined in: [Developer/brk/modules/brk-client/index.js:199](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L199) + +Blocks remaining until retarget *** @@ -70,7 +84,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:142](https://github.com/b > **remainingTime**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:143](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L143) +Defined in: [Developer/brk/modules/brk-client/index.js:200](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L200) + +Estimated seconds until retarget *** @@ -78,7 +94,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:143](https://github.com/b > **timeAvg**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:144](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L144) +Defined in: [Developer/brk/modules/brk-client/index.js:203](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L203) + +Average block time in current epoch (seconds) *** @@ -86,4 +104,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:144](https://github.com/b > **timeOffset**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:145](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L145) +Defined in: [Developer/brk/modules/brk-client/index.js:205](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L205) + +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 54b92fe3f..f8592e433 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:148](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L148) +Defined in: [Developer/brk/modules/brk-client/index.js:211](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L211) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:148](https://github.com/b > **changePercent**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:149](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L149) +Defined in: [Developer/brk/modules/brk-client/index.js:215](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L215) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:149](https://github.com/b > **difficulty**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:150](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L150) +Defined in: [Developer/brk/modules/brk-client/index.js:214](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L214) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:150](https://github.com/b > **height**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:151](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L151) +Defined in: [Developer/brk/modules/brk-client/index.js:213](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L213) *** @@ -38,4 +38,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:151](https://github.com/b > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:152](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L152) +Defined in: [Developer/brk/modules/brk-client/index.js:212](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L212) diff --git a/modules/brk-client/docs/interfaces/DifficultyEntry.md b/modules/brk-client/docs/interfaces/DifficultyEntry.md index ae572ae44..fad253a78 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:155](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L155) +Defined in: [Developer/brk/modules/brk-client/index.js:220](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L220) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:155](https://github.com/b > **difficulty**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:156](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L156) +Defined in: [Developer/brk/modules/brk-client/index.js:222](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L222) + +Difficulty value. *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:156](https://github.com/b > **height**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:157](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L157) +Defined in: [Developer/brk/modules/brk-client/index.js:223](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L223) + +Block height of the adjustment. *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:157](https://github.com/b > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:158](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L158) +Defined in: [Developer/brk/modules/brk-client/index.js:221](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L221) + +Unix timestamp of the difficulty adjustment. diff --git a/modules/brk-client/docs/interfaces/DiskUsage.md b/modules/brk-client/docs/interfaces/DiskUsage.md new file mode 100644 index 000000000..e01871d9b --- /dev/null +++ b/modules/brk-client/docs/interfaces/DiskUsage.md @@ -0,0 +1,59 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / DiskUsage + +# Interface: DiskUsage + +Defined in: [Developer/brk/modules/brk-client/index.js:229](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L229) + +## Properties + +### bitcoin + +> **bitcoin**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:232](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L232) + +Human-readable Bitcoin blocks directory size + +*** + +### bitcoinBytes + +> **bitcoinBytes**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:233](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L233) + +Bitcoin blocks directory size in bytes + +*** + +### brk + +> **brk**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:230](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L230) + +Human-readable brk data size (e.g., "48.8 GiB") + +*** + +### brkBytes + +> **brkBytes**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:231](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L231) + +brk data size in bytes + +*** + +### ratio + +> **ratio**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:234](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L234) + +brk as percentage of Bitcoin data diff --git a/modules/brk-client/docs/interfaces/DollarsPattern.md b/modules/brk-client/docs/interfaces/DollarsPattern.md index de375db19..8ecf16bbe 100644 --- a/modules/brk-client/docs/interfaces/DollarsPattern.md +++ b/modules/brk-client/docs/interfaces/DollarsPattern.md @@ -6,7 +6,7 @@ # Interface: DollarsPattern\ -Defined in: [Developer/brk/modules/brk-client/index.js:2763](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2763) +Defined in: [Developer/brk/modules/brk-client/index.js:2035](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2035) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2763](https://github.com/ > **average**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2764](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2764) +Defined in: [Developer/brk/modules/brk-client/index.js:2036](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2036) *** @@ -28,7 +28,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2764](https://github.com/ > **base**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2765](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2765) +Defined in: [Developer/brk/modules/brk-client/index.js:2037](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2037) *** @@ -36,7 +36,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2765](https://github.com/ > **cumulative**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2766](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2766) +Defined in: [Developer/brk/modules/brk-client/index.js:2038](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2038) *** @@ -44,7 +44,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2766](https://github.com/ > **max**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2767](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2767) +Defined in: [Developer/brk/modules/brk-client/index.js:2039](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2039) *** @@ -52,7 +52,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2767](https://github.com/ > **median**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2768](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2768) +Defined in: [Developer/brk/modules/brk-client/index.js:2040](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2040) *** @@ -60,7 +60,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2768](https://github.com/ > **min**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2769](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2769) +Defined in: [Developer/brk/modules/brk-client/index.js:2041](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2041) *** @@ -68,7 +68,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2769](https://github.com/ > **pct10**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2770](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2770) +Defined in: [Developer/brk/modules/brk-client/index.js:2042](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2042) *** @@ -76,7 +76,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2770](https://github.com/ > **pct25**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2771](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2771) +Defined in: [Developer/brk/modules/brk-client/index.js:2043](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2043) *** @@ -84,7 +84,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2771](https://github.com/ > **pct75**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2772](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2772) +Defined in: [Developer/brk/modules/brk-client/index.js:2044](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2044) *** @@ -92,7 +92,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2772](https://github.com/ > **pct90**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2773](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2773) +Defined in: [Developer/brk/modules/brk-client/index.js:2045](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2045) *** @@ -100,4 +100,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2773](https://github.com/ > **sum**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2774](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2774) +Defined in: [Developer/brk/modules/brk-client/index.js:2046](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2046) diff --git a/modules/brk-client/docs/interfaces/EmptyAddressData.md b/modules/brk-client/docs/interfaces/EmptyAddressData.md index 9a8a8bd86..f4b129c03 100644 --- a/modules/brk-client/docs/interfaces/EmptyAddressData.md +++ b/modules/brk-client/docs/interfaces/EmptyAddressData.md @@ -6,7 +6,7 @@ # Interface: EmptyAddressData -Defined in: [Developer/brk/modules/brk-client/index.js:163](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L163) +Defined in: [Developer/brk/modules/brk-client/index.js:244](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L244) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:163](https://github.com/b > **fundedTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:164](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L164) +Defined in: [Developer/brk/modules/brk-client/index.js:246](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L246) + +Total funded/spent transaction output count (equal since address is empty) *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:164](https://github.com/b > **transfered**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:165](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L165) +Defined in: [Developer/brk/modules/brk-client/index.js:247](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L247) + +Total satoshis transferred *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:165](https://github.com/b > **txCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:166](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L166) +Defined in: [Developer/brk/modules/brk-client/index.js:245](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L245) + +Total transaction count diff --git a/modules/brk-client/docs/interfaces/FeeRatePattern.md b/modules/brk-client/docs/interfaces/FeeRatePattern.md index 9a6efd695..f4a807590 100644 --- a/modules/brk-client/docs/interfaces/FeeRatePattern.md +++ b/modules/brk-client/docs/interfaces/FeeRatePattern.md @@ -6,7 +6,7 @@ # Interface: FeeRatePattern\ -Defined in: [Developer/brk/modules/brk-client/index.js:3077](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3077) +Defined in: [Developer/brk/modules/brk-client/index.js:2249](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2249) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3077](https://github.com/ > **average**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3078](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3078) +Defined in: [Developer/brk/modules/brk-client/index.js:2250](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2250) *** @@ -28,7 +28,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3078](https://github.com/ > **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3079](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3079) +Defined in: [Developer/brk/modules/brk-client/index.js:2251](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2251) *** @@ -36,7 +36,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3079](https://github.com/ > **median**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3080](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3080) +Defined in: [Developer/brk/modules/brk-client/index.js:2252](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2252) *** @@ -44,7 +44,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3080](https://github.com/ > **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3081](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3081) +Defined in: [Developer/brk/modules/brk-client/index.js:2253](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2253) *** @@ -52,7 +52,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3081](https://github.com/ > **pct10**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3082](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3082) +Defined in: [Developer/brk/modules/brk-client/index.js:2254](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2254) *** @@ -60,7 +60,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3082](https://github.com/ > **pct25**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3083](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3083) +Defined in: [Developer/brk/modules/brk-client/index.js:2255](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2255) *** @@ -68,7 +68,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3083](https://github.com/ > **pct75**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3084](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3084) +Defined in: [Developer/brk/modules/brk-client/index.js:2256](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2256) *** @@ -76,7 +76,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3084](https://github.com/ > **pct90**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3085](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3085) +Defined in: [Developer/brk/modules/brk-client/index.js:2257](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2257) *** @@ -84,4 +84,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3085](https://github.com/ > **txindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3086](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3086) +Defined in: [Developer/brk/modules/brk-client/index.js:2258](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2258) diff --git a/modules/brk-client/docs/interfaces/FullnessPattern.md b/modules/brk-client/docs/interfaces/FullnessPattern.md index e2b0b357e..0094f9f1b 100644 --- a/modules/brk-client/docs/interfaces/FullnessPattern.md +++ b/modules/brk-client/docs/interfaces/FullnessPattern.md @@ -6,7 +6,7 @@ # Interface: FullnessPattern\ -Defined in: [Developer/brk/modules/brk-client/index.js:2841](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2841) +Defined in: [Developer/brk/modules/brk-client/index.js:2214](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2214) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2841](https://github.com/ > **average**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2842](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2842) +Defined in: [Developer/brk/modules/brk-client/index.js:2215](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2215) *** @@ -28,15 +28,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2842](https://github.com/ > **base**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2843](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2843) - -*** - -### cumulative - -> **cumulative**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2844](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2844) +Defined in: [Developer/brk/modules/brk-client/index.js:2216](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2216) *** @@ -44,7 +36,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2844](https://github.com/ > **max**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2845](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2845) +Defined in: [Developer/brk/modules/brk-client/index.js:2217](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2217) *** @@ -52,7 +44,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2845](https://github.com/ > **median**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2846](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2846) +Defined in: [Developer/brk/modules/brk-client/index.js:2218](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2218) *** @@ -60,7 +52,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2846](https://github.com/ > **min**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2847](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2847) +Defined in: [Developer/brk/modules/brk-client/index.js:2219](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2219) *** @@ -68,7 +60,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2847](https://github.com/ > **pct10**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2848](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2848) +Defined in: [Developer/brk/modules/brk-client/index.js:2220](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2220) *** @@ -76,7 +68,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2848](https://github.com/ > **pct25**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2849](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2849) +Defined in: [Developer/brk/modules/brk-client/index.js:2221](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2221) *** @@ -84,7 +76,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2849](https://github.com/ > **pct75**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2850](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2850) +Defined in: [Developer/brk/modules/brk-client/index.js:2222](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2222) *** @@ -92,12 +84,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2850](https://github.com/ > **pct90**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2851](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2851) - -*** - -### sum - -> **sum**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2852](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2852) +Defined in: [Developer/brk/modules/brk-client/index.js:2223](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2223) diff --git a/modules/brk-client/docs/interfaces/HashrateEntry.md b/modules/brk-client/docs/interfaces/HashrateEntry.md index 3974688b4..913f4b0e6 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:174](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L174) +Defined in: [Developer/brk/modules/brk-client/index.js:265](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L265) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:174](https://github.com/b > **avgHashrate**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:175](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L175) +Defined in: [Developer/brk/modules/brk-client/index.js:267](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L267) + +Average hashrate (H/s). *** @@ -22,4 +24,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:175](https://github.com/b > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:176](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L176) +Defined in: [Developer/brk/modules/brk-client/index.js:266](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L266) + +Unix timestamp. diff --git a/modules/brk-client/docs/interfaces/HashrateSummary.md b/modules/brk-client/docs/interfaces/HashrateSummary.md index c89908531..c9f2856ce 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:179](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L179) +Defined in: [Developer/brk/modules/brk-client/index.js:272](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L272) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:179](https://github.com/b > **currentDifficulty**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:180](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L180) +Defined in: [Developer/brk/modules/brk-client/index.js:276](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L276) + +Current network difficulty. *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:180](https://github.com/b > **currentHashrate**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:181](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L181) +Defined in: [Developer/brk/modules/brk-client/index.js:275](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L275) + +Current network hashrate (H/s). *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:181](https://github.com/b > **difficulty**: [`DifficultyEntry`](DifficultyEntry.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:182](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L182) +Defined in: [Developer/brk/modules/brk-client/index.js:274](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L274) + +Historical difficulty adjustments. *** @@ -38,4 +44,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:182](https://github.com/b > **hashrates**: [`HashrateEntry`](HashrateEntry.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:183](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L183) +Defined in: [Developer/brk/modules/brk-client/index.js:273](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L273) + +Historical hashrate data points. diff --git a/modules/brk-client/docs/interfaces/Health.md b/modules/brk-client/docs/interfaces/Health.md index 27d8e1a95..14040a8a6 100644 --- a/modules/brk-client/docs/interfaces/Health.md +++ b/modules/brk-client/docs/interfaces/Health.md @@ -6,7 +6,7 @@ # Interface: Health -Defined in: [Developer/brk/modules/brk-client/index.js:186](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L186) +Defined in: [Developer/brk/modules/brk-client/index.js:281](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L281) ## Properties @@ -14,7 +14,17 @@ Defined in: [Developer/brk/modules/brk-client/index.js:186](https://github.com/b > **service**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:187](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L187) +Defined in: [Developer/brk/modules/brk-client/index.js:283](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L283) + +*** + +### startedAt + +> **startedAt**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:285](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L285) + +Server start time (ISO 8601) *** @@ -22,7 +32,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:187](https://github.com/b > **status**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:188](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L188) +Defined in: [Developer/brk/modules/brk-client/index.js:282](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L282) *** @@ -30,4 +40,14 @@ Defined in: [Developer/brk/modules/brk-client/index.js:188](https://github.com/b > **timestamp**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:189](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L189) +Defined in: [Developer/brk/modules/brk-client/index.js:284](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L284) + +*** + +### uptimeSeconds + +> **uptimeSeconds**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:286](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L286) + +Uptime in seconds diff --git a/modules/brk-client/docs/interfaces/HeightParam.md b/modules/brk-client/docs/interfaces/HeightParam.md index 777054a84..71bfc5452 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:193](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L193) +Defined in: [Developer/brk/modules/brk-client/index.js:294](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L294) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:193](https://github.com/b > **height**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:194](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L194) +Defined in: [Developer/brk/modules/brk-client/index.js:295](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L295) diff --git a/modules/brk-client/docs/interfaces/IndexInfo.md b/modules/brk-client/docs/interfaces/IndexInfo.md index 7328eca34..b77605dc2 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:200](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L200) +Defined in: [Developer/brk/modules/brk-client/index.js:316](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L316) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:200](https://github.com/b > **aliases**: `string`[] -Defined in: [Developer/brk/modules/brk-client/index.js:201](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L201) +Defined in: [Developer/brk/modules/brk-client/index.js:318](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L318) + +All Accepted query aliases *** @@ -22,4 +24,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:201](https://github.com/b > **index**: [`Index`](../type-aliases/Index.md) -Defined in: [Developer/brk/modules/brk-client/index.js:202](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L202) +Defined in: [Developer/brk/modules/brk-client/index.js:317](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L317) + +The canonical index name diff --git a/modules/brk-client/docs/interfaces/LimitParam.md b/modules/brk-client/docs/interfaces/LimitParam.md index a32e25215..71a12f1ec 100644 --- a/modules/brk-client/docs/interfaces/LimitParam.md +++ b/modules/brk-client/docs/interfaces/LimitParam.md @@ -6,7 +6,7 @@ # Interface: LimitParam -Defined in: [Developer/brk/modules/brk-client/index.js:206](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L206) +Defined in: [Developer/brk/modules/brk-client/index.js:326](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L326) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:206](https://github.com/b > `optional` **limit**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:207](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L207) +Defined in: [Developer/brk/modules/brk-client/index.js:327](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L327) diff --git a/modules/brk-client/docs/interfaces/LoadedAddressData.md b/modules/brk-client/docs/interfaces/LoadedAddressData.md index 0a2481918..0e7d95f12 100644 --- a/modules/brk-client/docs/interfaces/LoadedAddressData.md +++ b/modules/brk-client/docs/interfaces/LoadedAddressData.md @@ -6,7 +6,7 @@ # Interface: LoadedAddressData -Defined in: [Developer/brk/modules/brk-client/index.js:210](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L210) +Defined in: [Developer/brk/modules/brk-client/index.js:332](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L332) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:210](https://github.com/b > **fundedTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:211](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L211) +Defined in: [Developer/brk/modules/brk-client/index.js:334](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L334) + +Number of transaction outputs funded to this address *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:211](https://github.com/b > **realizedCap**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:212](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L212) +Defined in: [Developer/brk/modules/brk-client/index.js:338](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L338) + +The realized capitalization of this address *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:212](https://github.com/b > **received**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:213](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L213) +Defined in: [Developer/brk/modules/brk-client/index.js:336](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L336) + +Satoshis received by this address *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:213](https://github.com/b > **sent**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:214](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L214) +Defined in: [Developer/brk/modules/brk-client/index.js:337](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L337) + +Satoshis sent by this address *** @@ -46,7 +54,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:214](https://github.com/b > **spentTxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:215](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L215) +Defined in: [Developer/brk/modules/brk-client/index.js:335](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L335) + +Number of transaction outputs spent by this address *** @@ -54,4 +64,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:215](https://github.com/b > **txCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:216](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L216) +Defined in: [Developer/brk/modules/brk-client/index.js:333](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L333) + +Total transaction count diff --git a/modules/brk-client/docs/interfaces/LookbackPattern.md b/modules/brk-client/docs/interfaces/LookbackPattern.md new file mode 100644 index 000000000..6ea90b8a7 --- /dev/null +++ b/modules/brk-client/docs/interfaces/LookbackPattern.md @@ -0,0 +1,119 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / LookbackPattern + +# Interface: LookbackPattern\ + +Defined in: [Developer/brk/modules/brk-client/index.js:1836](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1836) + +## Type Parameters + +### T + +`T` + +## Properties + +### \_10y + +> **\_10y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1837](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1837) + +*** + +### \_1d + +> **\_1d**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1838](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1838) + +*** + +### \_1m + +> **\_1m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1839](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1839) + +*** + +### \_1w + +> **\_1w**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1840](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1840) + +*** + +### \_1y + +> **\_1y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1841](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1841) + +*** + +### \_2y + +> **\_2y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1842](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1842) + +*** + +### \_3m + +> **\_3m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1843](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1843) + +*** + +### \_3y + +> **\_3y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1844](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1844) + +*** + +### \_4y + +> **\_4y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1845](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1845) + +*** + +### \_5y + +> **\_5y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1846](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1846) + +*** + +### \_6m + +> **\_6m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1847](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1847) + +*** + +### \_6y + +> **\_6y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1848](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1848) + +*** + +### \_8y + +> **\_8y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:1849](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1849) diff --git a/modules/brk-client/docs/interfaces/MempoolBlock.md b/modules/brk-client/docs/interfaces/MempoolBlock.md index 635d39754..cfade4162 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:221](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L221) +Defined in: [Developer/brk/modules/brk-client/index.js:349](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L349) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:221](https://github.com/b > **blockSize**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:222](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L222) +Defined in: [Developer/brk/modules/brk-client/index.js:350](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L350) + +Total block size in weight units *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:222](https://github.com/b > **blockVSize**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:223](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L223) +Defined in: [Developer/brk/modules/brk-client/index.js:351](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L351) + +Total block virtual size in vbytes *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:223](https://github.com/b > **feeRange**: `number`[] -Defined in: [Developer/brk/modules/brk-client/index.js:224](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L224) +Defined in: [Developer/brk/modules/brk-client/index.js:355](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L355) + +Fee rate range: [min, 10%, 25%, 50%, 75%, 90%, max] *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:224](https://github.com/b > **medianFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:225](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L225) +Defined in: [Developer/brk/modules/brk-client/index.js:354](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L354) + +Median fee rate in sat/vB *** @@ -46,7 +54,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:225](https://github.com/b > **nTx**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:226](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L226) +Defined in: [Developer/brk/modules/brk-client/index.js:352](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L352) + +Number of transactions in the projected block *** @@ -54,4 +64,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:226](https://github.com/b > **totalFees**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:227](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L227) +Defined in: [Developer/brk/modules/brk-client/index.js:353](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L353) + +Total fees in satoshis diff --git a/modules/brk-client/docs/interfaces/MempoolInfo.md b/modules/brk-client/docs/interfaces/MempoolInfo.md index 94ef0b1ee..b39828ec6 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:230](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L230) +Defined in: [Developer/brk/modules/brk-client/index.js:360](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L360) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:230](https://github.com/b > **count**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:231](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L231) +Defined in: [Developer/brk/modules/brk-client/index.js:361](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L361) + +Number of transactions in the mempool *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:231](https://github.com/b > **totalFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:232](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L232) +Defined in: [Developer/brk/modules/brk-client/index.js:363](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L363) + +Total fees of all transactions in the mempool (satoshis) *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:232](https://github.com/b > **vsize**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:233](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L233) +Defined in: [Developer/brk/modules/brk-client/index.js:362](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L362) + +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 index eaccc97df..8df380a8d 100644 --- a/modules/brk-client/docs/interfaces/MetricCount.md +++ b/modules/brk-client/docs/interfaces/MetricCount.md @@ -6,7 +6,7 @@ # Interface: MetricCount -Defined in: [Developer/brk/modules/brk-client/index.js:237](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L237) +Defined in: [Developer/brk/modules/brk-client/index.js:373](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L373) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:237](https://github.com/b > **distinctMetrics**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:238](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L238) +Defined in: [Developer/brk/modules/brk-client/index.js:374](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L374) + +Number of unique metrics available (e.g., realized_price, market_cap) *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:238](https://github.com/b > **lazyEndpoints**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:239](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L239) +Defined in: [Developer/brk/modules/brk-client/index.js:376](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L376) + +Number of lazy (computed on-the-fly) metric-index combinations *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:239](https://github.com/b > **storedEndpoints**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:240](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L240) +Defined in: [Developer/brk/modules/brk-client/index.js:377](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L377) + +Number of eager (stored on disk) metric-index combinations *** @@ -38,4 +44,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:240](https://github.com/b > **totalEndpoints**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:241](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L241) +Defined in: [Developer/brk/modules/brk-client/index.js:375](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L375) + +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 index 682f68e28..fd823ef12 100644 --- a/modules/brk-client/docs/interfaces/MetricData.md +++ b/modules/brk-client/docs/interfaces/MetricData.md @@ -6,7 +6,7 @@ # Interface: MetricData\ -Defined in: [Developer/brk/modules/brk-client/index.js:546](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L546) +Defined in: [Developer/brk/modules/brk-client/index.js:831](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L831) ## Type Parameters @@ -20,29 +20,29 @@ Defined in: [Developer/brk/modules/brk-client/index.js:546](https://github.com/b > **data**: `T`[] -Defined in: [Developer/brk/modules/brk-client/index.js:550](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L550) +Defined in: [Developer/brk/modules/brk-client/index.js:835](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L835) The metric data *** -### from +### end -> **from**: `number` +> **end**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:548](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L548) +Defined in: [Developer/brk/modules/brk-client/index.js:834](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L834) -Start index (inclusive) +End index (exclusive) *** -### to +### start -> **to**: `number` +> **start**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:549](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L549) +Defined in: [Developer/brk/modules/brk-client/index.js:833](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L833) -End index (exclusive) +Start index (inclusive) *** @@ -50,6 +50,6 @@ End index (exclusive) > **total**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:547](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L547) +Defined in: [Developer/brk/modules/brk-client/index.js:832](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L832) Total number of data points diff --git a/modules/brk-client/docs/interfaces/MetricEndpoint.md b/modules/brk-client/docs/interfaces/MetricEndpoint.md deleted file mode 100644 index a3fffe1ae..000000000 --- a/modules/brk-client/docs/interfaces/MetricEndpoint.md +++ /dev/null @@ -1,73 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / MetricEndpoint - -# Interface: MetricEndpoint\ - -Defined in: [Developer/brk/modules/brk-client/index.js:556](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L556) - -## Type Parameters - -### T - -`T` - -## Properties - -### get() - -> **get**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> - -Defined in: [Developer/brk/modules/brk-client/index.js:557](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L557) - -Fetch all data points - -#### Parameters - -##### onUpdate? - -(`value`) => `void` - -#### Returns - -`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> - -*** - -### path - -> **path**: `string` - -Defined in: [Developer/brk/modules/brk-client/index.js:559](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L559) - -The endpoint path - -*** - -### range() - -> **range**: (`from?`, `to?`, `onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> - -Defined in: [Developer/brk/modules/brk-client/index.js:558](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L558) - -Fetch data in range - -#### Parameters - -##### from? - -`number` - -##### to? - -`number` - -##### onUpdate? - -(`value`) => `void` - -#### Returns - -`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> diff --git a/modules/brk-client/docs/interfaces/MetricEndpointBuilder.md b/modules/brk-client/docs/interfaces/MetricEndpointBuilder.md new file mode 100644 index 000000000..cbfa24488 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricEndpointBuilder.md @@ -0,0 +1,173 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricEndpointBuilder + +# Interface: MetricEndpointBuilder\ + +Defined in: [Developer/brk/modules/brk-client/index.js:848](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L848) + +## Type Parameters + +### T + +`T` + +## Properties + +### fetch() + +> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:854](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L854) + +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:855](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L855) + +Fetch all data as CSV + +#### Returns + +`Promise`\<`string`\> + +*** + +### first() + +> **first**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:851](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L851) + +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:849](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L849) + +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:852](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L852) + +Get last n items + +#### Parameters + +##### n + +`number` + +#### Returns + +[`RangeBuilder`](RangeBuilder.md)\<`T`\> + +*** + +### path + +> **path**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:857](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L857) + +The endpoint path + +*** + +### skip() + +> **skip**: (`n`) => [`SkippedBuilder`](SkippedBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:853](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L853) + +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:850](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L850) + +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:856](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L856) + +Thenable (await endpoint) diff --git a/modules/brk-client/docs/interfaces/MetricLeafWithSchema.md b/modules/brk-client/docs/interfaces/MetricLeafWithSchema.md index 966009076..4586e3583 100644 --- a/modules/brk-client/docs/interfaces/MetricLeafWithSchema.md +++ b/modules/brk-client/docs/interfaces/MetricLeafWithSchema.md @@ -6,7 +6,7 @@ # Interface: MetricLeafWithSchema -Defined in: [Developer/brk/modules/brk-client/index.js:244](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L244) +Defined in: [Developer/brk/modules/brk-client/index.js:382](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L382) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:244](https://github.com/b > **indexes**: [`Index`](../type-aliases/Index.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:245](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L245) +Defined in: [Developer/brk/modules/brk-client/index.js:385](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L385) + +Available indexes for this metric *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:245](https://github.com/b > **kind**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:246](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L246) +Defined in: [Developer/brk/modules/brk-client/index.js:384](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L384) + +The Rust type (e.g., "Sats", "StoredF64") *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:246](https://github.com/b > **name**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:247](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L247) +Defined in: [Developer/brk/modules/brk-client/index.js:383](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L383) + +The metric name/identifier *** @@ -38,4 +44,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:247](https://github.com/b > **type**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:248](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L248) +Defined in: [Developer/brk/modules/brk-client/index.js:386](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L386) + +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 index 35e0dce50..f153906db 100644 --- a/modules/brk-client/docs/interfaces/MetricParam.md +++ b/modules/brk-client/docs/interfaces/MetricParam.md @@ -6,7 +6,7 @@ # Interface: MetricParam -Defined in: [Developer/brk/modules/brk-client/index.js:251](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L251) +Defined in: [Developer/brk/modules/brk-client/index.js:389](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L389) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:251](https://github.com/b > **metric**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:252](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L252) +Defined in: [Developer/brk/modules/brk-client/index.js:390](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L390) diff --git a/modules/brk-client/docs/interfaces/MetricPattern.md b/modules/brk-client/docs/interfaces/MetricPattern.md index 5fbf2d4ad..04094f8ff 100644 --- a/modules/brk-client/docs/interfaces/MetricPattern.md +++ b/modules/brk-client/docs/interfaces/MetricPattern.md @@ -6,7 +6,7 @@ # Interface: MetricPattern\ -Defined in: [Developer/brk/modules/brk-client/index.js:565](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L565) +Defined in: [Developer/brk/modules/brk-client/index.js:888](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L888) ## Type Parameters @@ -18,19 +18,19 @@ Defined in: [Developer/brk/modules/brk-client/index.js:565](https://github.com/b ### by -> **by**: `Partial`\<`Record`\<[`Index`](../type-aliases/Index.md), [`MetricEndpoint`](MetricEndpoint.md)\<`T`\>\>\> +> **by**: `Readonly`\<`Partial`\<`Record`\<[`Index`](../type-aliases/Index.md), [`MetricEndpointBuilder`](MetricEndpointBuilder.md)\<`T`\>\>\>\> -Defined in: [Developer/brk/modules/brk-client/index.js:567](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L567) +Defined in: [Developer/brk/modules/brk-client/index.js:890](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L890) -Index endpoints (lazy getters) +Index endpoints as lazy getters. Access via .by.dateindex or .by['dateindex'] *** ### get() -> **get**: (`index`) => [`MetricEndpoint`](MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](MetricEndpointBuilder.md)\<`T`\> \| `undefined` -Defined in: [Developer/brk/modules/brk-client/index.js:569](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L569) +Defined in: [Developer/brk/modules/brk-client/index.js:892](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L892) Get an endpoint for a specific index @@ -42,21 +42,21 @@ Get an endpoint for a specific index #### Returns -[`MetricEndpoint`](MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](MetricEndpointBuilder.md)\<`T`\> \| `undefined` *** ### indexes() -> **indexes**: () => [`Index`](../type-aliases/Index.md)[] +> **indexes**: () => readonly [`Index`](../type-aliases/Index.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:568](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L568) +Defined in: [Developer/brk/modules/brk-client/index.js:891](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L891) Get the list of available indexes #### Returns -[`Index`](../type-aliases/Index.md)[] +readonly [`Index`](../type-aliases/Index.md)[] *** @@ -64,6 +64,6 @@ Get the list of available indexes > **name**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:566](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L566) +Defined in: [Developer/brk/modules/brk-client/index.js:889](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L889) The metric name diff --git a/modules/brk-client/docs/interfaces/MetricSelection.md b/modules/brk-client/docs/interfaces/MetricSelection.md index 6154fd939..f6c788dfe 100644 --- a/modules/brk-client/docs/interfaces/MetricSelection.md +++ b/modules/brk-client/docs/interfaces/MetricSelection.md @@ -6,15 +6,17 @@ # Interface: MetricSelection -Defined in: [Developer/brk/modules/brk-client/index.js:255](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L255) +Defined in: [Developer/brk/modules/brk-client/index.js:395](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L395) ## Properties -### count? +### end? -> `optional` **count**: `number` \| `null` +> `optional` **end**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:256](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L256) +Defined in: [Developer/brk/modules/brk-client/index.js:399](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L399) + +Exclusive ending index, if negative counts from end *** @@ -22,15 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:256](https://github.com/b > `optional` **format**: [`Format`](../type-aliases/Format.md) -Defined in: [Developer/brk/modules/brk-client/index.js:257](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L257) +Defined in: [Developer/brk/modules/brk-client/index.js:401](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L401) -*** - -### from? - -> `optional` **from**: `number` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:258](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L258) +Format of the output *** @@ -38,7 +34,19 @@ Defined in: [Developer/brk/modules/brk-client/index.js:258](https://github.com/b > **index**: [`Index`](../type-aliases/Index.md) -Defined in: [Developer/brk/modules/brk-client/index.js:259](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L259) +Defined in: [Developer/brk/modules/brk-client/index.js:397](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L397) + +Index to query + +*** + +### limit? + +> `optional` **limit**: `number` \| `null` + +Defined in: [Developer/brk/modules/brk-client/index.js:400](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L400) + +Maximum number of values to return (ignored if `end` is set) *** @@ -46,12 +54,16 @@ Defined in: [Developer/brk/modules/brk-client/index.js:259](https://github.com/b > **metrics**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:260](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L260) +Defined in: [Developer/brk/modules/brk-client/index.js:396](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L396) + +Requested metrics *** -### to? +### start? -> `optional` **to**: `number` \| `null` +> `optional` **start**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:261](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L261) +Defined in: [Developer/brk/modules/brk-client/index.js:398](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L398) + +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 index acb6951d8..ae59eaae6 100644 --- a/modules/brk-client/docs/interfaces/MetricSelectionLegacy.md +++ b/modules/brk-client/docs/interfaces/MetricSelectionLegacy.md @@ -6,15 +6,17 @@ # Interface: MetricSelectionLegacy -Defined in: [Developer/brk/modules/brk-client/index.js:264](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L264) +Defined in: [Developer/brk/modules/brk-client/index.js:406](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L406) ## Properties -### count? +### end? -> `optional` **count**: `number` \| `null` +> `optional` **end**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:265](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L265) +Defined in: [Developer/brk/modules/brk-client/index.js:410](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L410) + +Exclusive ending index, if negative counts from end *** @@ -22,15 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:265](https://github.com/b > `optional` **format**: [`Format`](../type-aliases/Format.md) -Defined in: [Developer/brk/modules/brk-client/index.js:266](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L266) +Defined in: [Developer/brk/modules/brk-client/index.js:412](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L412) -*** - -### from? - -> `optional` **from**: `number` \| `null` - -Defined in: [Developer/brk/modules/brk-client/index.js:267](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L267) +Format of the output *** @@ -38,7 +34,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:267](https://github.com/b > **ids**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:268](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L268) +Defined in: [Developer/brk/modules/brk-client/index.js:408](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L408) *** @@ -46,12 +42,24 @@ Defined in: [Developer/brk/modules/brk-client/index.js:268](https://github.com/b > **index**: [`Index`](../type-aliases/Index.md) -Defined in: [Developer/brk/modules/brk-client/index.js:269](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L269) +Defined in: [Developer/brk/modules/brk-client/index.js:407](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L407) *** -### to? +### limit? -> `optional` **to**: `number` \| `null` +> `optional` **limit**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:270](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L270) +Defined in: [Developer/brk/modules/brk-client/index.js:411](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L411) + +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:409](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L409) + +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 index d2f07159f..2924a091e 100644 --- a/modules/brk-client/docs/interfaces/MetricWithIndex.md +++ b/modules/brk-client/docs/interfaces/MetricWithIndex.md @@ -6,7 +6,7 @@ # Interface: MetricWithIndex -Defined in: [Developer/brk/modules/brk-client/index.js:273](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L273) +Defined in: [Developer/brk/modules/brk-client/index.js:415](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L415) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:273](https://github.com/b > **index**: [`Index`](../type-aliases/Index.md) -Defined in: [Developer/brk/modules/brk-client/index.js:274](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L274) +Defined in: [Developer/brk/modules/brk-client/index.js:417](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L417) + +Aggregation index *** @@ -22,4 +24,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:274](https://github.com/b > **metric**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:275](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L275) +Defined in: [Developer/brk/modules/brk-client/index.js:416](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L416) + +Metric name diff --git a/modules/brk-client/docs/interfaces/MetricsTree.md b/modules/brk-client/docs/interfaces/MetricsTree.md new file mode 100644 index 000000000..ca7395c16 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree + +# Interface: MetricsTree + +Defined in: [Developer/brk/modules/brk-client/index.js:2860](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2860) + +## Properties + +### addresses + +> **addresses**: [`MetricsTree_Addresses`](MetricsTree_Addresses.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2861](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2861) + +*** + +### blocks + +> **blocks**: [`MetricsTree_Blocks`](MetricsTree_Blocks.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2862](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2862) + +*** + +### cointime + +> **cointime**: [`MetricsTree_Cointime`](MetricsTree_Cointime.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2863](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2863) + +*** + +### constants + +> **constants**: [`MetricsTree_Constants`](MetricsTree_Constants.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2864](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2864) + +*** + +### distribution + +> **distribution**: [`MetricsTree_Distribution`](MetricsTree_Distribution.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2865](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2865) + +*** + +### indexes + +> **indexes**: [`MetricsTree_Indexes`](MetricsTree_Indexes.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2866](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2866) + +*** + +### inputs + +> **inputs**: [`MetricsTree_Inputs`](MetricsTree_Inputs.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2867](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2867) + +*** + +### market + +> **market**: [`MetricsTree_Market`](MetricsTree_Market.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2868](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2868) + +*** + +### outputs + +> **outputs**: [`MetricsTree_Outputs`](MetricsTree_Outputs.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2869](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2869) + +*** + +### pools + +> **pools**: [`MetricsTree_Pools`](MetricsTree_Pools.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2870](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2870) + +*** + +### positions + +> **positions**: [`MetricsTree_Positions`](MetricsTree_Positions.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2871](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2871) + +*** + +### price + +> **price**: [`MetricsTree_Price`](MetricsTree_Price.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2872](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2872) + +*** + +### scripts + +> **scripts**: [`MetricsTree_Scripts`](MetricsTree_Scripts.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2873](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2873) + +*** + +### supply + +> **supply**: [`MetricsTree_Supply`](MetricsTree_Supply.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2874](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2874) + +*** + +### transactions + +> **transactions**: [`MetricsTree_Transactions`](MetricsTree_Transactions.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2875](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2875) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Addresses.md b/modules/brk-client/docs/interfaces/MetricsTree_Addresses.md new file mode 100644 index 000000000..03541c10d --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Addresses.md @@ -0,0 +1,137 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Addresses + +# Interface: MetricsTree\_Addresses + +Defined in: [Developer/brk/modules/brk-client/index.js:2879](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2879) + +## Properties + +### firstP2aaddressindex + +> **firstP2aaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2880](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2880) + +*** + +### firstP2pk33addressindex + +> **firstP2pk33addressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2881](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2881) + +*** + +### firstP2pk65addressindex + +> **firstP2pk65addressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2882](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2882) + +*** + +### firstP2pkhaddressindex + +> **firstP2pkhaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2883](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2883) + +*** + +### firstP2shaddressindex + +> **firstP2shaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2884](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2884) + +*** + +### firstP2traddressindex + +> **firstP2traddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2885](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2885) + +*** + +### firstP2wpkhaddressindex + +> **firstP2wpkhaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2886](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2886) + +*** + +### firstP2wshaddressindex + +> **firstP2wshaddressindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2887](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2887) + +*** + +### p2abytes + +> **p2abytes**: [`MetricPattern16`](../type-aliases/MetricPattern16.md)\<[`U8x2`](../type-aliases/U8x2.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2888](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2888) + +*** + +### p2pk33bytes + +> **p2pk33bytes**: [`MetricPattern18`](../type-aliases/MetricPattern18.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2889](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2889) + +*** + +### p2pk65bytes + +> **p2pk65bytes**: [`MetricPattern19`](../type-aliases/MetricPattern19.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2890](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2890) + +*** + +### p2pkhbytes + +> **p2pkhbytes**: [`MetricPattern20`](../type-aliases/MetricPattern20.md)\<[`U8x20`](../type-aliases/U8x20.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2891](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2891) + +*** + +### p2shbytes + +> **p2shbytes**: [`MetricPattern21`](../type-aliases/MetricPattern21.md)\<[`U8x20`](../type-aliases/U8x20.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2892](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2892) + +*** + +### p2trbytes + +> **p2trbytes**: [`MetricPattern22`](../type-aliases/MetricPattern22.md)\<[`U8x32`](../type-aliases/U8x32.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2893](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2893) + +*** + +### p2wpkhbytes + +> **p2wpkhbytes**: [`MetricPattern23`](../type-aliases/MetricPattern23.md)\<[`U8x20`](../type-aliases/U8x20.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2894](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2894) + +*** + +### p2wshbytes + +> **p2wshbytes**: [`MetricPattern24`](../type-aliases/MetricPattern24.md)\<[`U8x32`](../type-aliases/U8x32.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2895](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2895) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks.md new file mode 100644 index 000000000..5f08e5ea3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Blocks.md @@ -0,0 +1,113 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Blocks + +# Interface: MetricsTree\_Blocks + +Defined in: [Developer/brk/modules/brk-client/index.js:2899](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2899) + +## Properties + +### blockhash + +> **blockhash**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2900](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2900) + +*** + +### count + +> **count**: [`MetricsTree_Blocks_Count`](MetricsTree_Blocks_Count.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2901](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2901) + +*** + +### difficulty + +> **difficulty**: [`MetricsTree_Blocks_Difficulty`](MetricsTree_Blocks_Difficulty.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2902](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2902) + +*** + +### fullness + +> **fullness**: [`FullnessPattern`](FullnessPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2903](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2903) + +*** + +### halving + +> **halving**: [`MetricsTree_Blocks_Halving`](MetricsTree_Blocks_Halving.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2904](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2904) + +*** + +### interval + +> **interval**: [`FullnessPattern`](FullnessPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2905](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2905) + +*** + +### mining + +> **mining**: [`MetricsTree_Blocks_Mining`](MetricsTree_Blocks_Mining.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2906](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2906) + +*** + +### rewards + +> **rewards**: [`MetricsTree_Blocks_Rewards`](MetricsTree_Blocks_Rewards.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2907](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2907) + +*** + +### size + +> **size**: [`MetricsTree_Blocks_Size`](MetricsTree_Blocks_Size.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2908](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2908) + +*** + +### time + +> **time**: [`MetricsTree_Blocks_Time`](MetricsTree_Blocks_Time.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2909](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2909) + +*** + +### totalSize + +> **totalSize**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2910](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2910) + +*** + +### vbytes + +> **vbytes**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2911](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2911) + +*** + +### weight + +> **weight**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2912](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2912) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Count.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Count.md new file mode 100644 index 000000000..84ae0fddd --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Count.md @@ -0,0 +1,89 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Blocks\_Count + +# Interface: MetricsTree\_Blocks\_Count + +Defined in: [Developer/brk/modules/brk-client/index.js:2916](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2916) + +## Properties + +### \_1mBlockCount + +> **\_1mBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2917](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2917) + +*** + +### \_1mStart + +> **\_1mStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2918](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2918) + +*** + +### \_1wBlockCount + +> **\_1wBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2919](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2919) + +*** + +### \_1wStart + +> **\_1wStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2920](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2920) + +*** + +### \_1yBlockCount + +> **\_1yBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2921](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2921) + +*** + +### \_1yStart + +> **\_1yStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2922](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2922) + +*** + +### \_24hBlockCount + +> **\_24hBlockCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2923](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2923) + +*** + +### \_24hStart + +> **\_24hStart**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2924](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2924) + +*** + +### blockCount + +> **blockCount**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2925](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2925) + +*** + +### blockCountTarget + +> **blockCountTarget**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2926](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2926) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Difficulty.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Difficulty.md new file mode 100644 index 000000000..e16a3b8d9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Difficulty.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Blocks\_Difficulty + +# Interface: MetricsTree\_Blocks\_Difficulty + +Defined in: [Developer/brk/modules/brk-client/index.js:2930](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2930) + +## Properties + +### adjustment + +> **adjustment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2931](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2931) + +*** + +### asHash + +> **asHash**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2932](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2932) + +*** + +### blocksBeforeNextAdjustment + +> **blocksBeforeNextAdjustment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2933](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2933) + +*** + +### daysBeforeNextAdjustment + +> **daysBeforeNextAdjustment**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2934](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2934) + +*** + +### epoch + +> **epoch**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2935](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2935) + +*** + +### raw + +> **raw**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2936](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2936) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Halving.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Halving.md new file mode 100644 index 000000000..fd8b6dfd5 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Halving.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Blocks\_Halving + +# Interface: MetricsTree\_Blocks\_Halving + +Defined in: [Developer/brk/modules/brk-client/index.js:2940](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2940) + +## Properties + +### blocksBeforeNextHalving + +> **blocksBeforeNextHalving**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2941](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2941) + +*** + +### daysBeforeNextHalving + +> **daysBeforeNextHalving**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2942](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2942) + +*** + +### epoch + +> **epoch**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2943](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2943) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Mining.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Mining.md new file mode 100644 index 000000000..b3897ae1d --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Mining.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Blocks\_Mining + +# Interface: MetricsTree\_Blocks\_Mining + +Defined in: [Developer/brk/modules/brk-client/index.js:2947](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2947) + +## Properties + +### hashPricePhs + +> **hashPricePhs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2948](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2948) + +*** + +### hashPricePhsMin + +> **hashPricePhsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2949](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2949) + +*** + +### hashPriceRebound + +> **hashPriceRebound**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2950](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2950) + +*** + +### hashPriceThs + +> **hashPriceThs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2951](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2951) + +*** + +### hashPriceThsMin + +> **hashPriceThsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2952](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2952) + +*** + +### hashRate + +> **hashRate**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2953](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2953) + +*** + +### hashRate1mSma + +> **hashRate1mSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2954](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2954) + +*** + +### hashRate1wSma + +> **hashRate1wSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2955](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2955) + +*** + +### hashRate1ySma + +> **hashRate1ySma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2956](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2956) + +*** + +### hashRate2mSma + +> **hashRate2mSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2957](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2957) + +*** + +### hashValuePhs + +> **hashValuePhs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2958](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2958) + +*** + +### hashValuePhsMin + +> **hashValuePhsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2959](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2959) + +*** + +### hashValueRebound + +> **hashValueRebound**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2960](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2960) + +*** + +### hashValueThs + +> **hashValueThs**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2961](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2961) + +*** + +### hashValueThsMin + +> **hashValueThsMin**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2962](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2962) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards.md new file mode 100644 index 000000000..2b552ccee --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Blocks\_Rewards + +# Interface: MetricsTree\_Blocks\_Rewards + +Defined in: [Developer/brk/modules/brk-client/index.js:2966](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2966) + +## Properties + +### \_24hCoinbaseSum + +> **\_24hCoinbaseSum**: [`MetricsTree_Blocks_Rewards_24hCoinbaseSum`](MetricsTree_Blocks_Rewards_24hCoinbaseSum.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2967](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2967) + +*** + +### coinbase + +> **coinbase**: [`CoinbasePattern`](CoinbasePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2968](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2968) + +*** + +### feeDominance + +> **feeDominance**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2969](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2969) + +*** + +### subsidy + +> **subsidy**: [`CoinbasePattern`](CoinbasePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2970](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2970) + +*** + +### subsidyDominance + +> **subsidyDominance**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2971](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2971) + +*** + +### subsidyUsd1ySma + +> **subsidyUsd1ySma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2972](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2972) + +*** + +### unclaimedRewards + +> **unclaimedRewards**: [`UnclaimedRewardsPattern`](UnclaimedRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:2973](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2973) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards_24hCoinbaseSum.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards_24hCoinbaseSum.md new file mode 100644 index 000000000..6b30a1188 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Rewards_24hCoinbaseSum.md @@ -0,0 +1,33 @@ +[**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:2977](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2977) + +## Properties + +### bitcoin + +> **bitcoin**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2978](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2978) + +*** + +### dollars + +> **dollars**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2979](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2979) + +*** + +### sats + +> **sats**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2980](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2980) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Size.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Size.md new file mode 100644 index 000000000..6593c7c1b --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Size.md @@ -0,0 +1,89 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Blocks\_Size + +# Interface: MetricsTree\_Blocks\_Size + +Defined in: [Developer/brk/modules/brk-client/index.js:2984](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2984) + +## Properties + +### average + +> **average**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2985](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2985) + +*** + +### cumulative + +> **cumulative**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2986](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2986) + +*** + +### max + +> **max**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2987](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2987) + +*** + +### median + +> **median**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2988](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2988) + +*** + +### min + +> **min**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2989](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2989) + +*** + +### pct10 + +> **pct10**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2990](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2990) + +*** + +### pct25 + +> **pct25**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2991](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2991) + +*** + +### pct75 + +> **pct75**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2992](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2992) + +*** + +### pct90 + +> **pct90**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2993](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2993) + +*** + +### sum + +> **sum**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2994](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2994) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Time.md b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Time.md new file mode 100644 index 000000000..f189c0045 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Blocks_Time.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Blocks\_Time + +# Interface: MetricsTree\_Blocks\_Time + +Defined in: [Developer/brk/modules/brk-client/index.js:2998](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2998) + +## Properties + +### date + +> **date**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:2999](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2999) + +*** + +### timestamp + +> **timestamp**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3000](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3000) + +*** + +### timestampMonotonic + +> **timestampMonotonic**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3001](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3001) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime.md new file mode 100644 index 000000000..7c21286da --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Cointime.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Cointime + +# Interface: MetricsTree\_Cointime + +Defined in: [Developer/brk/modules/brk-client/index.js:3005](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3005) + +## Properties + +### activity + +> **activity**: [`MetricsTree_Cointime_Activity`](MetricsTree_Cointime_Activity.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3006](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3006) + +*** + +### adjusted + +> **adjusted**: [`MetricsTree_Cointime_Adjusted`](MetricsTree_Cointime_Adjusted.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3007](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3007) + +*** + +### cap + +> **cap**: [`MetricsTree_Cointime_Cap`](MetricsTree_Cointime_Cap.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3008](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3008) + +*** + +### pricing + +> **pricing**: [`MetricsTree_Cointime_Pricing`](MetricsTree_Cointime_Pricing.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3009](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3009) + +*** + +### supply + +> **supply**: [`MetricsTree_Cointime_Supply`](MetricsTree_Cointime_Supply.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3010](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3010) + +*** + +### value + +> **value**: [`MetricsTree_Cointime_Value`](MetricsTree_Cointime_Value.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3011](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3011) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Activity.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Activity.md new file mode 100644 index 000000000..e3039fbfb --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Activity.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Cointime\_Activity + +# Interface: MetricsTree\_Cointime\_Activity + +Defined in: [Developer/brk/modules/brk-client/index.js:3015](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3015) + +## Properties + +### activityToVaultednessRatio + +> **activityToVaultednessRatio**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3016](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3016) + +*** + +### coinblocksCreated + +> **coinblocksCreated**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3017](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3017) + +*** + +### coinblocksStored + +> **coinblocksStored**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3018](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3018) + +*** + +### liveliness + +> **liveliness**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3019](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3019) + +*** + +### vaultedness + +> **vaultedness**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3020](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3020) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Adjusted.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Adjusted.md new file mode 100644 index 000000000..0853417ec --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Adjusted.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Cointime\_Adjusted + +# Interface: MetricsTree\_Cointime\_Adjusted + +Defined in: [Developer/brk/modules/brk-client/index.js:3024](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3024) + +## Properties + +### cointimeAdjInflationRate + +> **cointimeAdjInflationRate**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3025](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3025) + +*** + +### cointimeAdjTxBtcVelocity + +> **cointimeAdjTxBtcVelocity**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3026](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3026) + +*** + +### cointimeAdjTxUsdVelocity + +> **cointimeAdjTxUsdVelocity**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3027](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3027) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Cap.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Cap.md new file mode 100644 index 000000000..d34d2cbf2 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Cap.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Cointime\_Cap + +# Interface: MetricsTree\_Cointime\_Cap + +Defined in: [Developer/brk/modules/brk-client/index.js:3031](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3031) + +## Properties + +### activeCap + +> **activeCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3032](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3032) + +*** + +### cointimeCap + +> **cointimeCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3033](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3033) + +*** + +### investorCap + +> **investorCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3034](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3034) + +*** + +### thermoCap + +> **thermoCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3035](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3035) + +*** + +### vaultedCap + +> **vaultedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3036](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3036) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Pricing.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Pricing.md new file mode 100644 index 000000000..b585092f3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Pricing.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Cointime\_Pricing + +# Interface: MetricsTree\_Cointime\_Pricing + +Defined in: [Developer/brk/modules/brk-client/index.js:3040](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3040) + +## Properties + +### activePrice + +> **activePrice**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3041](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3041) + +*** + +### activePriceRatio + +> **activePriceRatio**: [`ActivePriceRatioPattern`](ActivePriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3042](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3042) + +*** + +### cointimePrice + +> **cointimePrice**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3043](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3043) + +*** + +### cointimePriceRatio + +> **cointimePriceRatio**: [`ActivePriceRatioPattern`](ActivePriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3044](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3044) + +*** + +### trueMarketMean + +> **trueMarketMean**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3045](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3045) + +*** + +### trueMarketMeanRatio + +> **trueMarketMeanRatio**: [`ActivePriceRatioPattern`](ActivePriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3046](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3046) + +*** + +### vaultedPrice + +> **vaultedPrice**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3047](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3047) + +*** + +### vaultedPriceRatio + +> **vaultedPriceRatio**: [`ActivePriceRatioPattern`](ActivePriceRatioPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3048](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3048) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Supply.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Supply.md new file mode 100644 index 000000000..2d5195549 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Supply.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Cointime\_Supply + +# Interface: MetricsTree\_Cointime\_Supply + +Defined in: [Developer/brk/modules/brk-client/index.js:3052](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3052) + +## Properties + +### activeSupply + +> **activeSupply**: [`ActiveSupplyPattern`](ActiveSupplyPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3053](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3053) + +*** + +### vaultedSupply + +> **vaultedSupply**: [`ActiveSupplyPattern`](ActiveSupplyPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3054](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3054) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Value.md b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Value.md new file mode 100644 index 000000000..7b934b117 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Cointime_Value.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Cointime\_Value + +# Interface: MetricsTree\_Cointime\_Value + +Defined in: [Developer/brk/modules/brk-client/index.js:3058](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3058) + +## Properties + +### cointimeValueCreated + +> **cointimeValueCreated**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3059](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3059) + +*** + +### cointimeValueDestroyed + +> **cointimeValueDestroyed**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3060](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3060) + +*** + +### cointimeValueStored + +> **cointimeValueStored**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3061](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3061) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Constants.md b/modules/brk-client/docs/interfaces/MetricsTree_Constants.md new file mode 100644 index 000000000..b4db2319c --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Constants.md @@ -0,0 +1,153 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Constants + +# Interface: MetricsTree\_Constants + +Defined in: [Developer/brk/modules/brk-client/index.js:3065](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3065) + +## Properties + +### constant0 + +> **constant0**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3066](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3066) + +*** + +### constant1 + +> **constant1**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3067](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3067) + +*** + +### constant100 + +> **constant100**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3068](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3068) + +*** + +### constant2 + +> **constant2**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3069](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3069) + +*** + +### constant20 + +> **constant20**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3070](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3070) + +*** + +### constant3 + +> **constant3**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3071](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3071) + +*** + +### constant30 + +> **constant30**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3072](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3072) + +*** + +### constant382 + +> **constant382**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3073](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3073) + +*** + +### constant4 + +> **constant4**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3074](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3074) + +*** + +### constant50 + +> **constant50**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3075](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3075) + +*** + +### constant600 + +> **constant600**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3076](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3076) + +*** + +### constant618 + +> **constant618**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3077](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3077) + +*** + +### constant70 + +> **constant70**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3078](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3078) + +*** + +### constant80 + +> **constant80**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3079](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3079) + +*** + +### constantMinus1 + +> **constantMinus1**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3080](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3080) + +*** + +### constantMinus2 + +> **constantMinus2**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3081](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3081) + +*** + +### constantMinus3 + +> **constantMinus3**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3082](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3082) + +*** + +### constantMinus4 + +> **constantMinus4**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3083](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3083) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution.md new file mode 100644 index 000000000..05ed3eee3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Distribution + +# Interface: MetricsTree\_Distribution + +Defined in: [Developer/brk/modules/brk-client/index.js:3087](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3087) + +## Properties + +### addrCount + +> **addrCount**: [`AddrCountPattern`](AddrCountPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3088](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3088) + +*** + +### addressCohorts + +> **addressCohorts**: [`MetricsTree_Distribution_AddressCohorts`](MetricsTree_Distribution_AddressCohorts.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3089](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3089) + +*** + +### addressesData + +> **addressesData**: [`MetricsTree_Distribution_AddressesData`](MetricsTree_Distribution_AddressesData.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3090](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3090) + +*** + +### anyAddressIndexes + +> **anyAddressIndexes**: [`MetricsTree_Distribution_AnyAddressIndexes`](MetricsTree_Distribution_AnyAddressIndexes.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3091](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3091) + +*** + +### chainState + +> **chainState**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<[`SupplyState`](SupplyState.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3092](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3092) + +*** + +### emptyAddrCount + +> **emptyAddrCount**: [`AddrCountPattern`](AddrCountPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3093](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3093) + +*** + +### emptyaddressindex + +> **emptyaddressindex**: [`MetricPattern32`](../type-aliases/MetricPattern32.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3094](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3094) + +*** + +### loadedaddressindex + +> **loadedaddressindex**: [`MetricPattern31`](../type-aliases/MetricPattern31.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3095](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3095) + +*** + +### utxoCohorts + +> **utxoCohorts**: [`MetricsTree_Distribution_UtxoCohorts`](MetricsTree_Distribution_UtxoCohorts.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3096](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3096) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts.md new file mode 100644 index 000000000..2a03d7ad3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Distribution\_AddressCohorts + +# Interface: MetricsTree\_Distribution\_AddressCohorts + +Defined in: [Developer/brk/modules/brk-client/index.js:3100](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3100) + +## Properties + +### amountRange + +> **amountRange**: [`MetricsTree_Distribution_AddressCohorts_AmountRange`](MetricsTree_Distribution_AddressCohorts_AmountRange.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3101](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3101) + +*** + +### geAmount + +> **geAmount**: [`MetricsTree_Distribution_AddressCohorts_GeAmount`](MetricsTree_Distribution_AddressCohorts_GeAmount.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3102](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3102) + +*** + +### ltAmount + +> **ltAmount**: [`MetricsTree_Distribution_AddressCohorts_LtAmount`](MetricsTree_Distribution_AddressCohorts_LtAmount.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3103](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3103) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_AmountRange.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_AmountRange.md new file mode 100644 index 000000000..ef08f15b1 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_AmountRange.md @@ -0,0 +1,129 @@ +[**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:3107](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3107) + +## Properties + +### \_0sats + +> **\_0sats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3108](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3108) + +*** + +### \_100btcTo1kBtc + +> **\_100btcTo1kBtc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3109](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3109) + +*** + +### \_100kBtcOrMore + +> **\_100kBtcOrMore**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3110](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3110) + +*** + +### \_100kSatsTo1mSats + +> **\_100kSatsTo1mSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3111](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3111) + +*** + +### \_100satsTo1kSats + +> **\_100satsTo1kSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3112](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3112) + +*** + +### \_10btcTo100btc + +> **\_10btcTo100btc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3113](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3113) + +*** + +### \_10kBtcTo100kBtc + +> **\_10kBtcTo100kBtc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3114](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3114) + +*** + +### \_10kSatsTo100kSats + +> **\_10kSatsTo100kSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3115](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3115) + +*** + +### \_10mSatsTo1btc + +> **\_10mSatsTo1btc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3116](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3116) + +*** + +### \_10satsTo100sats + +> **\_10satsTo100sats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3117](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3117) + +*** + +### \_1btcTo10btc + +> **\_1btcTo10btc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3118](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3118) + +*** + +### \_1kBtcTo10kBtc + +> **\_1kBtcTo10kBtc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3119](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3119) + +*** + +### \_1kSatsTo10kSats + +> **\_1kSatsTo10kSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3120](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3120) + +*** + +### \_1mSatsTo10mSats + +> **\_1mSatsTo10mSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3121](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3121) + +*** + +### \_1satTo10sats + +> **\_1satTo10sats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3122](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3122) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_GeAmount.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_GeAmount.md new file mode 100644 index 000000000..b5c13a8a4 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_GeAmount.md @@ -0,0 +1,113 @@ +[**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:3126](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3126) + +## Properties + +### \_100btc + +> **\_100btc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3127](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3127) + +*** + +### \_100kSats + +> **\_100kSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3128](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3128) + +*** + +### \_100sats + +> **\_100sats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3129](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3129) + +*** + +### \_10btc + +> **\_10btc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3130](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3130) + +*** + +### \_10kBtc + +> **\_10kBtc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3131](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3131) + +*** + +### \_10kSats + +> **\_10kSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3132](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3132) + +*** + +### \_10mSats + +> **\_10mSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3133](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3133) + +*** + +### \_10sats + +> **\_10sats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3134](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3134) + +*** + +### \_1btc + +> **\_1btc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3135](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3135) + +*** + +### \_1kBtc + +> **\_1kBtc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3136](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3136) + +*** + +### \_1kSats + +> **\_1kSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3137](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3137) + +*** + +### \_1mSats + +> **\_1mSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3138](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3138) + +*** + +### \_1sat + +> **\_1sat**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3139](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3139) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_LtAmount.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_LtAmount.md new file mode 100644 index 000000000..ba257ae77 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressCohorts_LtAmount.md @@ -0,0 +1,113 @@ +[**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:3143](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3143) + +## Properties + +### \_100btc + +> **\_100btc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3144](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3144) + +*** + +### \_100kBtc + +> **\_100kBtc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3145](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3145) + +*** + +### \_100kSats + +> **\_100kSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3146](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3146) + +*** + +### \_100sats + +> **\_100sats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3147](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3147) + +*** + +### \_10btc + +> **\_10btc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3148](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3148) + +*** + +### \_10kBtc + +> **\_10kBtc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3149](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3149) + +*** + +### \_10kSats + +> **\_10kSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3150](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3150) + +*** + +### \_10mSats + +> **\_10mSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3151](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3151) + +*** + +### \_10sats + +> **\_10sats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3152](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3152) + +*** + +### \_1btc + +> **\_1btc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3153](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3153) + +*** + +### \_1kBtc + +> **\_1kBtc**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3154](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3154) + +*** + +### \_1kSats + +> **\_1kSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3155](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3155) + +*** + +### \_1mSats + +> **\_1mSats**: [`_0satsPattern`](0satsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3156](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3156) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressesData.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressesData.md new file mode 100644 index 000000000..4ec4fe81f --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AddressesData.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Distribution\_AddressesData + +# Interface: MetricsTree\_Distribution\_AddressesData + +Defined in: [Developer/brk/modules/brk-client/index.js:3160](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3160) + +## Properties + +### empty + +> **empty**: [`MetricPattern32`](../type-aliases/MetricPattern32.md)\<[`EmptyAddressData`](EmptyAddressData.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3161](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3161) + +*** + +### loaded + +> **loaded**: [`MetricPattern31`](../type-aliases/MetricPattern31.md)\<[`LoadedAddressData`](LoadedAddressData.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3162](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3162) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AnyAddressIndexes.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AnyAddressIndexes.md new file mode 100644 index 000000000..7973148b5 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_AnyAddressIndexes.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Distribution\_AnyAddressIndexes + +# Interface: MetricsTree\_Distribution\_AnyAddressIndexes + +Defined in: [Developer/brk/modules/brk-client/index.js:3166](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3166) + +## Properties + +### p2a + +> **p2a**: [`MetricPattern16`](../type-aliases/MetricPattern16.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3167](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3167) + +*** + +### p2pk33 + +> **p2pk33**: [`MetricPattern18`](../type-aliases/MetricPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3168](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3168) + +*** + +### p2pk65 + +> **p2pk65**: [`MetricPattern19`](../type-aliases/MetricPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3169](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3169) + +*** + +### p2pkh + +> **p2pkh**: [`MetricPattern20`](../type-aliases/MetricPattern20.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3170](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3170) + +*** + +### p2sh + +> **p2sh**: [`MetricPattern21`](../type-aliases/MetricPattern21.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3171](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3171) + +*** + +### p2tr + +> **p2tr**: [`MetricPattern22`](../type-aliases/MetricPattern22.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3172](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3172) + +*** + +### p2wpkh + +> **p2wpkh**: [`MetricPattern23`](../type-aliases/MetricPattern23.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3173](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3173) + +*** + +### p2wsh + +> **p2wsh**: [`MetricPattern24`](../type-aliases/MetricPattern24.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3174](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3174) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts.md new file mode 100644 index 000000000..af5ead53d --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts.md @@ -0,0 +1,97 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts + +# Interface: MetricsTree\_Distribution\_UtxoCohorts + +Defined in: [Developer/brk/modules/brk-client/index.js:3178](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3178) + +## Properties + +### ageRange + +> **ageRange**: [`MetricsTree_Distribution_UtxoCohorts_AgeRange`](MetricsTree_Distribution_UtxoCohorts_AgeRange.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3179](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3179) + +*** + +### all + +> **all**: [`MetricsTree_Distribution_UtxoCohorts_All`](MetricsTree_Distribution_UtxoCohorts_All.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3180](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3180) + +*** + +### amountRange + +> **amountRange**: [`MetricsTree_Distribution_UtxoCohorts_AmountRange`](MetricsTree_Distribution_UtxoCohorts_AmountRange.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3181](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3181) + +*** + +### epoch + +> **epoch**: [`MetricsTree_Distribution_UtxoCohorts_Epoch`](MetricsTree_Distribution_UtxoCohorts_Epoch.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3182](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3182) + +*** + +### geAmount + +> **geAmount**: [`MetricsTree_Distribution_UtxoCohorts_GeAmount`](MetricsTree_Distribution_UtxoCohorts_GeAmount.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3183](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3183) + +*** + +### ltAmount + +> **ltAmount**: [`MetricsTree_Distribution_UtxoCohorts_LtAmount`](MetricsTree_Distribution_UtxoCohorts_LtAmount.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3184](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3184) + +*** + +### maxAge + +> **maxAge**: [`MetricsTree_Distribution_UtxoCohorts_MaxAge`](MetricsTree_Distribution_UtxoCohorts_MaxAge.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3185](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3185) + +*** + +### minAge + +> **minAge**: [`MetricsTree_Distribution_UtxoCohorts_MinAge`](MetricsTree_Distribution_UtxoCohorts_MinAge.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3186](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3186) + +*** + +### term + +> **term**: [`MetricsTree_Distribution_UtxoCohorts_Term`](MetricsTree_Distribution_UtxoCohorts_Term.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3187](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3187) + +*** + +### type + +> **type**: [`MetricsTree_Distribution_UtxoCohorts_Type`](MetricsTree_Distribution_UtxoCohorts_Type.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3188](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3188) + +*** + +### year + +> **year**: [`MetricsTree_Distribution_UtxoCohorts_Year`](MetricsTree_Distribution_UtxoCohorts_Year.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3189](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3189) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AgeRange.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AgeRange.md new file mode 100644 index 000000000..d936b6e48 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AgeRange.md @@ -0,0 +1,177 @@ +[**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:3193](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3193) + +## Properties + +### \_10yTo12y + +> **\_10yTo12y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3194](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3194) + +*** + +### \_12yTo15y + +> **\_12yTo15y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3195](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3195) + +*** + +### \_1dTo1w + +> **\_1dTo1w**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3196](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3196) + +*** + +### \_1hTo1d + +> **\_1hTo1d**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3197](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3197) + +*** + +### \_1mTo2m + +> **\_1mTo2m**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3198](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3198) + +*** + +### \_1wTo1m + +> **\_1wTo1m**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3199](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3199) + +*** + +### \_1yTo2y + +> **\_1yTo2y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3200](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3200) + +*** + +### \_2mTo3m + +> **\_2mTo3m**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3201](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3201) + +*** + +### \_2yTo3y + +> **\_2yTo3y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3202](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3202) + +*** + +### \_3mTo4m + +> **\_3mTo4m**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3203](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3203) + +*** + +### \_3yTo4y + +> **\_3yTo4y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3204](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3204) + +*** + +### \_4mTo5m + +> **\_4mTo5m**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3205](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3205) + +*** + +### \_4yTo5y + +> **\_4yTo5y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3206](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3206) + +*** + +### \_5mTo6m + +> **\_5mTo6m**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3207](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3207) + +*** + +### \_5yTo6y + +> **\_5yTo6y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3208](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3208) + +*** + +### \_6mTo1y + +> **\_6mTo1y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3209](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3209) + +*** + +### \_6yTo7y + +> **\_6yTo7y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3210](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3210) + +*** + +### \_7yTo8y + +> **\_7yTo8y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3211](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3211) + +*** + +### \_8yTo10y + +> **\_8yTo10y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3212](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3212) + +*** + +### from15y + +> **from15y**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3213](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3213) + +*** + +### upTo1h + +> **upTo1h**: [`_10yTo12yPattern`](10yTo12yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3214](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3214) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All.md new file mode 100644 index 000000000..e974da67b --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All.md @@ -0,0 +1,65 @@ +[**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:3218](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3218) + +## Properties + +### activity + +> **activity**: [`ActivityPattern2`](ActivityPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3219](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3219) + +*** + +### costBasis + +> **costBasis**: [`MetricsTree_Distribution_UtxoCohorts_All_CostBasis`](MetricsTree_Distribution_UtxoCohorts_All_CostBasis.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3220](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3220) + +*** + +### outputs + +> **outputs**: [`OutputsPattern`](OutputsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3221](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3221) + +*** + +### realized + +> **realized**: [`RealizedPattern3`](RealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3222](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3222) + +*** + +### relative + +> **relative**: [`MetricsTree_Distribution_UtxoCohorts_All_Relative`](MetricsTree_Distribution_UtxoCohorts_All_Relative.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3223](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3223) + +*** + +### supply + +> **supply**: [`SupplyPattern2`](SupplyPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3224](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3224) + +*** + +### unrealized + +> **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3225](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3225) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All_CostBasis.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All_CostBasis.md new file mode 100644 index 000000000..9bff91490 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All_CostBasis.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Distribution\_UtxoCohorts\_All\_CostBasis + +# Interface: MetricsTree\_Distribution\_UtxoCohorts\_All\_CostBasis + +Defined in: [Developer/brk/modules/brk-client/index.js:3229](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3229) + +## Properties + +### max + +> **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3230](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3230) + +*** + +### min + +> **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3231](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3231) + +*** + +### percentiles + +> **percentiles**: [`PercentilesPattern`](PercentilesPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3232](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3232) 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 new file mode 100644 index 000000000..e41bcb01e --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_All_Relative.md @@ -0,0 +1,57 @@ +[**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:3236](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3236) + +## Properties + +### negUnrealizedLossRelToOwnTotalUnrealizedPnl + +> **negUnrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3237](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3237) + +*** + +### netUnrealizedPnlRelToOwnTotalUnrealizedPnl + +> **netUnrealizedPnlRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3238](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3238) + +*** + +### supplyInLossRelToOwnSupply + +> **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3239](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3239) + +*** + +### supplyInProfitRelToOwnSupply + +> **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3240](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3240) + +*** + +### unrealizedLossRelToOwnTotalUnrealizedPnl + +> **unrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3241](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3241) + +*** + +### unrealizedProfitRelToOwnTotalUnrealizedPnl + +> **unrealizedProfitRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3242](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3242) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AmountRange.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AmountRange.md new file mode 100644 index 000000000..a6e4321fe --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_AmountRange.md @@ -0,0 +1,129 @@ +[**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:3246](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3246) + +## Properties + +### \_0sats + +> **\_0sats**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3247](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3247) + +*** + +### \_100btcTo1kBtc + +> **\_100btcTo1kBtc**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3248](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3248) + +*** + +### \_100kBtcOrMore + +> **\_100kBtcOrMore**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3249](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3249) + +*** + +### \_100kSatsTo1mSats + +> **\_100kSatsTo1mSats**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3250](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3250) + +*** + +### \_100satsTo1kSats + +> **\_100satsTo1kSats**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3251](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3251) + +*** + +### \_10btcTo100btc + +> **\_10btcTo100btc**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3252](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3252) + +*** + +### \_10kBtcTo100kBtc + +> **\_10kBtcTo100kBtc**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3253](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3253) + +*** + +### \_10kSatsTo100kSats + +> **\_10kSatsTo100kSats**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3254](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3254) + +*** + +### \_10mSatsTo1btc + +> **\_10mSatsTo1btc**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3255](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3255) + +*** + +### \_10satsTo100sats + +> **\_10satsTo100sats**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3256](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3256) + +*** + +### \_1btcTo10btc + +> **\_1btcTo10btc**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3257](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3257) + +*** + +### \_1kBtcTo10kBtc + +> **\_1kBtcTo10kBtc**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3258](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3258) + +*** + +### \_1kSatsTo10kSats + +> **\_1kSatsTo10kSats**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3259](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3259) + +*** + +### \_1mSatsTo10mSats + +> **\_1mSatsTo10mSats**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3260](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3260) + +*** + +### \_1satTo10sats + +> **\_1satTo10sats**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3261](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3261) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Epoch.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Epoch.md new file mode 100644 index 000000000..5a21c0d4a --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Epoch.md @@ -0,0 +1,49 @@ +[**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:3265](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3265) + +## Properties + +### \_0 + +> **\_0**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3266](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3266) + +*** + +### \_1 + +> **\_1**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3267](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3267) + +*** + +### \_2 + +> **\_2**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3268](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3268) + +*** + +### \_3 + +> **\_3**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3269](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3269) + +*** + +### \_4 + +> **\_4**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3270](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3270) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_GeAmount.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_GeAmount.md new file mode 100644 index 000000000..fcdf3c260 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_GeAmount.md @@ -0,0 +1,113 @@ +[**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:3274](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3274) + +## Properties + +### \_100btc + +> **\_100btc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3275](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3275) + +*** + +### \_100kSats + +> **\_100kSats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3276](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3276) + +*** + +### \_100sats + +> **\_100sats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3277](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3277) + +*** + +### \_10btc + +> **\_10btc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3278](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3278) + +*** + +### \_10kBtc + +> **\_10kBtc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3279](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3279) + +*** + +### \_10kSats + +> **\_10kSats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3280](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3280) + +*** + +### \_10mSats + +> **\_10mSats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3281](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3281) + +*** + +### \_10sats + +> **\_10sats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3282](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3282) + +*** + +### \_1btc + +> **\_1btc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3283](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3283) + +*** + +### \_1kBtc + +> **\_1kBtc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3284](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3284) + +*** + +### \_1kSats + +> **\_1kSats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3285](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3285) + +*** + +### \_1mSats + +> **\_1mSats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3286](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3286) + +*** + +### \_1sat + +> **\_1sat**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3287](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3287) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_LtAmount.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_LtAmount.md new file mode 100644 index 000000000..0f21d3439 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_LtAmount.md @@ -0,0 +1,113 @@ +[**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:3291](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3291) + +## Properties + +### \_100btc + +> **\_100btc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3292](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3292) + +*** + +### \_100kBtc + +> **\_100kBtc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3293](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3293) + +*** + +### \_100kSats + +> **\_100kSats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3294](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3294) + +*** + +### \_100sats + +> **\_100sats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3295](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3295) + +*** + +### \_10btc + +> **\_10btc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3296](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3296) + +*** + +### \_10kBtc + +> **\_10kBtc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3297](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3297) + +*** + +### \_10kSats + +> **\_10kSats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3298](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3298) + +*** + +### \_10mSats + +> **\_10mSats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3299](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3299) + +*** + +### \_10sats + +> **\_10sats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3300](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3300) + +*** + +### \_1btc + +> **\_1btc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3301](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3301) + +*** + +### \_1kBtc + +> **\_1kBtc**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3302](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3302) + +*** + +### \_1kSats + +> **\_1kSats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3303](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3303) + +*** + +### \_1mSats + +> **\_1mSats**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3304](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3304) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MaxAge.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MaxAge.md new file mode 100644 index 000000000..3d16d844d --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MaxAge.md @@ -0,0 +1,153 @@ +[**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:3308](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3308) + +## Properties + +### \_10y + +> **\_10y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3309](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3309) + +*** + +### \_12y + +> **\_12y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3310](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3310) + +*** + +### \_15y + +> **\_15y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3311](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3311) + +*** + +### \_1m + +> **\_1m**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3312](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3312) + +*** + +### \_1w + +> **\_1w**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3313](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3313) + +*** + +### \_1y + +> **\_1y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3314](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3314) + +*** + +### \_2m + +> **\_2m**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3315](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3315) + +*** + +### \_2y + +> **\_2y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3316](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3316) + +*** + +### \_3m + +> **\_3m**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3317](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3317) + +*** + +### \_3y + +> **\_3y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3318](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3318) + +*** + +### \_4m + +> **\_4m**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3319](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3319) + +*** + +### \_4y + +> **\_4y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3320](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3320) + +*** + +### \_5m + +> **\_5m**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3321](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3321) + +*** + +### \_5y + +> **\_5y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3322](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3322) + +*** + +### \_6m + +> **\_6m**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3323](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3323) + +*** + +### \_6y + +> **\_6y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3324](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3324) + +*** + +### \_7y + +> **\_7y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3325](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3325) + +*** + +### \_8y + +> **\_8y**: [`_10yPattern`](10yPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3326](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3326) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MinAge.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MinAge.md new file mode 100644 index 000000000..e3e0a92b8 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_MinAge.md @@ -0,0 +1,153 @@ +[**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:3330](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3330) + +## Properties + +### \_10y + +> **\_10y**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3331](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3331) + +*** + +### \_12y + +> **\_12y**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3332](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3332) + +*** + +### \_1d + +> **\_1d**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3333](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3333) + +*** + +### \_1m + +> **\_1m**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3334](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3334) + +*** + +### \_1w + +> **\_1w**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3335](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3335) + +*** + +### \_1y + +> **\_1y**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3336](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3336) + +*** + +### \_2m + +> **\_2m**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3337](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3337) + +*** + +### \_2y + +> **\_2y**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3338](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3338) + +*** + +### \_3m + +> **\_3m**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3339](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3339) + +*** + +### \_3y + +> **\_3y**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3340](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3340) + +*** + +### \_4m + +> **\_4m**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3341](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3341) + +*** + +### \_4y + +> **\_4y**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3342](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3342) + +*** + +### \_5m + +> **\_5m**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3343](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3343) + +*** + +### \_5y + +> **\_5y**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3344](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3344) + +*** + +### \_6m + +> **\_6m**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3345](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3345) + +*** + +### \_6y + +> **\_6y**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3346](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3346) + +*** + +### \_7y + +> **\_7y**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3347](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3347) + +*** + +### \_8y + +> **\_8y**: [`_100btcPattern`](100btcPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3348](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3348) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term.md new file mode 100644 index 000000000..aa5912104 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term.md @@ -0,0 +1,25 @@ +[**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:3352](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3352) + +## Properties + +### long + +> **long**: [`MetricsTree_Distribution_UtxoCohorts_Term_Long`](MetricsTree_Distribution_UtxoCohorts_Term_Long.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3353](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3353) + +*** + +### short + +> **short**: [`MetricsTree_Distribution_UtxoCohorts_Term_Short`](MetricsTree_Distribution_UtxoCohorts_Term_Short.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3354](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3354) 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 new file mode 100644 index 000000000..65778a687 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term_Long.md @@ -0,0 +1,65 @@ +[**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:3358](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3358) + +## Properties + +### activity + +> **activity**: [`ActivityPattern2`](ActivityPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3359](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3359) + +*** + +### costBasis + +> **costBasis**: [`CostBasisPattern2`](CostBasisPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3360](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3360) + +*** + +### outputs + +> **outputs**: [`OutputsPattern`](OutputsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3361](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3361) + +*** + +### realized + +> **realized**: [`RealizedPattern2`](RealizedPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3362](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3362) + +*** + +### relative + +> **relative**: [`RelativePattern5`](RelativePattern5.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3363](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3363) + +*** + +### supply + +> **supply**: [`SupplyPattern2`](SupplyPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3364](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3364) + +*** + +### unrealized + +> **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3365](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3365) 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 new file mode 100644 index 000000000..6e464ef45 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Term_Short.md @@ -0,0 +1,65 @@ +[**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:3369](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3369) + +## Properties + +### activity + +> **activity**: [`ActivityPattern2`](ActivityPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3370](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3370) + +*** + +### costBasis + +> **costBasis**: [`CostBasisPattern2`](CostBasisPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3371](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3371) + +*** + +### outputs + +> **outputs**: [`OutputsPattern`](OutputsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3372](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3372) + +*** + +### realized + +> **realized**: [`RealizedPattern3`](RealizedPattern3.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3373](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3373) + +*** + +### relative + +> **relative**: [`RelativePattern5`](RelativePattern5.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3374](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3374) + +*** + +### supply + +> **supply**: [`SupplyPattern2`](SupplyPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3375](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3375) + +*** + +### unrealized + +> **unrealized**: [`UnrealizedPattern`](UnrealizedPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3376](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3376) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Type.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Type.md new file mode 100644 index 000000000..4b63fd48a --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Type.md @@ -0,0 +1,97 @@ +[**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:3380](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3380) + +## Properties + +### empty + +> **empty**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3381](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3381) + +*** + +### p2a + +> **p2a**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3382](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3382) + +*** + +### p2ms + +> **p2ms**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3383](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3383) + +*** + +### p2pk33 + +> **p2pk33**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3384](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3384) + +*** + +### p2pk65 + +> **p2pk65**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3385](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3385) + +*** + +### p2pkh + +> **p2pkh**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3386](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3386) + +*** + +### p2sh + +> **p2sh**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3387](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3387) + +*** + +### p2tr + +> **p2tr**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3388](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3388) + +*** + +### p2wpkh + +> **p2wpkh**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3389](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3389) + +*** + +### p2wsh + +> **p2wsh**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3390](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3390) + +*** + +### unknown + +> **unknown**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3391](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3391) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Year.md b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Year.md new file mode 100644 index 000000000..178f5afbd --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Distribution_UtxoCohorts_Year.md @@ -0,0 +1,153 @@ +[**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:3395](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3395) + +## Properties + +### \_2009 + +> **\_2009**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3396](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3396) + +*** + +### \_2010 + +> **\_2010**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3397](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3397) + +*** + +### \_2011 + +> **\_2011**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3398](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3398) + +*** + +### \_2012 + +> **\_2012**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3399](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3399) + +*** + +### \_2013 + +> **\_2013**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3400](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3400) + +*** + +### \_2014 + +> **\_2014**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3401](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3401) + +*** + +### \_2015 + +> **\_2015**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3402](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3402) + +*** + +### \_2016 + +> **\_2016**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3403](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3403) + +*** + +### \_2017 + +> **\_2017**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3404](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3404) + +*** + +### \_2018 + +> **\_2018**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3405](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3405) + +*** + +### \_2019 + +> **\_2019**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3406](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3406) + +*** + +### \_2020 + +> **\_2020**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3407](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3407) + +*** + +### \_2021 + +> **\_2021**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3408](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3408) + +*** + +### \_2022 + +> **\_2022**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3409](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3409) + +*** + +### \_2023 + +> **\_2023**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3410](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3410) + +*** + +### \_2024 + +> **\_2024**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3411](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3411) + +*** + +### \_2025 + +> **\_2025**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3412](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3412) + +*** + +### \_2026 + +> **\_2026**: [`_0satsPattern2`](0satsPattern2.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3413](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3413) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes.md new file mode 100644 index 000000000..fd62329f3 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes.md @@ -0,0 +1,121 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes + +# Interface: MetricsTree\_Indexes + +Defined in: [Developer/brk/modules/brk-client/index.js:3417](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3417) + +## Properties + +### address + +> **address**: [`MetricsTree_Indexes_Address`](MetricsTree_Indexes_Address.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3418](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3418) + +*** + +### dateindex + +> **dateindex**: [`MetricsTree_Indexes_Dateindex`](MetricsTree_Indexes_Dateindex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3419](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3419) + +*** + +### decadeindex + +> **decadeindex**: [`MetricsTree_Indexes_Decadeindex`](MetricsTree_Indexes_Decadeindex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3420](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3420) + +*** + +### difficultyepoch + +> **difficultyepoch**: [`MetricsTree_Indexes_Difficultyepoch`](MetricsTree_Indexes_Difficultyepoch.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3421](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3421) + +*** + +### halvingepoch + +> **halvingepoch**: [`MetricsTree_Indexes_Halvingepoch`](MetricsTree_Indexes_Halvingepoch.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3422](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3422) + +*** + +### height + +> **height**: [`MetricsTree_Indexes_Height`](MetricsTree_Indexes_Height.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3423](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3423) + +*** + +### monthindex + +> **monthindex**: [`MetricsTree_Indexes_Monthindex`](MetricsTree_Indexes_Monthindex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3424](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3424) + +*** + +### quarterindex + +> **quarterindex**: [`MetricsTree_Indexes_Quarterindex`](MetricsTree_Indexes_Quarterindex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3425](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3425) + +*** + +### semesterindex + +> **semesterindex**: [`MetricsTree_Indexes_Semesterindex`](MetricsTree_Indexes_Semesterindex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3426](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3426) + +*** + +### txindex + +> **txindex**: [`MetricsTree_Indexes_Txindex`](MetricsTree_Indexes_Txindex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3427](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3427) + +*** + +### txinindex + +> **txinindex**: [`MetricsTree_Indexes_Txinindex`](MetricsTree_Indexes_Txinindex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3428](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3428) + +*** + +### txoutindex + +> **txoutindex**: [`MetricsTree_Indexes_Txoutindex`](MetricsTree_Indexes_Txoutindex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3429](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3429) + +*** + +### weekindex + +> **weekindex**: [`MetricsTree_Indexes_Weekindex`](MetricsTree_Indexes_Weekindex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3430](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3430) + +*** + +### yearindex + +> **yearindex**: [`MetricsTree_Indexes_Yearindex`](MetricsTree_Indexes_Yearindex.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3431](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3431) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address.md new file mode 100644 index 000000000..7dce515e5 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address.md @@ -0,0 +1,105 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Address + +# Interface: MetricsTree\_Indexes\_Address + +Defined in: [Developer/brk/modules/brk-client/index.js:3435](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3435) + +## Properties + +### empty + +> **empty**: [`MetricsTree_Indexes_Address_Empty`](MetricsTree_Indexes_Address_Empty.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3436](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3436) + +*** + +### opreturn + +> **opreturn**: [`MetricsTree_Indexes_Address_Opreturn`](MetricsTree_Indexes_Address_Opreturn.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3437](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3437) + +*** + +### p2a + +> **p2a**: [`MetricsTree_Indexes_Address_P2a`](MetricsTree_Indexes_Address_P2a.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3438](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3438) + +*** + +### p2ms + +> **p2ms**: [`MetricsTree_Indexes_Address_P2ms`](MetricsTree_Indexes_Address_P2ms.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3439](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3439) + +*** + +### p2pk33 + +> **p2pk33**: [`MetricsTree_Indexes_Address_P2pk33`](MetricsTree_Indexes_Address_P2pk33.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3440](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3440) + +*** + +### p2pk65 + +> **p2pk65**: [`MetricsTree_Indexes_Address_P2pk65`](MetricsTree_Indexes_Address_P2pk65.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3441](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3441) + +*** + +### p2pkh + +> **p2pkh**: [`MetricsTree_Indexes_Address_P2pkh`](MetricsTree_Indexes_Address_P2pkh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3442](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3442) + +*** + +### p2sh + +> **p2sh**: [`MetricsTree_Indexes_Address_P2sh`](MetricsTree_Indexes_Address_P2sh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3443](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3443) + +*** + +### p2tr + +> **p2tr**: [`MetricsTree_Indexes_Address_P2tr`](MetricsTree_Indexes_Address_P2tr.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3444](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3444) + +*** + +### p2wpkh + +> **p2wpkh**: [`MetricsTree_Indexes_Address_P2wpkh`](MetricsTree_Indexes_Address_P2wpkh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3445](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3445) + +*** + +### p2wsh + +> **p2wsh**: [`MetricsTree_Indexes_Address_P2wsh`](MetricsTree_Indexes_Address_P2wsh.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3446](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3446) + +*** + +### unknown + +> **unknown**: [`MetricsTree_Indexes_Address_Unknown`](MetricsTree_Indexes_Address_Unknown.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3447](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3447) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Empty.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Empty.md new file mode 100644 index 000000000..bb8c4a798 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Empty.md @@ -0,0 +1,17 @@ +[**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:3451](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3451) + +## Properties + +### identity + +> **identity**: [`MetricPattern9`](../type-aliases/MetricPattern9.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3452](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3452) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Opreturn.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Opreturn.md new file mode 100644 index 000000000..2d1b5b16f --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Opreturn.md @@ -0,0 +1,17 @@ +[**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:3456](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3456) + +## Properties + +### identity + +> **identity**: [`MetricPattern14`](../type-aliases/MetricPattern14.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3457](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3457) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2a.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2a.md new file mode 100644 index 000000000..3d25a7eaf --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2a.md @@ -0,0 +1,17 @@ +[**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:3461](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3461) + +## Properties + +### identity + +> **identity**: [`MetricPattern16`](../type-aliases/MetricPattern16.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3462](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3462) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2ms.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2ms.md new file mode 100644 index 000000000..56b1b312b --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2ms.md @@ -0,0 +1,17 @@ +[**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:3466](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3466) + +## Properties + +### identity + +> **identity**: [`MetricPattern17`](../type-aliases/MetricPattern17.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3467](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3467) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk33.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk33.md new file mode 100644 index 000000000..91ae8df87 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk33.md @@ -0,0 +1,17 @@ +[**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:3471](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3471) + +## Properties + +### identity + +> **identity**: [`MetricPattern18`](../type-aliases/MetricPattern18.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3472](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3472) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk65.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk65.md new file mode 100644 index 000000000..985bd2d44 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pk65.md @@ -0,0 +1,17 @@ +[**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:3476](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3476) + +## Properties + +### identity + +> **identity**: [`MetricPattern19`](../type-aliases/MetricPattern19.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3477](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3477) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pkh.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pkh.md new file mode 100644 index 000000000..bfc62fc2b --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2pkh.md @@ -0,0 +1,17 @@ +[**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:3481](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3481) + +## Properties + +### identity + +> **identity**: [`MetricPattern20`](../type-aliases/MetricPattern20.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3482](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3482) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2sh.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2sh.md new file mode 100644 index 000000000..93413993b --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2sh.md @@ -0,0 +1,17 @@ +[**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:3486](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3486) + +## Properties + +### identity + +> **identity**: [`MetricPattern21`](../type-aliases/MetricPattern21.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3487](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3487) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2tr.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2tr.md new file mode 100644 index 000000000..deb62499b --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2tr.md @@ -0,0 +1,17 @@ +[**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:3491](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3491) + +## Properties + +### identity + +> **identity**: [`MetricPattern22`](../type-aliases/MetricPattern22.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3492](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3492) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wpkh.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wpkh.md new file mode 100644 index 000000000..f428f3cc4 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wpkh.md @@ -0,0 +1,17 @@ +[**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:3496](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3496) + +## Properties + +### identity + +> **identity**: [`MetricPattern23`](../type-aliases/MetricPattern23.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3497](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3497) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wsh.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wsh.md new file mode 100644 index 000000000..e715e4be5 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_P2wsh.md @@ -0,0 +1,17 @@ +[**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:3501](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3501) + +## Properties + +### identity + +> **identity**: [`MetricPattern24`](../type-aliases/MetricPattern24.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3502](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3502) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Unknown.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Unknown.md new file mode 100644 index 000000000..167176c15 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Address_Unknown.md @@ -0,0 +1,17 @@ +[**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:3506](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3506) + +## Properties + +### identity + +> **identity**: [`MetricPattern28`](../type-aliases/MetricPattern28.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3507](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3507) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Dateindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Dateindex.md new file mode 100644 index 000000000..0ece2a059 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Dateindex.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Dateindex + +# Interface: MetricsTree\_Indexes\_Dateindex + +Defined in: [Developer/brk/modules/brk-client/index.js:3511](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3511) + +## Properties + +### date + +> **date**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3512](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3512) + +*** + +### firstHeight + +> **firstHeight**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3513](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3513) + +*** + +### heightCount + +> **heightCount**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3514](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3514) + +*** + +### identity + +> **identity**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3515](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3515) + +*** + +### monthindex + +> **monthindex**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3516](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3516) + +*** + +### weekindex + +> **weekindex**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3517](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3517) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Decadeindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Decadeindex.md new file mode 100644 index 000000000..4e30b9599 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Decadeindex.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Decadeindex + +# Interface: MetricsTree\_Indexes\_Decadeindex + +Defined in: [Developer/brk/modules/brk-client/index.js:3521](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3521) + +## Properties + +### date + +> **date**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3522](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3522) + +*** + +### firstYearindex + +> **firstYearindex**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3523](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3523) + +*** + +### identity + +> **identity**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3524](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3524) + +*** + +### yearindexCount + +> **yearindexCount**: [`MetricPattern7`](../type-aliases/MetricPattern7.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3525](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3525) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Difficultyepoch.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Difficultyepoch.md new file mode 100644 index 000000000..581663570 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Difficultyepoch.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Difficultyepoch + +# Interface: MetricsTree\_Indexes\_Difficultyepoch + +Defined in: [Developer/brk/modules/brk-client/index.js:3529](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3529) + +## Properties + +### firstHeight + +> **firstHeight**: [`MetricPattern8`](../type-aliases/MetricPattern8.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3530](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3530) + +*** + +### heightCount + +> **heightCount**: [`MetricPattern8`](../type-aliases/MetricPattern8.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3531](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3531) + +*** + +### identity + +> **identity**: [`MetricPattern8`](../type-aliases/MetricPattern8.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3532](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3532) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Halvingepoch.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Halvingepoch.md new file mode 100644 index 000000000..b6441b668 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Halvingepoch.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Halvingepoch + +# Interface: MetricsTree\_Indexes\_Halvingepoch + +Defined in: [Developer/brk/modules/brk-client/index.js:3536](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3536) + +## Properties + +### firstHeight + +> **firstHeight**: [`MetricPattern10`](../type-aliases/MetricPattern10.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3537](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3537) + +*** + +### identity + +> **identity**: [`MetricPattern10`](../type-aliases/MetricPattern10.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3538](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3538) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Height.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Height.md new file mode 100644 index 000000000..d957edd2e --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Height.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Height + +# Interface: MetricsTree\_Indexes\_Height + +Defined in: [Developer/brk/modules/brk-client/index.js:3542](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3542) + +## Properties + +### dateindex + +> **dateindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3543](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3543) + +*** + +### difficultyepoch + +> **difficultyepoch**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3544](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3544) + +*** + +### halvingepoch + +> **halvingepoch**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3545](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3545) + +*** + +### identity + +> **identity**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3546](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3546) + +*** + +### txindexCount + +> **txindexCount**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3547](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3547) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Monthindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Monthindex.md new file mode 100644 index 000000000..bbdc3aeae --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Monthindex.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Monthindex + +# Interface: MetricsTree\_Indexes\_Monthindex + +Defined in: [Developer/brk/modules/brk-client/index.js:3551](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3551) + +## Properties + +### date + +> **date**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3552](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3552) + +*** + +### dateindexCount + +> **dateindexCount**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3553](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3553) + +*** + +### firstDateindex + +> **firstDateindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3554](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3554) + +*** + +### identity + +> **identity**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3555](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3555) + +*** + +### quarterindex + +> **quarterindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3556](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3556) + +*** + +### semesterindex + +> **semesterindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3557](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3557) + +*** + +### yearindex + +> **yearindex**: [`MetricPattern13`](../type-aliases/MetricPattern13.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3558](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3558) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Quarterindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Quarterindex.md new file mode 100644 index 000000000..3236979be --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Quarterindex.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Quarterindex + +# Interface: MetricsTree\_Indexes\_Quarterindex + +Defined in: [Developer/brk/modules/brk-client/index.js:3562](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3562) + +## Properties + +### date + +> **date**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3563](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3563) + +*** + +### firstMonthindex + +> **firstMonthindex**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3564](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3564) + +*** + +### identity + +> **identity**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3565](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3565) + +*** + +### monthindexCount + +> **monthindexCount**: [`MetricPattern25`](../type-aliases/MetricPattern25.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3566](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3566) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Semesterindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Semesterindex.md new file mode 100644 index 000000000..580849291 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Semesterindex.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Semesterindex + +# Interface: MetricsTree\_Indexes\_Semesterindex + +Defined in: [Developer/brk/modules/brk-client/index.js:3570](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3570) + +## Properties + +### date + +> **date**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3571](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3571) + +*** + +### firstMonthindex + +> **firstMonthindex**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3572](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3572) + +*** + +### identity + +> **identity**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3573](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3573) + +*** + +### monthindexCount + +> **monthindexCount**: [`MetricPattern26`](../type-aliases/MetricPattern26.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3574](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3574) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txindex.md new file mode 100644 index 000000000..c385f4b51 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txindex.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Txindex + +# Interface: MetricsTree\_Indexes\_Txindex + +Defined in: [Developer/brk/modules/brk-client/index.js:3578](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3578) + +## Properties + +### identity + +> **identity**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3579](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3579) + +*** + +### inputCount + +> **inputCount**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3580](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3580) + +*** + +### outputCount + +> **outputCount**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3581](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3581) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txinindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txinindex.md new file mode 100644 index 000000000..a582c2a79 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txinindex.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Txinindex + +# Interface: MetricsTree\_Indexes\_Txinindex + +Defined in: [Developer/brk/modules/brk-client/index.js:3585](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3585) + +## Properties + +### identity + +> **identity**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3586](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3586) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txoutindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txoutindex.md new file mode 100644 index 000000000..0ad42fdad --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Txoutindex.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Txoutindex + +# Interface: MetricsTree\_Indexes\_Txoutindex + +Defined in: [Developer/brk/modules/brk-client/index.js:3590](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3590) + +## Properties + +### identity + +> **identity**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3591](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3591) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Weekindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Weekindex.md new file mode 100644 index 000000000..c0be9b968 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Weekindex.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Weekindex + +# Interface: MetricsTree\_Indexes\_Weekindex + +Defined in: [Developer/brk/modules/brk-client/index.js:3595](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3595) + +## Properties + +### date + +> **date**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3596](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3596) + +*** + +### dateindexCount + +> **dateindexCount**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3597](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3597) + +*** + +### firstDateindex + +> **firstDateindex**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3598](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3598) + +*** + +### identity + +> **identity**: [`MetricPattern29`](../type-aliases/MetricPattern29.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3599](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3599) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Yearindex.md b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Yearindex.md new file mode 100644 index 000000000..815ff6a5d --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Indexes_Yearindex.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Indexes\_Yearindex + +# Interface: MetricsTree\_Indexes\_Yearindex + +Defined in: [Developer/brk/modules/brk-client/index.js:3603](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3603) + +## Properties + +### date + +> **date**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3604](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3604) + +*** + +### decadeindex + +> **decadeindex**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3605](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3605) + +*** + +### firstMonthindex + +> **firstMonthindex**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3606](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3606) + +*** + +### identity + +> **identity**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3607](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3607) + +*** + +### monthindexCount + +> **monthindexCount**: [`MetricPattern30`](../type-aliases/MetricPattern30.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3608](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3608) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Inputs.md b/modules/brk-client/docs/interfaces/MetricsTree_Inputs.md new file mode 100644 index 000000000..8ce821986 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Inputs.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Inputs + +# Interface: MetricsTree\_Inputs + +Defined in: [Developer/brk/modules/brk-client/index.js:3612](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3612) + +## Properties + +### count + +> **count**: [`CountPattern2`](CountPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3613](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3613) + +*** + +### firstTxinindex + +> **firstTxinindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3614](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3614) + +*** + +### outpoint + +> **outpoint**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3615](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3615) + +*** + +### outputtype + +> **outputtype**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<[`OutputType`](../type-aliases/OutputType.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3616](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3616) + +*** + +### spent + +> **spent**: [`MetricsTree_Inputs_Spent`](MetricsTree_Inputs_Spent.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3617](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3617) + +*** + +### txindex + +> **txindex**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3618](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3618) + +*** + +### typeindex + +> **typeindex**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3619](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3619) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Inputs_Spent.md b/modules/brk-client/docs/interfaces/MetricsTree_Inputs_Spent.md new file mode 100644 index 000000000..ae9adcce6 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Inputs_Spent.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Inputs\_Spent + +# Interface: MetricsTree\_Inputs\_Spent + +Defined in: [Developer/brk/modules/brk-client/index.js:3623](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3623) + +## Properties + +### txoutindex + +> **txoutindex**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3624](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3624) + +*** + +### value + +> **value**: [`MetricPattern12`](../type-aliases/MetricPattern12.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3625](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3625) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market.md b/modules/brk-client/docs/interfaces/MetricsTree_Market.md new file mode 100644 index 000000000..5fa5d7b31 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Market + +# Interface: MetricsTree\_Market + +Defined in: [Developer/brk/modules/brk-client/index.js:3629](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3629) + +## Properties + +### ath + +> **ath**: [`MetricsTree_Market_Ath`](MetricsTree_Market_Ath.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3630](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3630) + +*** + +### dca + +> **dca**: [`MetricsTree_Market_Dca`](MetricsTree_Market_Dca.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3631](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3631) + +*** + +### indicators + +> **indicators**: [`MetricsTree_Market_Indicators`](MetricsTree_Market_Indicators.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3632](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3632) + +*** + +### lookback + +> **lookback**: [`LookbackPattern`](LookbackPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3633](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3633) + +*** + +### movingAverage + +> **movingAverage**: [`MetricsTree_Market_MovingAverage`](MetricsTree_Market_MovingAverage.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3634](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3634) + +*** + +### range + +> **range**: [`MetricsTree_Market_Range`](MetricsTree_Market_Range.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3635](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3635) + +*** + +### returns + +> **returns**: [`MetricsTree_Market_Returns`](MetricsTree_Market_Returns.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3636](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3636) + +*** + +### volatility + +> **volatility**: [`MetricsTree_Market_Volatility`](MetricsTree_Market_Volatility.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3637](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3637) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Ath.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Ath.md new file mode 100644 index 000000000..c13ffddfd --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market_Ath.md @@ -0,0 +1,57 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Market\_Ath + +# Interface: MetricsTree\_Market\_Ath + +Defined in: [Developer/brk/modules/brk-client/index.js:3641](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3641) + +## Properties + +### daysSincePriceAth + +> **daysSincePriceAth**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3642](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3642) + +*** + +### maxDaysBetweenPriceAths + +> **maxDaysBetweenPriceAths**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3643](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3643) + +*** + +### maxYearsBetweenPriceAths + +> **maxYearsBetweenPriceAths**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3644](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3644) + +*** + +### priceAth + +> **priceAth**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3645](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3645) + +*** + +### priceDrawdown + +> **priceDrawdown**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3646](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3646) + +*** + +### yearsSincePriceAth + +> **yearsSincePriceAth**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3647](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3647) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca.md new file mode 100644 index 000000000..c9e2acda5 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca.md @@ -0,0 +1,73 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Market\_Dca + +# Interface: MetricsTree\_Market\_Dca + +Defined in: [Developer/brk/modules/brk-client/index.js:3651](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3651) + +## Properties + +### classAveragePrice + +> **classAveragePrice**: [`MetricsTree_Market_Dca_ClassAveragePrice`](MetricsTree_Market_Dca_ClassAveragePrice.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3652](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3652) + +*** + +### classReturns + +> **classReturns**: [`ClassAveragePricePattern`](ClassAveragePricePattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3653](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3653) + +*** + +### classStack + +> **classStack**: [`MetricsTree_Market_Dca_ClassStack`](MetricsTree_Market_Dca_ClassStack.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3654](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3654) + +*** + +### periodAveragePrice + +> **periodAveragePrice**: [`PeriodAveragePricePattern`](PeriodAveragePricePattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3655](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3655) + +*** + +### periodCagr + +> **periodCagr**: [`PeriodCagrPattern`](PeriodCagrPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3656](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3656) + +*** + +### periodLumpSumStack + +> **periodLumpSumStack**: [`PeriodLumpSumStackPattern`](PeriodLumpSumStackPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3657](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3657) + +*** + +### periodReturns + +> **periodReturns**: [`PeriodAveragePricePattern`](PeriodAveragePricePattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3658](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3658) + +*** + +### periodStack + +> **periodStack**: [`PeriodLumpSumStackPattern`](PeriodLumpSumStackPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3659](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3659) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassAveragePrice.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassAveragePrice.md new file mode 100644 index 000000000..d2398e41e --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassAveragePrice.md @@ -0,0 +1,97 @@ +[**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:3663](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3663) + +## Properties + +### \_2015 + +> **\_2015**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3664](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3664) + +*** + +### \_2016 + +> **\_2016**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3665](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3665) + +*** + +### \_2017 + +> **\_2017**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3666](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3666) + +*** + +### \_2018 + +> **\_2018**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3667](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3667) + +*** + +### \_2019 + +> **\_2019**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3668](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3668) + +*** + +### \_2020 + +> **\_2020**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3669](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3669) + +*** + +### \_2021 + +> **\_2021**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3670](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3670) + +*** + +### \_2022 + +> **\_2022**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3671](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3671) + +*** + +### \_2023 + +> **\_2023**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3672](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3672) + +*** + +### \_2024 + +> **\_2024**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3673](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3673) + +*** + +### \_2025 + +> **\_2025**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3674](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3674) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassStack.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassStack.md new file mode 100644 index 000000000..c55af0592 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market_Dca_ClassStack.md @@ -0,0 +1,97 @@ +[**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:3678](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3678) + +## Properties + +### \_2015 + +> **\_2015**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3679](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3679) + +*** + +### \_2016 + +> **\_2016**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3680](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3680) + +*** + +### \_2017 + +> **\_2017**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3681](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3681) + +*** + +### \_2018 + +> **\_2018**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3682](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3682) + +*** + +### \_2019 + +> **\_2019**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3683](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3683) + +*** + +### \_2020 + +> **\_2020**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3684](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3684) + +*** + +### \_2021 + +> **\_2021**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3685](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3685) + +*** + +### \_2022 + +> **\_2022**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3686](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3686) + +*** + +### \_2023 + +> **\_2023**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3687](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3687) + +*** + +### \_2024 + +> **\_2024**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3688](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3688) + +*** + +### \_2025 + +> **\_2025**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3689](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3689) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Indicators.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Indicators.md new file mode 100644 index 000000000..2bcd4f71b --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market_Indicators.md @@ -0,0 +1,161 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Market\_Indicators + +# Interface: MetricsTree\_Market\_Indicators + +Defined in: [Developer/brk/modules/brk-client/index.js:3693](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3693) + +## Properties + +### gini + +> **gini**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3694](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3694) + +*** + +### macdHistogram + +> **macdHistogram**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3695](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3695) + +*** + +### macdLine + +> **macdLine**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3696](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3696) + +*** + +### macdSignal + +> **macdSignal**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3697](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3697) + +*** + +### nvt + +> **nvt**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3698](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3698) + +*** + +### piCycle + +> **piCycle**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3699](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3699) + +*** + +### puellMultiple + +> **puellMultiple**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3700](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3700) + +*** + +### rsi14d + +> **rsi14d**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3701](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3701) + +*** + +### rsi14dMax + +> **rsi14dMax**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3702](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3702) + +*** + +### rsi14dMin + +> **rsi14dMin**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3703](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3703) + +*** + +### rsiAverageGain14d + +> **rsiAverageGain14d**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3704](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3704) + +*** + +### rsiAverageLoss14d + +> **rsiAverageLoss14d**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3705](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3705) + +*** + +### rsiGains + +> **rsiGains**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3706](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3706) + +*** + +### rsiLosses + +> **rsiLosses**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3707](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3707) + +*** + +### stochD + +> **stochD**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3708](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3708) + +*** + +### stochK + +> **stochK**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3709](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3709) + +*** + +### stochRsi + +> **stochRsi**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3710](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3710) + +*** + +### stochRsiD + +> **stochRsiD**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3711](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3711) + +*** + +### stochRsiK + +> **stochRsiK**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3712](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3712) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_MovingAverage.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_MovingAverage.md new file mode 100644 index 000000000..e08979816 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market_MovingAverage.md @@ -0,0 +1,289 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Market\_MovingAverage + +# Interface: MetricsTree\_Market\_MovingAverage + +Defined in: [Developer/brk/modules/brk-client/index.js:3716](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3716) + +## Properties + +### price111dSma + +> **price111dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3717](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3717) + +*** + +### price12dEma + +> **price12dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3718](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3718) + +*** + +### price13dEma + +> **price13dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3719](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3719) + +*** + +### price13dSma + +> **price13dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3720](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3720) + +*** + +### price144dEma + +> **price144dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3721](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3721) + +*** + +### price144dSma + +> **price144dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3722](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3722) + +*** + +### price1mEma + +> **price1mEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3723](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3723) + +*** + +### price1mSma + +> **price1mSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3724](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3724) + +*** + +### price1wEma + +> **price1wEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3725](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3725) + +*** + +### price1wSma + +> **price1wSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3726](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3726) + +*** + +### price1yEma + +> **price1yEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3727](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3727) + +*** + +### price1ySma + +> **price1ySma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3728](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3728) + +*** + +### price200dEma + +> **price200dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3729](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3729) + +*** + +### price200dSma + +> **price200dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3730](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3730) + +*** + +### price200dSmaX08 + +> **price200dSmaX08**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3731](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3731) + +*** + +### price200dSmaX24 + +> **price200dSmaX24**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3732](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3732) + +*** + +### price200wEma + +> **price200wEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3733](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3733) + +*** + +### price200wSma + +> **price200wSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3734](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3734) + +*** + +### price21dEma + +> **price21dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3735](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3735) + +*** + +### price21dSma + +> **price21dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3736](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3736) + +*** + +### price26dEma + +> **price26dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3737](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3737) + +*** + +### price2yEma + +> **price2yEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3738](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3738) + +*** + +### price2ySma + +> **price2ySma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3739](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3739) + +*** + +### price34dEma + +> **price34dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3740](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3740) + +*** + +### price34dSma + +> **price34dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3741](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3741) + +*** + +### price350dSma + +> **price350dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3742](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3742) + +*** + +### price350dSmaX2 + +> **price350dSmaX2**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3743](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3743) + +*** + +### price4yEma + +> **price4yEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3744](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3744) + +*** + +### price4ySma + +> **price4ySma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3745](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3745) + +*** + +### price55dEma + +> **price55dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3746](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3746) + +*** + +### price55dSma + +> **price55dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3747](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3747) + +*** + +### price89dEma + +> **price89dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3748](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3748) + +*** + +### price89dSma + +> **price89dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3749](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3749) + +*** + +### price8dEma + +> **price8dEma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3750](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3750) + +*** + +### price8dSma + +> **price8dSma**: [`Price111dSmaPattern`](Price111dSmaPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3751](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3751) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Range.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Range.md new file mode 100644 index 000000000..55ddabd5f --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market_Range.md @@ -0,0 +1,97 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Market\_Range + +# Interface: MetricsTree\_Market\_Range + +Defined in: [Developer/brk/modules/brk-client/index.js:3755](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3755) + +## Properties + +### price1mMax + +> **price1mMax**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3756](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3756) + +*** + +### price1mMin + +> **price1mMin**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3757](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3757) + +*** + +### price1wMax + +> **price1wMax**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3758](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3758) + +*** + +### price1wMin + +> **price1wMin**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3759](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3759) + +*** + +### price1yMax + +> **price1yMax**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3760](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3760) + +*** + +### price1yMin + +> **price1yMin**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3761](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3761) + +*** + +### price2wChoppinessIndex + +> **price2wChoppinessIndex**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3762](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3762) + +*** + +### price2wMax + +> **price2wMax**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3763](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3763) + +*** + +### price2wMin + +> **price2wMin**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3764](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3764) + +*** + +### priceTrueRange + +> **priceTrueRange**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3765](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3765) + +*** + +### priceTrueRange2wSum + +> **priceTrueRange2wSum**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3766](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3766) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns.md new file mode 100644 index 000000000..549ffe8ad --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Market\_Returns + +# Interface: MetricsTree\_Market\_Returns + +Defined in: [Developer/brk/modules/brk-client/index.js:3770](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3770) + +## Properties + +### \_1dReturns1mSd + +> **\_1dReturns1mSd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3771](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3771) + +*** + +### \_1dReturns1wSd + +> **\_1dReturns1wSd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3772](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3772) + +*** + +### \_1dReturns1ySd + +> **\_1dReturns1ySd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3773](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3773) + +*** + +### cagr + +> **cagr**: [`PeriodCagrPattern`](PeriodCagrPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3774](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3774) + +*** + +### downside1mSd + +> **downside1mSd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3775](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3775) + +*** + +### downside1wSd + +> **downside1wSd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3776](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3776) + +*** + +### downside1ySd + +> **downside1ySd**: [`_1dReturns1mSdPattern`](1dReturns1mSdPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3777](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3777) + +*** + +### downsideReturns + +> **downsideReturns**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3778](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3778) + +*** + +### priceReturns + +> **priceReturns**: [`MetricsTree_Market_Returns_PriceReturns`](MetricsTree_Market_Returns_PriceReturns.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3779](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3779) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns_PriceReturns.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns_PriceReturns.md new file mode 100644 index 000000000..8f5b636ea --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market_Returns_PriceReturns.md @@ -0,0 +1,113 @@ +[**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:3783](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3783) + +## Properties + +### \_10y + +> **\_10y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3784](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3784) + +*** + +### \_1d + +> **\_1d**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3785](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3785) + +*** + +### \_1m + +> **\_1m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3786](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3786) + +*** + +### \_1w + +> **\_1w**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3787](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3787) + +*** + +### \_1y + +> **\_1y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3788](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3788) + +*** + +### \_2y + +> **\_2y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3789](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3789) + +*** + +### \_3m + +> **\_3m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3790](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3790) + +*** + +### \_3y + +> **\_3y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3791](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3791) + +*** + +### \_4y + +> **\_4y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3792](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3792) + +*** + +### \_5y + +> **\_5y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3793](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3793) + +*** + +### \_6m + +> **\_6m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3794](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3794) + +*** + +### \_6y + +> **\_6y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3795](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3795) + +*** + +### \_8y + +> **\_8y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3796](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3796) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Market_Volatility.md b/modules/brk-client/docs/interfaces/MetricsTree_Market_Volatility.md new file mode 100644 index 000000000..ea5623309 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Market_Volatility.md @@ -0,0 +1,81 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Market\_Volatility + +# Interface: MetricsTree\_Market\_Volatility + +Defined in: [Developer/brk/modules/brk-client/index.js:3800](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3800) + +## Properties + +### price1mVolatility + +> **price1mVolatility**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3801](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3801) + +*** + +### price1wVolatility + +> **price1wVolatility**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3802](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3802) + +*** + +### price1yVolatility + +> **price1yVolatility**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3803](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3803) + +*** + +### sharpe1m + +> **sharpe1m**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3804](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3804) + +*** + +### sharpe1w + +> **sharpe1w**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3805](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3805) + +*** + +### sharpe1y + +> **sharpe1y**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3806](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3806) + +*** + +### sortino1m + +> **sortino1m**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3807](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3807) + +*** + +### sortino1w + +> **sortino1w**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3808](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3808) + +*** + +### sortino1y + +> **sortino1y**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3809](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3809) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Outputs.md b/modules/brk-client/docs/interfaces/MetricsTree_Outputs.md new file mode 100644 index 000000000..fcba35068 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Outputs.md @@ -0,0 +1,65 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Outputs + +# Interface: MetricsTree\_Outputs + +Defined in: [Developer/brk/modules/brk-client/index.js:3813](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3813) + +## Properties + +### count + +> **count**: [`MetricsTree_Outputs_Count`](MetricsTree_Outputs_Count.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3814](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3814) + +*** + +### firstTxoutindex + +> **firstTxoutindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3815](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3815) + +*** + +### outputtype + +> **outputtype**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<[`OutputType`](../type-aliases/OutputType.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3816](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3816) + +*** + +### spent + +> **spent**: [`MetricsTree_Outputs_Spent`](MetricsTree_Outputs_Spent.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3817](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3817) + +*** + +### txindex + +> **txindex**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3818](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3818) + +*** + +### typeindex + +> **typeindex**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3819](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3819) + +*** + +### value + +> **value**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3820](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3820) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Count.md b/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Count.md new file mode 100644 index 000000000..81eff27bb --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Count.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Outputs\_Count + +# Interface: MetricsTree\_Outputs\_Count + +Defined in: [Developer/brk/modules/brk-client/index.js:3824](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3824) + +## Properties + +### totalCount + +> **totalCount**: [`CountPattern2`](CountPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3825](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3825) + +*** + +### utxoCount + +> **utxoCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3826](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3826) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Spent.md b/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Spent.md new file mode 100644 index 000000000..6c90e3445 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Outputs_Spent.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Outputs\_Spent + +# Interface: MetricsTree\_Outputs\_Spent + +Defined in: [Developer/brk/modules/brk-client/index.js:3830](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3830) + +## Properties + +### txinindex + +> **txinindex**: [`MetricPattern15`](../type-aliases/MetricPattern15.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3831](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3831) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Pools.md b/modules/brk-client/docs/interfaces/MetricsTree_Pools.md new file mode 100644 index 000000000..4d286dc58 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Pools.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Pools + +# Interface: MetricsTree\_Pools + +Defined in: [Developer/brk/modules/brk-client/index.js:3835](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3835) + +## Properties + +### heightToPool + +> **heightToPool**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<[`PoolSlug`](../type-aliases/PoolSlug.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:3836](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3836) + +*** + +### vecs + +> **vecs**: [`MetricsTree_Pools_Vecs`](MetricsTree_Pools_Vecs.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3837](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3837) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Pools_Vecs.md b/modules/brk-client/docs/interfaces/MetricsTree_Pools_Vecs.md new file mode 100644 index 000000000..52793bf0d --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Pools_Vecs.md @@ -0,0 +1,1273 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Pools\_Vecs + +# Interface: MetricsTree\_Pools\_Vecs + +Defined in: [Developer/brk/modules/brk-client/index.js:3841](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3841) + +## Properties + +### aaopool + +> **aaopool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3842](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3842) + +*** + +### antpool + +> **antpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3843](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3843) + +*** + +### arkpool + +> **arkpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3844](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3844) + +*** + +### asicminer + +> **asicminer**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3845](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3845) + +*** + +### axbt + +> **axbt**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3846](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3846) + +*** + +### batpool + +> **batpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3847](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3847) + +*** + +### bcmonster + +> **bcmonster**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3848](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3848) + +*** + +### bcpoolio + +> **bcpoolio**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3849](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3849) + +*** + +### binancepool + +> **binancepool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3850](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3850) + +*** + +### bitalo + +> **bitalo**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3851](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3851) + +*** + +### bitclub + +> **bitclub**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3852](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3852) + +*** + +### bitcoinaffiliatenetwork + +> **bitcoinaffiliatenetwork**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3853](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3853) + +*** + +### bitcoincom + +> **bitcoincom**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3854](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3854) + +*** + +### bitcoinindia + +> **bitcoinindia**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3855](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3855) + +*** + +### bitcoinrussia + +> **bitcoinrussia**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3856](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3856) + +*** + +### bitcoinukraine + +> **bitcoinukraine**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3857](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3857) + +*** + +### bitfarms + +> **bitfarms**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3858](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3858) + +*** + +### bitfufupool + +> **bitfufupool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3859](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3859) + +*** + +### bitfury + +> **bitfury**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3860](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3860) + +*** + +### bitminter + +> **bitminter**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3861](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3861) + +*** + +### bitparking + +> **bitparking**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3862](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3862) + +*** + +### bitsolo + +> **bitsolo**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3863](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3863) + +*** + +### bixin + +> **bixin**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3864](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3864) + +*** + +### blockfills + +> **blockfills**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3865](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3865) + +*** + +### braiinspool + +> **braiinspool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3866](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3866) + +*** + +### bravomining + +> **bravomining**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3867](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3867) + +*** + +### btcc + +> **btcc**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3868](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3868) + +*** + +### btccom + +> **btccom**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3869](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3869) + +*** + +### btcdig + +> **btcdig**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3870](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3870) + +*** + +### btcguild + +> **btcguild**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3871](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3871) + +*** + +### btclab + +> **btclab**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3872](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3872) + +*** + +### btcmp + +> **btcmp**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3873](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3873) + +*** + +### btcnuggets + +> **btcnuggets**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3874](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3874) + +*** + +### btcpoolparty + +> **btcpoolparty**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3875](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3875) + +*** + +### btcserv + +> **btcserv**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3876](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3876) + +*** + +### btctop + +> **btctop**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3877](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3877) + +*** + +### btpool + +> **btpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3878](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3878) + +*** + +### bwpool + +> **bwpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3879](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3879) + +*** + +### bytepool + +> **bytepool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3880](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3880) + +*** + +### canoe + +> **canoe**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3881](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3881) + +*** + +### canoepool + +> **canoepool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3882](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3882) + +*** + +### carbonnegative + +> **carbonnegative**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3883](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3883) + +*** + +### ckpool + +> **ckpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3884](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3884) + +*** + +### cloudhashing + +> **cloudhashing**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3885](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3885) + +*** + +### coinlab + +> **coinlab**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3886](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3886) + +*** + +### cointerra + +> **cointerra**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3887](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3887) + +*** + +### connectbtc + +> **connectbtc**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3888](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3888) + +*** + +### dcex + +> **dcex**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3889](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3889) + +*** + +### dcexploration + +> **dcexploration**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3890](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3890) + +*** + +### digitalbtc + +> **digitalbtc**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3891](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3891) + +*** + +### digitalxmintsy + +> **digitalxmintsy**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3892](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3892) + +*** + +### dpool + +> **dpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3893](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3893) + +*** + +### eclipsemc + +> **eclipsemc**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3894](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3894) + +*** + +### eightbaochi + +> **eightbaochi**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3895](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3895) + +*** + +### ekanembtc + +> **ekanembtc**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3896](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3896) + +*** + +### eligius + +> **eligius**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3897](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3897) + +*** + +### emcdpool + +> **emcdpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3898](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3898) + +*** + +### entrustcharitypool + +> **entrustcharitypool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3899](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3899) + +*** + +### eobot + +> **eobot**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3900](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3900) + +*** + +### exxbw + +> **exxbw**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3901](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3901) + +*** + +### f2pool + +> **f2pool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3902](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3902) + +*** + +### fiftyeightcoin + +> **fiftyeightcoin**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3903](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3903) + +*** + +### foundryusa + +> **foundryusa**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3904](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3904) + +*** + +### futurebitapollosolo + +> **futurebitapollosolo**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3905](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3905) + +*** + +### gbminers + +> **gbminers**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3906](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3906) + +*** + +### ghashio + +> **ghashio**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3907](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3907) + +*** + +### givemecoins + +> **givemecoins**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3908](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3908) + +*** + +### gogreenlight + +> **gogreenlight**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3909](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3909) + +*** + +### haominer + +> **haominer**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3910](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3910) + +*** + +### haozhuzhu + +> **haozhuzhu**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3911](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3911) + +*** + +### hashbx + +> **hashbx**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3912](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3912) + +*** + +### hashpool + +> **hashpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3913](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3913) + +*** + +### helix + +> **helix**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3914](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3914) + +*** + +### hhtt + +> **hhtt**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3915](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3915) + +*** + +### hotpool + +> **hotpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3916](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3916) + +*** + +### hummerpool + +> **hummerpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3917](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3917) + +*** + +### huobipool + +> **huobipool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3918](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3918) + +*** + +### innopolistech + +> **innopolistech**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3919](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3919) + +*** + +### kanopool + +> **kanopool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3920](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3920) + +*** + +### kncminer + +> **kncminer**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3921](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3921) + +*** + +### kucoinpool + +> **kucoinpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3922](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3922) + +*** + +### lubiancom + +> **lubiancom**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3923](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3923) + +*** + +### luckypool + +> **luckypool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3924](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3924) + +*** + +### luxor + +> **luxor**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3925](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3925) + +*** + +### marapool + +> **marapool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3926](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3926) + +*** + +### maxbtc + +> **maxbtc**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3927](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3927) + +*** + +### maxipool + +> **maxipool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3928](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3928) + +*** + +### megabigpower + +> **megabigpower**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3929](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3929) + +*** + +### minerium + +> **minerium**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3930](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3930) + +*** + +### miningcity + +> **miningcity**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3931](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3931) + +*** + +### miningdutch + +> **miningdutch**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3932](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3932) + +*** + +### miningkings + +> **miningkings**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3933](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3933) + +*** + +### miningsquared + +> **miningsquared**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3934](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3934) + +*** + +### mmpool + +> **mmpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3935](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3935) + +*** + +### mtred + +> **mtred**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3936](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3936) + +*** + +### multicoinco + +> **multicoinco**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3937](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3937) + +*** + +### multipool + +> **multipool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3938](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3938) + +*** + +### mybtccoinpool + +> **mybtccoinpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3939](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3939) + +*** + +### neopool + +> **neopool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3940](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3940) + +*** + +### nexious + +> **nexious**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3941](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3941) + +*** + +### nicehash + +> **nicehash**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3942](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3942) + +*** + +### nmcbit + +> **nmcbit**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3943](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3943) + +*** + +### novablock + +> **novablock**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3944](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3944) + +*** + +### ocean + +> **ocean**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3945](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3945) + +*** + +### okexpool + +> **okexpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3946](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3946) + +*** + +### okkong + +> **okkong**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3947](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3947) + +*** + +### okminer + +> **okminer**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3948](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3948) + +*** + +### okpooltop + +> **okpooltop**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3949](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3949) + +*** + +### onehash + +> **onehash**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3950](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3950) + +*** + +### onem1x + +> **onem1x**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3951](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3951) + +*** + +### onethash + +> **onethash**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3952](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3952) + +*** + +### ozcoin + +> **ozcoin**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3953](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3953) + +*** + +### parasite + +> **parasite**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3954](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3954) + +*** + +### patels + +> **patels**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3955](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3955) + +*** + +### pegapool + +> **pegapool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3956](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3956) + +*** + +### phashio + +> **phashio**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3957](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3957) + +*** + +### phoenix + +> **phoenix**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3958](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3958) + +*** + +### polmine + +> **polmine**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3959](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3959) + +*** + +### pool175btc + +> **pool175btc**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3960](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3960) + +*** + +### pool50btc + +> **pool50btc**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3961](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3961) + +*** + +### poolin + +> **poolin**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3962](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3962) + +*** + +### portlandhodl + +> **portlandhodl**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3963](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3963) + +*** + +### publicpool + +> **publicpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3964](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3964) + +*** + +### purebtccom + +> **purebtccom**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3965](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3965) + +*** + +### rawpool + +> **rawpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3966](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3966) + +*** + +### rigpool + +> **rigpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3967](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3967) + +*** + +### sbicrypto + +> **sbicrypto**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3968](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3968) + +*** + +### secpool + +> **secpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3969](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3969) + +*** + +### secretsuperstar + +> **secretsuperstar**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3970](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3970) + +*** + +### sevenpool + +> **sevenpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3971](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3971) + +*** + +### shawnp0wers + +> **shawnp0wers**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3972](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3972) + +*** + +### sigmapoolcom + +> **sigmapoolcom**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3973](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3973) + +*** + +### simplecoinus + +> **simplecoinus**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3974](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3974) + +*** + +### solock + +> **solock**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3975](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3975) + +*** + +### spiderpool + +> **spiderpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3976](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3976) + +*** + +### stminingcorp + +> **stminingcorp**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3977](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3977) + +*** + +### tangpool + +> **tangpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3978](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3978) + +*** + +### tatmaspool + +> **tatmaspool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3979](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3979) + +*** + +### tbdice + +> **tbdice**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3980](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3980) + +*** + +### telco214 + +> **telco214**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3981](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3981) + +*** + +### terrapool + +> **terrapool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3982](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3982) + +*** + +### tiger + +> **tiger**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3983](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3983) + +*** + +### tigerpoolnet + +> **tigerpoolnet**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3984](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3984) + +*** + +### titan + +> **titan**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3985](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3985) + +*** + +### transactioncoinmining + +> **transactioncoinmining**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3986](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3986) + +*** + +### trickysbtcpool + +> **trickysbtcpool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3987](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3987) + +*** + +### triplemining + +> **triplemining**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3988](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3988) + +*** + +### twentyoneinc + +> **twentyoneinc**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3989](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3989) + +*** + +### ultimuspool + +> **ultimuspool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3990](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3990) + +*** + +### unknown + +> **unknown**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3991](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3991) + +*** + +### unomp + +> **unomp**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3992](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3992) + +*** + +### viabtc + +> **viabtc**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3993](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3993) + +*** + +### waterhole + +> **waterhole**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3994](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3994) + +*** + +### wayicn + +> **wayicn**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3995](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3995) + +*** + +### whitepool + +> **whitepool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3996](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3996) + +*** + +### wk057 + +> **wk057**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3997](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3997) + +*** + +### yourbtcnet + +> **yourbtcnet**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3998](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3998) + +*** + +### zulupool + +> **zulupool**: [`AaopoolPattern`](AaopoolPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:3999](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L3999) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Positions.md b/modules/brk-client/docs/interfaces/MetricsTree_Positions.md new file mode 100644 index 000000000..6427dbe78 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Positions.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Positions + +# Interface: MetricsTree\_Positions + +Defined in: [Developer/brk/modules/brk-client/index.js:4003](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4003) + +## Properties + +### blockPosition + +> **blockPosition**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4004](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4004) + +*** + +### txPosition + +> **txPosition**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4005](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4005) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Price.md b/modules/brk-client/docs/interfaces/MetricsTree_Price.md new file mode 100644 index 000000000..2fde67aaf --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Price.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Price + +# Interface: MetricsTree\_Price + +Defined in: [Developer/brk/modules/brk-client/index.js:4009](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4009) + +## Properties + +### cents + +> **cents**: [`MetricsTree_Price_Cents`](MetricsTree_Price_Cents.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4010](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4010) + +*** + +### oracle + +> **oracle**: [`MetricsTree_Price_Oracle`](MetricsTree_Price_Oracle.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4011](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4011) + +*** + +### sats + +> **sats**: [`SatsPattern`](SatsPattern.md)\<[`OHLCSats`](OHLCSats.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4012](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4012) + +*** + +### usd + +> **usd**: [`MetricsTree_Price_Usd`](MetricsTree_Price_Usd.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4013](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4013) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents.md b/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents.md new file mode 100644 index 000000000..56898e66f --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Price\_Cents + +# Interface: MetricsTree\_Price\_Cents + +Defined in: [Developer/brk/modules/brk-client/index.js:4017](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4017) + +## Properties + +### ohlc + +> **ohlc**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<[`OHLCCents`](OHLCCents.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4018](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4018) + +*** + +### split + +> **split**: [`MetricsTree_Price_Cents_Split`](MetricsTree_Price_Cents_Split.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4019](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4019) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents_Split.md b/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents_Split.md new file mode 100644 index 000000000..da009a11b --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Price_Cents_Split.md @@ -0,0 +1,41 @@ +[**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:4023](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4023) + +## Properties + +### close + +> **close**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4024](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4024) + +*** + +### high + +> **high**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4025](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4025) + +*** + +### low + +> **low**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4026](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4026) + +*** + +### open + +> **open**: [`MetricPattern5`](../type-aliases/MetricPattern5.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4027](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4027) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Price_Oracle.md b/modules/brk-client/docs/interfaces/MetricsTree_Price_Oracle.md new file mode 100644 index 000000000..e386d00e4 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Price_Oracle.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Price\_Oracle + +# Interface: MetricsTree\_Price\_Oracle + +Defined in: [Developer/brk/modules/brk-client/index.js:4031](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4031) + +## Properties + +### ohlcCents + +> **ohlcCents**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<[`OHLCCents`](OHLCCents.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4032](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4032) + +*** + +### ohlcDollars + +> **ohlcDollars**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<[`OHLCDollars`](OHLCDollars.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4033](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4033) + +*** + +### priceCents + +> **priceCents**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4034](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4034) + +*** + +### txCount + +> **txCount**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4035](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4035) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Price_Usd.md b/modules/brk-client/docs/interfaces/MetricsTree_Price_Usd.md new file mode 100644 index 000000000..6a1797205 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Price_Usd.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Price\_Usd + +# Interface: MetricsTree\_Price\_Usd + +Defined in: [Developer/brk/modules/brk-client/index.js:4039](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4039) + +## Properties + +### ohlc + +> **ohlc**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<[`OHLCDollars`](OHLCDollars.md)\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4040](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4040) + +*** + +### split + +> **split**: [`SplitPattern2`](SplitPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4041](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4041) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Scripts.md b/modules/brk-client/docs/interfaces/MetricsTree_Scripts.md new file mode 100644 index 000000000..aeaf63716 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Scripts.md @@ -0,0 +1,89 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Scripts + +# Interface: MetricsTree\_Scripts + +Defined in: [Developer/brk/modules/brk-client/index.js:4045](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4045) + +## Properties + +### count + +> **count**: [`MetricsTree_Scripts_Count`](MetricsTree_Scripts_Count.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4046](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4046) + +*** + +### emptyToTxindex + +> **emptyToTxindex**: [`MetricPattern9`](../type-aliases/MetricPattern9.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4047](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4047) + +*** + +### firstEmptyoutputindex + +> **firstEmptyoutputindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4048](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4048) + +*** + +### firstOpreturnindex + +> **firstOpreturnindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4049](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4049) + +*** + +### firstP2msoutputindex + +> **firstP2msoutputindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4050](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4050) + +*** + +### firstUnknownoutputindex + +> **firstUnknownoutputindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4051](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4051) + +*** + +### opreturnToTxindex + +> **opreturnToTxindex**: [`MetricPattern14`](../type-aliases/MetricPattern14.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4052](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4052) + +*** + +### p2msToTxindex + +> **p2msToTxindex**: [`MetricPattern17`](../type-aliases/MetricPattern17.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4053](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4053) + +*** + +### unknownToTxindex + +> **unknownToTxindex**: [`MetricPattern28`](../type-aliases/MetricPattern28.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4054](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4054) + +*** + +### value + +> **value**: [`MetricsTree_Scripts_Value`](MetricsTree_Scripts_Value.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4055](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4055) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Count.md b/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Count.md new file mode 100644 index 000000000..25b82ee2c --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Count.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Scripts\_Count + +# Interface: MetricsTree\_Scripts\_Count + +Defined in: [Developer/brk/modules/brk-client/index.js:4059](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4059) + +## Properties + +### emptyoutput + +> **emptyoutput**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4060](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4060) + +*** + +### opreturn + +> **opreturn**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4061](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4061) + +*** + +### p2a + +> **p2a**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4062](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4062) + +*** + +### p2ms + +> **p2ms**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4063](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4063) + +*** + +### p2pk33 + +> **p2pk33**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4064](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4064) + +*** + +### p2pk65 + +> **p2pk65**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4065](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4065) + +*** + +### p2pkh + +> **p2pkh**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4066](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4066) + +*** + +### p2sh + +> **p2sh**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4067](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4067) + +*** + +### p2tr + +> **p2tr**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4068](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4068) + +*** + +### p2wpkh + +> **p2wpkh**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4069](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4069) + +*** + +### p2wsh + +> **p2wsh**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4070](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4070) + +*** + +### segwit + +> **segwit**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4071](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4071) + +*** + +### segwitAdoption + +> **segwitAdoption**: [`SegwitAdoptionPattern`](SegwitAdoptionPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4072](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4072) + +*** + +### taprootAdoption + +> **taprootAdoption**: [`SegwitAdoptionPattern`](SegwitAdoptionPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4073](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4073) + +*** + +### unknownoutput + +> **unknownoutput**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4074](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4074) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Value.md b/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Value.md new file mode 100644 index 000000000..7d55f4191 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Scripts_Value.md @@ -0,0 +1,17 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Scripts\_Value + +# Interface: MetricsTree\_Scripts\_Value + +Defined in: [Developer/brk/modules/brk-client/index.js:4078](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4078) + +## Properties + +### opreturn + +> **opreturn**: [`CoinbasePattern`](CoinbasePattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4079](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4079) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Supply.md b/modules/brk-client/docs/interfaces/MetricsTree_Supply.md new file mode 100644 index 000000000..9453a29a8 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Supply.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Supply + +# Interface: MetricsTree\_Supply + +Defined in: [Developer/brk/modules/brk-client/index.js:4083](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4083) + +## Properties + +### burned + +> **burned**: [`MetricsTree_Supply_Burned`](MetricsTree_Supply_Burned.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4084](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4084) + +*** + +### circulating + +> **circulating**: [`MetricsTree_Supply_Circulating`](MetricsTree_Supply_Circulating.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4085](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4085) + +*** + +### inflation + +> **inflation**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4086](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4086) + +*** + +### marketCap + +> **marketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4087](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4087) + +*** + +### velocity + +> **velocity**: [`MetricsTree_Supply_Velocity`](MetricsTree_Supply_Velocity.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4088](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4088) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Supply_Burned.md b/modules/brk-client/docs/interfaces/MetricsTree_Supply_Burned.md new file mode 100644 index 000000000..7eb1208f9 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Supply_Burned.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Supply\_Burned + +# Interface: MetricsTree\_Supply\_Burned + +Defined in: [Developer/brk/modules/brk-client/index.js:4092](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4092) + +## Properties + +### opreturn + +> **opreturn**: [`UnclaimedRewardsPattern`](UnclaimedRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4093](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4093) + +*** + +### unspendable + +> **unspendable**: [`UnclaimedRewardsPattern`](UnclaimedRewardsPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4094](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4094) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Supply_Circulating.md b/modules/brk-client/docs/interfaces/MetricsTree_Supply_Circulating.md new file mode 100644 index 000000000..e52b17cdf --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Supply_Circulating.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Supply\_Circulating + +# Interface: MetricsTree\_Supply\_Circulating + +Defined in: [Developer/brk/modules/brk-client/index.js:4098](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4098) + +## Properties + +### bitcoin + +> **bitcoin**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4099](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4099) + +*** + +### dollars + +> **dollars**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4100](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4100) + +*** + +### sats + +> **sats**: [`MetricPattern3`](../type-aliases/MetricPattern3.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4101](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4101) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Supply_Velocity.md b/modules/brk-client/docs/interfaces/MetricsTree_Supply_Velocity.md new file mode 100644 index 000000000..bf26d42aa --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Supply_Velocity.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Supply\_Velocity + +# Interface: MetricsTree\_Supply\_Velocity + +Defined in: [Developer/brk/modules/brk-client/index.js:4105](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4105) + +## Properties + +### btc + +> **btc**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4106](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4106) + +*** + +### usd + +> **usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4107](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4107) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions.md new file mode 100644 index 000000000..f82cbf68d --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Transactions.md @@ -0,0 +1,129 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Transactions + +# Interface: MetricsTree\_Transactions + +Defined in: [Developer/brk/modules/brk-client/index.js:4111](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4111) + +## Properties + +### baseSize + +> **baseSize**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4112](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4112) + +*** + +### count + +> **count**: [`MetricsTree_Transactions_Count`](MetricsTree_Transactions_Count.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4113](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4113) + +*** + +### fees + +> **fees**: [`MetricsTree_Transactions_Fees`](MetricsTree_Transactions_Fees.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4114](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4114) + +*** + +### firstTxindex + +> **firstTxindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4115](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4115) + +*** + +### firstTxinindex + +> **firstTxinindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4116](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4116) + +*** + +### firstTxoutindex + +> **firstTxoutindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4117](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4117) + +*** + +### height + +> **height**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4118](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4118) + +*** + +### isExplicitlyRbf + +> **isExplicitlyRbf**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4119](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4119) + +*** + +### rawlocktime + +> **rawlocktime**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4120](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4120) + +*** + +### size + +> **size**: [`MetricsTree_Transactions_Size`](MetricsTree_Transactions_Size.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4121](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4121) + +*** + +### totalSize + +> **totalSize**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4122](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4122) + +*** + +### txid + +> **txid**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4123](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4123) + +*** + +### txversion + +> **txversion**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4124](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4124) + +*** + +### versions + +> **versions**: [`MetricsTree_Transactions_Versions`](MetricsTree_Transactions_Versions.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4125](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4125) + +*** + +### volume + +> **volume**: [`MetricsTree_Transactions_Volume`](MetricsTree_Transactions_Volume.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4126](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4126) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Count.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Count.md new file mode 100644 index 000000000..c312940bb --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Count.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Transactions\_Count + +# Interface: MetricsTree\_Transactions\_Count + +Defined in: [Developer/brk/modules/brk-client/index.js:4130](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4130) + +## Properties + +### isCoinbase + +> **isCoinbase**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4131](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4131) + +*** + +### txCount + +> **txCount**: [`DollarsPattern`](DollarsPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4132](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4132) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees.md new file mode 100644 index 000000000..dcc46873c --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees.md @@ -0,0 +1,41 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Transactions\_Fees + +# Interface: MetricsTree\_Transactions\_Fees + +Defined in: [Developer/brk/modules/brk-client/index.js:4136](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4136) + +## Properties + +### fee + +> **fee**: [`MetricsTree_Transactions_Fees_Fee`](MetricsTree_Transactions_Fees_Fee.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4137](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4137) + +*** + +### feeRate + +> **feeRate**: [`FeeRatePattern`](FeeRatePattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4138](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4138) + +*** + +### inputValue + +> **inputValue**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4139](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4139) + +*** + +### outputValue + +> **outputValue**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4140](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4140) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees_Fee.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees_Fee.md new file mode 100644 index 000000000..fa325590c --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees_Fee.md @@ -0,0 +1,41 @@ +[**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:4144](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4144) + +## Properties + +### bitcoin + +> **bitcoin**: [`CountPattern2`](CountPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4145](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4145) + +*** + +### dollars + +> **dollars**: [`MetricsTree_Transactions_Fees_Fee_Dollars`](MetricsTree_Transactions_Fees_Fee_Dollars.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4146](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4146) + +*** + +### sats + +> **sats**: [`CountPattern2`](CountPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4147](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4147) + +*** + +### txindex + +> **txindex**: [`MetricPattern27`](../type-aliases/MetricPattern27.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4148](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4148) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees_Fee_Dollars.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees_Fee_Dollars.md new file mode 100644 index 000000000..0f63f0e0e --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Fees_Fee_Dollars.md @@ -0,0 +1,97 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Transactions\_Fees\_Fee\_Dollars + +# Interface: MetricsTree\_Transactions\_Fees\_Fee\_Dollars + +Defined in: [Developer/brk/modules/brk-client/index.js:4152](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4152) + +## Properties + +### average + +> **average**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4153](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4153) + +*** + +### cumulative + +> **cumulative**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4154](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4154) + +*** + +### heightCumulative + +> **heightCumulative**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4155](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4155) + +*** + +### max + +> **max**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4156](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4156) + +*** + +### median + +> **median**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4157](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4157) + +*** + +### min + +> **min**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4158](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4158) + +*** + +### pct10 + +> **pct10**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4159](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4159) + +*** + +### pct25 + +> **pct25**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4160](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4160) + +*** + +### pct75 + +> **pct75**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4161](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4161) + +*** + +### pct90 + +> **pct90**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4162](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4162) + +*** + +### sum + +> **sum**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4163](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4163) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Size.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Size.md new file mode 100644 index 000000000..0ecdac75c --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Size.md @@ -0,0 +1,25 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Transactions\_Size + +# Interface: MetricsTree\_Transactions\_Size + +Defined in: [Developer/brk/modules/brk-client/index.js:4167](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4167) + +## Properties + +### vsize + +> **vsize**: [`FeeRatePattern`](FeeRatePattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4168](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4168) + +*** + +### weight + +> **weight**: [`FeeRatePattern`](FeeRatePattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4169](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4169) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Versions.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Versions.md new file mode 100644 index 000000000..7de626857 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Versions.md @@ -0,0 +1,33 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Transactions\_Versions + +# Interface: MetricsTree\_Transactions\_Versions + +Defined in: [Developer/brk/modules/brk-client/index.js:4173](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4173) + +## Properties + +### v1 + +> **v1**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4174](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4174) + +*** + +### v2 + +> **v2**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4175](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4175) + +*** + +### v3 + +> **v3**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4176](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4176) diff --git a/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Volume.md b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Volume.md new file mode 100644 index 000000000..4c0af0860 --- /dev/null +++ b/modules/brk-client/docs/interfaces/MetricsTree_Transactions_Volume.md @@ -0,0 +1,49 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / MetricsTree\_Transactions\_Volume + +# Interface: MetricsTree\_Transactions\_Volume + +Defined in: [Developer/brk/modules/brk-client/index.js:4180](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4180) + +## Properties + +### annualizedVolume + +> **annualizedVolume**: [`_2015Pattern`](2015Pattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4181](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4181) + +*** + +### inputsPerSec + +> **inputsPerSec**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4182](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4182) + +*** + +### outputsPerSec + +> **outputsPerSec**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4183](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4183) + +*** + +### sentSum + +> **sentSum**: [`ActiveSupplyPattern`](ActiveSupplyPattern.md) + +Defined in: [Developer/brk/modules/brk-client/index.js:4184](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4184) + +*** + +### txPerSec + +> **txPerSec**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:4185](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L4185) diff --git a/modules/brk-client/docs/interfaces/OHLCCents.md b/modules/brk-client/docs/interfaces/OHLCCents.md index 164316e6c..031b2390c 100644 --- a/modules/brk-client/docs/interfaces/OHLCCents.md +++ b/modules/brk-client/docs/interfaces/OHLCCents.md @@ -6,7 +6,7 @@ # Interface: OHLCCents -Defined in: [Developer/brk/modules/brk-client/index.js:280](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L280) +Defined in: [Developer/brk/modules/brk-client/index.js:428](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L428) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:280](https://github.com/b > **close**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:281](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L281) +Defined in: [Developer/brk/modules/brk-client/index.js:432](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L432) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:281](https://github.com/b > **high**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:282](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L282) +Defined in: [Developer/brk/modules/brk-client/index.js:430](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L430) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:282](https://github.com/b > **low**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:283](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L283) +Defined in: [Developer/brk/modules/brk-client/index.js:431](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L431) *** @@ -38,4 +38,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:283](https://github.com/b > **open**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:284](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L284) +Defined in: [Developer/brk/modules/brk-client/index.js:429](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L429) diff --git a/modules/brk-client/docs/interfaces/OHLCDollars.md b/modules/brk-client/docs/interfaces/OHLCDollars.md index 6e45b01c6..b3cdeaa71 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:287](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L287) +Defined in: [Developer/brk/modules/brk-client/index.js:437](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L437) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:287](https://github.com/b > **close**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:288](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L288) +Defined in: [Developer/brk/modules/brk-client/index.js:441](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L441) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:288](https://github.com/b > **high**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:289](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L289) +Defined in: [Developer/brk/modules/brk-client/index.js:439](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L439) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:289](https://github.com/b > **low**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:290](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L290) +Defined in: [Developer/brk/modules/brk-client/index.js:440](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L440) *** @@ -38,4 +38,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:290](https://github.com/b > **open**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:291](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L291) +Defined in: [Developer/brk/modules/brk-client/index.js:438](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L438) diff --git a/modules/brk-client/docs/interfaces/OHLCSats.md b/modules/brk-client/docs/interfaces/OHLCSats.md index 6269e0e88..46c8d9707 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:294](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L294) +Defined in: [Developer/brk/modules/brk-client/index.js:446](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L446) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:294](https://github.com/b > **close**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:295](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L295) +Defined in: [Developer/brk/modules/brk-client/index.js:450](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L450) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:295](https://github.com/b > **high**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:296](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L296) +Defined in: [Developer/brk/modules/brk-client/index.js:448](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L448) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:296](https://github.com/b > **low**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:297](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L297) +Defined in: [Developer/brk/modules/brk-client/index.js:449](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L449) *** @@ -38,4 +38,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:297](https://github.com/b > **open**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:298](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L298) +Defined in: [Developer/brk/modules/brk-client/index.js:447](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L447) diff --git a/modules/brk-client/docs/interfaces/OutputsPattern.md b/modules/brk-client/docs/interfaces/OutputsPattern.md index 97dae0bee..43d170949 100644 --- a/modules/brk-client/docs/interfaces/OutputsPattern.md +++ b/modules/brk-client/docs/interfaces/OutputsPattern.md @@ -6,7 +6,7 @@ # Interface: OutputsPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3685](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3685) +Defined in: [Developer/brk/modules/brk-client/index.js:2841](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2841) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3685](https://github.com/ > **utxoCount**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3686](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3686) +Defined in: [Developer/brk/modules/brk-client/index.js:2842](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2842) diff --git a/modules/brk-client/docs/interfaces/PaginatedMetrics.md b/modules/brk-client/docs/interfaces/PaginatedMetrics.md index 25c97db22..17f32be17 100644 --- a/modules/brk-client/docs/interfaces/PaginatedMetrics.md +++ b/modules/brk-client/docs/interfaces/PaginatedMetrics.md @@ -6,7 +6,7 @@ # Interface: PaginatedMetrics -Defined in: [Developer/brk/modules/brk-client/index.js:322](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L322) +Defined in: [Developer/brk/modules/brk-client/index.js:484](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L484) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:322](https://github.com/b > **currentPage**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:323](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L323) +Defined in: [Developer/brk/modules/brk-client/index.js:485](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L485) + +Current page number (0-indexed) *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:323](https://github.com/b > **maxPage**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:324](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L324) +Defined in: [Developer/brk/modules/brk-client/index.js:486](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L486) + +Maximum valid page index (0-indexed) *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:324](https://github.com/b > **metrics**: `string`[] -Defined in: [Developer/brk/modules/brk-client/index.js:325](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L325) +Defined in: [Developer/brk/modules/brk-client/index.js:487](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L487) + +List of metric names (max 1000 per page) diff --git a/modules/brk-client/docs/interfaces/Pagination.md b/modules/brk-client/docs/interfaces/Pagination.md index 6293a0814..ba156e731 100644 --- a/modules/brk-client/docs/interfaces/Pagination.md +++ b/modules/brk-client/docs/interfaces/Pagination.md @@ -6,7 +6,7 @@ # Interface: Pagination -Defined in: [Developer/brk/modules/brk-client/index.js:328](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L328) +Defined in: [Developer/brk/modules/brk-client/index.js:492](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L492) ## Properties @@ -14,4 +14,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:328](https://github.com/b > `optional` **page**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:329](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L329) +Defined in: [Developer/brk/modules/brk-client/index.js:493](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L493) + +Pagination index diff --git a/modules/brk-client/docs/interfaces/PercentilesPattern.md b/modules/brk-client/docs/interfaces/PercentilesPattern.md index 01150ee23..5a5eff1ae 100644 --- a/modules/brk-client/docs/interfaces/PercentilesPattern.md +++ b/modules/brk-client/docs/interfaces/PercentilesPattern.md @@ -6,156 +6,156 @@ # Interface: PercentilesPattern -Defined in: [Developer/brk/modules/brk-client/index.js:2441](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2441) +Defined in: [Developer/brk/modules/brk-client/index.js:1688](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1688) ## Properties -### costBasisPct05 +### pct05 -> **costBasisPct05**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct05**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2442](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2442) +Defined in: [Developer/brk/modules/brk-client/index.js:1689](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1689) *** -### costBasisPct10 +### pct10 -> **costBasisPct10**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct10**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2443](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2443) +Defined in: [Developer/brk/modules/brk-client/index.js:1690](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1690) *** -### costBasisPct15 +### pct15 -> **costBasisPct15**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct15**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2444](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2444) +Defined in: [Developer/brk/modules/brk-client/index.js:1691](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1691) *** -### costBasisPct20 +### pct20 -> **costBasisPct20**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct20**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2445](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2445) +Defined in: [Developer/brk/modules/brk-client/index.js:1692](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1692) *** -### costBasisPct25 +### pct25 -> **costBasisPct25**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct25**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2446](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2446) +Defined in: [Developer/brk/modules/brk-client/index.js:1693](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1693) *** -### costBasisPct30 +### pct30 -> **costBasisPct30**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct30**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2447](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2447) +Defined in: [Developer/brk/modules/brk-client/index.js:1694](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1694) *** -### costBasisPct35 +### pct35 -> **costBasisPct35**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct35**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2448](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2448) +Defined in: [Developer/brk/modules/brk-client/index.js:1695](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1695) *** -### costBasisPct40 +### pct40 -> **costBasisPct40**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct40**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2449](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2449) +Defined in: [Developer/brk/modules/brk-client/index.js:1696](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1696) *** -### costBasisPct45 +### pct45 -> **costBasisPct45**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct45**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2450](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2450) +Defined in: [Developer/brk/modules/brk-client/index.js:1697](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1697) *** -### costBasisPct50 +### pct50 -> **costBasisPct50**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct50**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2451](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2451) +Defined in: [Developer/brk/modules/brk-client/index.js:1698](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1698) *** -### costBasisPct55 +### pct55 -> **costBasisPct55**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct55**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2452](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2452) +Defined in: [Developer/brk/modules/brk-client/index.js:1699](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1699) *** -### costBasisPct60 +### pct60 -> **costBasisPct60**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct60**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2453](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2453) +Defined in: [Developer/brk/modules/brk-client/index.js:1700](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1700) *** -### costBasisPct65 +### pct65 -> **costBasisPct65**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct65**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2454](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2454) +Defined in: [Developer/brk/modules/brk-client/index.js:1701](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1701) *** -### costBasisPct70 +### pct70 -> **costBasisPct70**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct70**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2455](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2455) +Defined in: [Developer/brk/modules/brk-client/index.js:1702](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1702) *** -### costBasisPct75 +### pct75 -> **costBasisPct75**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct75**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2456](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2456) +Defined in: [Developer/brk/modules/brk-client/index.js:1703](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1703) *** -### costBasisPct80 +### pct80 -> **costBasisPct80**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct80**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2457](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2457) +Defined in: [Developer/brk/modules/brk-client/index.js:1704](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1704) *** -### costBasisPct85 +### pct85 -> **costBasisPct85**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct85**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2458](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2458) +Defined in: [Developer/brk/modules/brk-client/index.js:1705](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1705) *** -### costBasisPct90 +### pct90 -> **costBasisPct90**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct90**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2459](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2459) +Defined in: [Developer/brk/modules/brk-client/index.js:1706](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1706) *** -### costBasisPct95 +### pct95 -> **costBasisPct95**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> +> **pct95**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2460](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2460) +Defined in: [Developer/brk/modules/brk-client/index.js:1707](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1707) diff --git a/modules/brk-client/docs/interfaces/PeriodAveragePricePattern.md b/modules/brk-client/docs/interfaces/PeriodAveragePricePattern.md index 225a122da..6d5a2fe46 100644 --- a/modules/brk-client/docs/interfaces/PeriodAveragePricePattern.md +++ b/modules/brk-client/docs/interfaces/PeriodAveragePricePattern.md @@ -6,7 +6,7 @@ # Interface: PeriodAveragePricePattern\ -Defined in: [Developer/brk/modules/brk-client/index.js:2722](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2722) +Defined in: [Developer/brk/modules/brk-client/index.js:1918](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1918) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2722](https://github.com/ > **\_10y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2723](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2723) +Defined in: [Developer/brk/modules/brk-client/index.js:1919](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1919) *** @@ -28,7 +28,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2723](https://github.com/ > **\_1m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2724](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2724) +Defined in: [Developer/brk/modules/brk-client/index.js:1920](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1920) *** @@ -36,7 +36,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2724](https://github.com/ > **\_1w**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2725](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2725) +Defined in: [Developer/brk/modules/brk-client/index.js:1921](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1921) *** @@ -44,7 +44,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2725](https://github.com/ > **\_1y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2726](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2726) +Defined in: [Developer/brk/modules/brk-client/index.js:1922](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1922) *** @@ -52,7 +52,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2726](https://github.com/ > **\_2y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2727](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2727) +Defined in: [Developer/brk/modules/brk-client/index.js:1923](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1923) *** @@ -60,7 +60,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2727](https://github.com/ > **\_3m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2728](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2728) +Defined in: [Developer/brk/modules/brk-client/index.js:1924](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1924) *** @@ -68,7 +68,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2728](https://github.com/ > **\_3y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2729](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2729) +Defined in: [Developer/brk/modules/brk-client/index.js:1925](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1925) *** @@ -76,7 +76,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2729](https://github.com/ > **\_4y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2730](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2730) +Defined in: [Developer/brk/modules/brk-client/index.js:1926](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1926) *** @@ -84,7 +84,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2730](https://github.com/ > **\_5y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2731](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2731) +Defined in: [Developer/brk/modules/brk-client/index.js:1927](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1927) *** @@ -92,7 +92,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2731](https://github.com/ > **\_6m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2732](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2732) +Defined in: [Developer/brk/modules/brk-client/index.js:1928](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1928) *** @@ -100,7 +100,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2732](https://github.com/ > **\_6y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2733](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2733) +Defined in: [Developer/brk/modules/brk-client/index.js:1929](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1929) *** @@ -108,4 +108,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2733](https://github.com/ > **\_8y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2734](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2734) +Defined in: [Developer/brk/modules/brk-client/index.js:1930](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1930) diff --git a/modules/brk-client/docs/interfaces/PeriodCagrPattern.md b/modules/brk-client/docs/interfaces/PeriodCagrPattern.md index 7bf58a5f5..065d72aeb 100644 --- a/modules/brk-client/docs/interfaces/PeriodCagrPattern.md +++ b/modules/brk-client/docs/interfaces/PeriodCagrPattern.md @@ -6,7 +6,7 @@ # Interface: PeriodCagrPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3244](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3244) +Defined in: [Developer/brk/modules/brk-client/index.js:2343](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2343) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3244](https://github.com/ > **\_10y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3245](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3245) +Defined in: [Developer/brk/modules/brk-client/index.js:2344](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2344) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3245](https://github.com/ > **\_2y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3246](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3246) +Defined in: [Developer/brk/modules/brk-client/index.js:2345](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2345) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3246](https://github.com/ > **\_3y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3247](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3247) +Defined in: [Developer/brk/modules/brk-client/index.js:2346](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2346) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3247](https://github.com/ > **\_4y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3248](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3248) +Defined in: [Developer/brk/modules/brk-client/index.js:2347](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2347) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3248](https://github.com/ > **\_5y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3249](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3249) +Defined in: [Developer/brk/modules/brk-client/index.js:2348](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2348) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3249](https://github.com/ > **\_6y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3250](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3250) +Defined in: [Developer/brk/modules/brk-client/index.js:2349](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2349) *** @@ -62,4 +62,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3250](https://github.com/ > **\_8y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3251](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3251) +Defined in: [Developer/brk/modules/brk-client/index.js:2350](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2350) diff --git a/modules/brk-client/docs/interfaces/PeriodLumpSumStackPattern.md b/modules/brk-client/docs/interfaces/PeriodLumpSumStackPattern.md index 32f8ebab0..21bda421e 100644 --- a/modules/brk-client/docs/interfaces/PeriodLumpSumStackPattern.md +++ b/modules/brk-client/docs/interfaces/PeriodLumpSumStackPattern.md @@ -6,7 +6,7 @@ # Interface: PeriodLumpSumStackPattern -Defined in: [Developer/brk/modules/brk-client/index.js:2682](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2682) +Defined in: [Developer/brk/modules/brk-client/index.js:1878](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1878) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2682](https://github.com/ > **\_10y**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2683](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2683) +Defined in: [Developer/brk/modules/brk-client/index.js:1879](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1879) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2683](https://github.com/ > **\_1m**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2684](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2684) +Defined in: [Developer/brk/modules/brk-client/index.js:1880](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1880) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2684](https://github.com/ > **\_1w**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2685](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2685) +Defined in: [Developer/brk/modules/brk-client/index.js:1881](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1881) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2685](https://github.com/ > **\_1y**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2686](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2686) +Defined in: [Developer/brk/modules/brk-client/index.js:1882](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1882) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2686](https://github.com/ > **\_2y**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2687](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2687) +Defined in: [Developer/brk/modules/brk-client/index.js:1883](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1883) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2687](https://github.com/ > **\_3m**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2688](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2688) +Defined in: [Developer/brk/modules/brk-client/index.js:1884](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1884) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2688](https://github.com/ > **\_3y**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2689](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2689) +Defined in: [Developer/brk/modules/brk-client/index.js:1885](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1885) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2689](https://github.com/ > **\_4y**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2690](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2690) +Defined in: [Developer/brk/modules/brk-client/index.js:1886](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1886) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2690](https://github.com/ > **\_5y**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2691](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2691) +Defined in: [Developer/brk/modules/brk-client/index.js:1887](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1887) *** @@ -86,7 +86,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2691](https://github.com/ > **\_6m**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2692](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2692) +Defined in: [Developer/brk/modules/brk-client/index.js:1888](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1888) *** @@ -94,7 +94,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2692](https://github.com/ > **\_6y**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2693](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2693) +Defined in: [Developer/brk/modules/brk-client/index.js:1889](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1889) *** @@ -102,4 +102,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2693](https://github.com/ > **\_8y**: [`_2015Pattern`](2015Pattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2694](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2694) +Defined in: [Developer/brk/modules/brk-client/index.js:1890](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1890) diff --git a/modules/brk-client/docs/interfaces/PoolBlockCounts.md b/modules/brk-client/docs/interfaces/PoolBlockCounts.md index 1698c05ce..e11b981c4 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:332](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L332) +Defined in: [Developer/brk/modules/brk-client/index.js:498](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L498) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:332](https://github.com/b > **\_1w**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:333](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L333) +Defined in: [Developer/brk/modules/brk-client/index.js:501](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L501) + +Blocks mined in last week *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:333](https://github.com/b > **\_24h**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:334](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L334) +Defined in: [Developer/brk/modules/brk-client/index.js:500](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L500) + +Blocks mined in last 24 hours *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:334](https://github.com/b > **all**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:335](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L335) +Defined in: [Developer/brk/modules/brk-client/index.js:499](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L499) + +Total blocks mined (all time) diff --git a/modules/brk-client/docs/interfaces/PoolBlockShares.md b/modules/brk-client/docs/interfaces/PoolBlockShares.md index dff2583ba..1a2ef2e5b 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:338](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L338) +Defined in: [Developer/brk/modules/brk-client/index.js:506](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L506) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:338](https://github.com/b > **\_1w**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:339](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L339) +Defined in: [Developer/brk/modules/brk-client/index.js:509](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L509) + +Share of blocks in last week *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:339](https://github.com/b > **\_24h**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:340](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L340) +Defined in: [Developer/brk/modules/brk-client/index.js:508](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L508) + +Share of blocks in last 24 hours *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:340](https://github.com/b > **all**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:341](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L341) +Defined in: [Developer/brk/modules/brk-client/index.js:507](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L507) + +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 3d0a9827b..228e5abc6 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:344](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L344) +Defined in: [Developer/brk/modules/brk-client/index.js:514](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L514) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:344](https://github.com/b > **blockCount**: [`PoolBlockCounts`](PoolBlockCounts.md) -Defined in: [Developer/brk/modules/brk-client/index.js:345](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L345) +Defined in: [Developer/brk/modules/brk-client/index.js:516](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L516) + +Block counts for different time periods *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:345](https://github.com/b > **blockShare**: [`PoolBlockShares`](PoolBlockShares.md) -Defined in: [Developer/brk/modules/brk-client/index.js:346](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L346) +Defined in: [Developer/brk/modules/brk-client/index.js:517](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L517) + +Pool's share of total blocks for different time periods *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:346](https://github.com/b > **estimatedHashrate**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:347](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L347) +Defined in: [Developer/brk/modules/brk-client/index.js:518](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L518) + +Estimated hashrate based on blocks mined *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:347](https://github.com/b > **pool**: [`PoolDetailInfo`](PoolDetailInfo.md) -Defined in: [Developer/brk/modules/brk-client/index.js:348](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L348) +Defined in: [Developer/brk/modules/brk-client/index.js:515](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L515) + +Pool information *** @@ -46,4 +54,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:348](https://github.com/b > `optional` **reportedHashrate**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:349](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L349) +Defined in: [Developer/brk/modules/brk-client/index.js:519](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L519) + +Self-reported hashrate (if available) diff --git a/modules/brk-client/docs/interfaces/PoolDetailInfo.md b/modules/brk-client/docs/interfaces/PoolDetailInfo.md index 8ee7dbbfe..7f1ec6010 100644 --- a/modules/brk-client/docs/interfaces/PoolDetailInfo.md +++ b/modules/brk-client/docs/interfaces/PoolDetailInfo.md @@ -6,7 +6,7 @@ # Interface: PoolDetailInfo -Defined in: [Developer/brk/modules/brk-client/index.js:352](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L352) +Defined in: [Developer/brk/modules/brk-client/index.js:524](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L524) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:352](https://github.com/b > **addresses**: `string`[] -Defined in: [Developer/brk/modules/brk-client/index.js:353](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L353) +Defined in: [Developer/brk/modules/brk-client/index.js:528](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L528) + +Known payout addresses *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:353](https://github.com/b > **id**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:354](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L354) +Defined in: [Developer/brk/modules/brk-client/index.js:525](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L525) + +Unique pool identifier *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:354](https://github.com/b > **link**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:355](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L355) +Defined in: [Developer/brk/modules/brk-client/index.js:527](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L527) + +Pool website URL *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:355](https://github.com/b > **name**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:356](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L356) +Defined in: [Developer/brk/modules/brk-client/index.js:526](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L526) + +Pool name *** @@ -46,7 +54,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:356](https://github.com/b > **regexes**: `string`[] -Defined in: [Developer/brk/modules/brk-client/index.js:357](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L357) +Defined in: [Developer/brk/modules/brk-client/index.js:529](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L529) + +Coinbase tag patterns (regexes) *** @@ -54,4 +64,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:357](https://github.com/b > **slug**: [`PoolSlug`](../type-aliases/PoolSlug.md) -Defined in: [Developer/brk/modules/brk-client/index.js:358](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L358) +Defined in: [Developer/brk/modules/brk-client/index.js:530](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L530) + +URL-friendly pool identifier diff --git a/modules/brk-client/docs/interfaces/PoolInfo.md b/modules/brk-client/docs/interfaces/PoolInfo.md index 3e3f83692..a3b3bf027 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:361](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L361) +Defined in: [Developer/brk/modules/brk-client/index.js:535](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L535) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:361](https://github.com/b > **name**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:362](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L362) +Defined in: [Developer/brk/modules/brk-client/index.js:536](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L536) + +Pool name *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:362](https://github.com/b > **slug**: [`PoolSlug`](../type-aliases/PoolSlug.md) -Defined in: [Developer/brk/modules/brk-client/index.js:363](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L363) +Defined in: [Developer/brk/modules/brk-client/index.js:537](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L537) + +URL-friendly pool identifier *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:363](https://github.com/b > **uniqueId**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:364](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L364) +Defined in: [Developer/brk/modules/brk-client/index.js:538](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L538) + +Unique numeric pool identifier diff --git a/modules/brk-client/docs/interfaces/PoolSlugParam.md b/modules/brk-client/docs/interfaces/PoolSlugParam.md index 6a3610ed5..5adbab4e0 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:368](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L368) +Defined in: [Developer/brk/modules/brk-client/index.js:542](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L542) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:368](https://github.com/b > **slug**: [`PoolSlug`](../type-aliases/PoolSlug.md) -Defined in: [Developer/brk/modules/brk-client/index.js:369](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L369) +Defined in: [Developer/brk/modules/brk-client/index.js:543](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L543) diff --git a/modules/brk-client/docs/interfaces/PoolStats.md b/modules/brk-client/docs/interfaces/PoolStats.md index ddbfd62c7..5a8866333 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:372](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L372) +Defined in: [Developer/brk/modules/brk-client/index.js:548](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L548) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:372](https://github.com/b > **blockCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:373](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L373) +Defined in: [Developer/brk/modules/brk-client/index.js:552](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L552) + +Number of blocks mined in the time period *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:373](https://github.com/b > **emptyBlocks**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:374](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L374) +Defined in: [Developer/brk/modules/brk-client/index.js:554](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L554) + +Number of empty blocks mined *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:374](https://github.com/b > **link**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:375](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L375) +Defined in: [Developer/brk/modules/brk-client/index.js:551](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L551) + +Pool website URL *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:375](https://github.com/b > **name**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:376](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L376) +Defined in: [Developer/brk/modules/brk-client/index.js:550](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L550) + +Pool name *** @@ -46,7 +54,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:376](https://github.com/b > **poolId**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:377](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L377) +Defined in: [Developer/brk/modules/brk-client/index.js:549](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L549) + +Unique pool identifier *** @@ -54,7 +64,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:377](https://github.com/b > **rank**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:378](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L378) +Defined in: [Developer/brk/modules/brk-client/index.js:553](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L553) + +Pool ranking by block count (1 = most blocks) *** @@ -62,7 +74,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:378](https://github.com/b > **share**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:379](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L379) +Defined in: [Developer/brk/modules/brk-client/index.js:556](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L556) + +Pool's share of total blocks (0.0 - 1.0) *** @@ -70,4 +84,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:379](https://github.com/b > **slug**: [`PoolSlug`](../type-aliases/PoolSlug.md) -Defined in: [Developer/brk/modules/brk-client/index.js:380](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L380) +Defined in: [Developer/brk/modules/brk-client/index.js:555](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L555) + +URL-friendly pool identifier diff --git a/modules/brk-client/docs/interfaces/PoolsSummary.md b/modules/brk-client/docs/interfaces/PoolsSummary.md index a9a680e72..23f7debb4 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:383](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L383) +Defined in: [Developer/brk/modules/brk-client/index.js:561](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L561) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:383](https://github.com/b > **blockCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:384](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L384) +Defined in: [Developer/brk/modules/brk-client/index.js:563](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L563) + +Total blocks in the time period *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:384](https://github.com/b > **lastEstimatedHashrate**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:385](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L385) +Defined in: [Developer/brk/modules/brk-client/index.js:564](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L564) + +Estimated network hashrate (hashes per second) *** @@ -30,4 +34,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:385](https://github.com/b > **pools**: [`PoolStats`](PoolStats.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:386](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L386) +Defined in: [Developer/brk/modules/brk-client/index.js:562](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L562) + +List of pools sorted by block count descending diff --git a/modules/brk-client/docs/interfaces/Price111dSmaPattern.md b/modules/brk-client/docs/interfaces/Price111dSmaPattern.md index 0de7bb5bc..77a6d4996 100644 --- a/modules/brk-client/docs/interfaces/Price111dSmaPattern.md +++ b/modules/brk-client/docs/interfaces/Price111dSmaPattern.md @@ -6,7 +6,7 @@ # Interface: Price111dSmaPattern -Defined in: [Developer/brk/modules/brk-client/index.js:2333](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2333) +Defined in: [Developer/brk/modules/brk-client/index.js:1580](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1580) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2333](https://github.com/ > **price**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2334](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2334) +Defined in: [Developer/brk/modules/brk-client/index.js:1581](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1581) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2334](https://github.com/ > **ratio**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2335](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2335) +Defined in: [Developer/brk/modules/brk-client/index.js:1582](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1582) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2335](https://github.com/ > **ratio1mSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2336](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2336) +Defined in: [Developer/brk/modules/brk-client/index.js:1583](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1583) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2336](https://github.com/ > **ratio1wSma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2337](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2337) +Defined in: [Developer/brk/modules/brk-client/index.js:1584](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1584) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2337](https://github.com/ > **ratio1ySd**: [`Ratio1ySdPattern`](Ratio1ySdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2338](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2338) +Defined in: [Developer/brk/modules/brk-client/index.js:1585](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1585) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2338](https://github.com/ > **ratio2ySd**: [`Ratio1ySdPattern`](Ratio1ySdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2339](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2339) +Defined in: [Developer/brk/modules/brk-client/index.js:1586](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1586) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2339](https://github.com/ > **ratio4ySd**: [`Ratio1ySdPattern`](Ratio1ySdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2340](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2340) +Defined in: [Developer/brk/modules/brk-client/index.js:1587](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1587) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2340](https://github.com/ > **ratioPct1**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2341](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2341) +Defined in: [Developer/brk/modules/brk-client/index.js:1588](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1588) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2341](https://github.com/ > **ratioPct1Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2342](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2342) +Defined in: [Developer/brk/modules/brk-client/index.js:1589](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1589) *** @@ -86,7 +86,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2342](https://github.com/ > **ratioPct2**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2343](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2343) +Defined in: [Developer/brk/modules/brk-client/index.js:1590](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1590) *** @@ -94,7 +94,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2343](https://github.com/ > **ratioPct2Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2344](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2344) +Defined in: [Developer/brk/modules/brk-client/index.js:1591](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1591) *** @@ -102,7 +102,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2344](https://github.com/ > **ratioPct5**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2345](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2345) +Defined in: [Developer/brk/modules/brk-client/index.js:1592](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1592) *** @@ -110,7 +110,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2345](https://github.com/ > **ratioPct5Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2346](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2346) +Defined in: [Developer/brk/modules/brk-client/index.js:1593](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1593) *** @@ -118,7 +118,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2346](https://github.com/ > **ratioPct95**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2347](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2347) +Defined in: [Developer/brk/modules/brk-client/index.js:1594](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1594) *** @@ -126,7 +126,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2347](https://github.com/ > **ratioPct95Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2348](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2348) +Defined in: [Developer/brk/modules/brk-client/index.js:1595](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1595) *** @@ -134,7 +134,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2348](https://github.com/ > **ratioPct98**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2349](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2349) +Defined in: [Developer/brk/modules/brk-client/index.js:1596](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1596) *** @@ -142,7 +142,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2349](https://github.com/ > **ratioPct98Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2350](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2350) +Defined in: [Developer/brk/modules/brk-client/index.js:1597](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1597) *** @@ -150,7 +150,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2350](https://github.com/ > **ratioPct99**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2351](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2351) +Defined in: [Developer/brk/modules/brk-client/index.js:1598](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1598) *** @@ -158,7 +158,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2351](https://github.com/ > **ratioPct99Usd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2352](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2352) +Defined in: [Developer/brk/modules/brk-client/index.js:1599](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1599) *** @@ -166,4 +166,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2352](https://github.com/ > **ratioSd**: [`Ratio1ySdPattern`](Ratio1ySdPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2353](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2353) +Defined in: [Developer/brk/modules/brk-client/index.js:1600](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1600) diff --git a/modules/brk-client/docs/interfaces/PriceAgoPattern.md b/modules/brk-client/docs/interfaces/PriceAgoPattern.md deleted file mode 100644 index ca19b3c97..000000000 --- a/modules/brk-client/docs/interfaces/PriceAgoPattern.md +++ /dev/null @@ -1,119 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / PriceAgoPattern - -# Interface: PriceAgoPattern\ - -Defined in: [Developer/brk/modules/brk-client/index.js:2640](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2640) - -## Type Parameters - -### T - -`T` - -## Properties - -### \_10y - -> **\_10y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2641](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2641) - -*** - -### \_1d - -> **\_1d**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2642](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2642) - -*** - -### \_1m - -> **\_1m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2643](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2643) - -*** - -### \_1w - -> **\_1w**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2644](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2644) - -*** - -### \_1y - -> **\_1y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2645](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2645) - -*** - -### \_2y - -> **\_2y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2646](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2646) - -*** - -### \_3m - -> **\_3m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2647](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2647) - -*** - -### \_3y - -> **\_3y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2648](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2648) - -*** - -### \_4y - -> **\_4y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2649](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2649) - -*** - -### \_5y - -> **\_5y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2650](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2650) - -*** - -### \_6m - -> **\_6m**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2651](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2651) - -*** - -### \_6y - -> **\_6y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2652](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2652) - -*** - -### \_8y - -> **\_8y**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`T`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:2653](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2653) diff --git a/modules/brk-client/docs/interfaces/RangeBuilder.md b/modules/brk-client/docs/interfaces/RangeBuilder.md new file mode 100644 index 000000000..7147be1e0 --- /dev/null +++ b/modules/brk-client/docs/interfaces/RangeBuilder.md @@ -0,0 +1,59 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / RangeBuilder + +# Interface: RangeBuilder\ + +Defined in: [Developer/brk/modules/brk-client/index.js:880](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L880) + +## Type Parameters + +### T + +`T` + +## Properties + +### fetch() + +> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:881](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L881) + +Fetch the range + +#### Parameters + +##### onUpdate? + +(`value`) => `void` + +#### Returns + +`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> + +*** + +### fetchCsv() + +> **fetchCsv**: () => `Promise`\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:882](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L882) + +Fetch as CSV + +#### Returns + +`Promise`\<`string`\> + +*** + +### then + +> **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:883](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L883) + +Thenable diff --git a/modules/brk-client/docs/interfaces/Ratio1ySdPattern.md b/modules/brk-client/docs/interfaces/Ratio1ySdPattern.md index 9d4062361..812eeae86 100644 --- a/modules/brk-client/docs/interfaces/Ratio1ySdPattern.md +++ b/modules/brk-client/docs/interfaces/Ratio1ySdPattern.md @@ -6,7 +6,7 @@ # Interface: Ratio1ySdPattern -Defined in: [Developer/brk/modules/brk-client/index.js:2044](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2044) +Defined in: [Developer/brk/modules/brk-client/index.js:1375](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1375) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2044](https://github.com/ > **\_0sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2045](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2045) +Defined in: [Developer/brk/modules/brk-client/index.js:1376](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1376) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2045](https://github.com/ > **m05sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2046](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2046) +Defined in: [Developer/brk/modules/brk-client/index.js:1377](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1377) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2046](https://github.com/ > **m05sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2047](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2047) +Defined in: [Developer/brk/modules/brk-client/index.js:1378](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1378) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2047](https://github.com/ > **m15sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2048](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2048) +Defined in: [Developer/brk/modules/brk-client/index.js:1379](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1379) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2048](https://github.com/ > **m15sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2049](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2049) +Defined in: [Developer/brk/modules/brk-client/index.js:1380](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1380) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2049](https://github.com/ > **m1sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2050](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2050) +Defined in: [Developer/brk/modules/brk-client/index.js:1381](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1381) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2050](https://github.com/ > **m1sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2051](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2051) +Defined in: [Developer/brk/modules/brk-client/index.js:1382](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1382) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2051](https://github.com/ > **m25sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2052](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2052) +Defined in: [Developer/brk/modules/brk-client/index.js:1383](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1383) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2052](https://github.com/ > **m25sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2053](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2053) +Defined in: [Developer/brk/modules/brk-client/index.js:1384](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1384) *** @@ -86,7 +86,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2053](https://github.com/ > **m2sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2054](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2054) +Defined in: [Developer/brk/modules/brk-client/index.js:1385](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1385) *** @@ -94,7 +94,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2054](https://github.com/ > **m2sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2055](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2055) +Defined in: [Developer/brk/modules/brk-client/index.js:1386](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1386) *** @@ -102,7 +102,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2055](https://github.com/ > **m3sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2056](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2056) +Defined in: [Developer/brk/modules/brk-client/index.js:1387](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1387) *** @@ -110,7 +110,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2056](https://github.com/ > **m3sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2057](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2057) +Defined in: [Developer/brk/modules/brk-client/index.js:1388](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1388) *** @@ -118,7 +118,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2057](https://github.com/ > **p05sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2058](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2058) +Defined in: [Developer/brk/modules/brk-client/index.js:1389](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1389) *** @@ -126,7 +126,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2058](https://github.com/ > **p05sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2059](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2059) +Defined in: [Developer/brk/modules/brk-client/index.js:1390](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1390) *** @@ -134,7 +134,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2059](https://github.com/ > **p15sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2060](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2060) +Defined in: [Developer/brk/modules/brk-client/index.js:1391](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1391) *** @@ -142,7 +142,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2060](https://github.com/ > **p15sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2061](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2061) +Defined in: [Developer/brk/modules/brk-client/index.js:1392](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1392) *** @@ -150,7 +150,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2061](https://github.com/ > **p1sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2062](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2062) +Defined in: [Developer/brk/modules/brk-client/index.js:1393](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1393) *** @@ -158,7 +158,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2062](https://github.com/ > **p1sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2063](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2063) +Defined in: [Developer/brk/modules/brk-client/index.js:1394](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1394) *** @@ -166,7 +166,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2063](https://github.com/ > **p25sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2064](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2064) +Defined in: [Developer/brk/modules/brk-client/index.js:1395](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1395) *** @@ -174,7 +174,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2064](https://github.com/ > **p25sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2065](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2065) +Defined in: [Developer/brk/modules/brk-client/index.js:1396](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1396) *** @@ -182,7 +182,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2065](https://github.com/ > **p2sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2066](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2066) +Defined in: [Developer/brk/modules/brk-client/index.js:1397](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1397) *** @@ -190,7 +190,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2066](https://github.com/ > **p2sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2067](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2067) +Defined in: [Developer/brk/modules/brk-client/index.js:1398](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1398) *** @@ -198,7 +198,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2067](https://github.com/ > **p3sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2068](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2068) +Defined in: [Developer/brk/modules/brk-client/index.js:1399](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1399) *** @@ -206,7 +206,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2068](https://github.com/ > **p3sdUsd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2069](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2069) +Defined in: [Developer/brk/modules/brk-client/index.js:1400](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1400) *** @@ -214,7 +214,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2069](https://github.com/ > **sd**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2070](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2070) +Defined in: [Developer/brk/modules/brk-client/index.js:1401](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1401) *** @@ -222,7 +222,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2070](https://github.com/ > **sma**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2071](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2071) +Defined in: [Developer/brk/modules/brk-client/index.js:1402](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1402) *** @@ -230,4 +230,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2071](https://github.com/ > **zscore**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2072](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2072) +Defined in: [Developer/brk/modules/brk-client/index.js:1403](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1403) diff --git a/modules/brk-client/docs/interfaces/RealizedPattern.md b/modules/brk-client/docs/interfaces/RealizedPattern.md index 40c69949e..2c57e3cc7 100644 --- a/modules/brk-client/docs/interfaces/RealizedPattern.md +++ b/modules/brk-client/docs/interfaces/RealizedPattern.md @@ -6,7 +6,7 @@ # Interface: RealizedPattern -Defined in: [Developer/brk/modules/brk-client/index.js:2229](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2229) +Defined in: [Developer/brk/modules/brk-client/index.js:1515](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1515) ## Properties @@ -14,15 +14,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2229](https://github.com/ > **mvrv**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2230](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2230) +Defined in: [Developer/brk/modules/brk-client/index.js:1516](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1516) *** ### negRealizedLoss -> **negRealizedLoss**: [`BitcoinPattern`](BitcoinPattern.md)\<`number`\> +> **negRealizedLoss**: [`BitcoinPattern2`](BitcoinPattern2.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2231](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2231) +Defined in: [Developer/brk/modules/brk-client/index.js:1517](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1517) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2231](https://github.com/ > **netRealizedPnl**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2232](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2232) +Defined in: [Developer/brk/modules/brk-client/index.js:1518](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1518) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2232](https://github.com/ > **netRealizedPnlCumulative30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2233](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2233) +Defined in: [Developer/brk/modules/brk-client/index.js:1519](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1519) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2233](https://github.com/ > **netRealizedPnlCumulative30dDeltaRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2234](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2234) +Defined in: [Developer/brk/modules/brk-client/index.js:1520](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1520) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2234](https://github.com/ > **netRealizedPnlCumulative30dDeltaRelToRealizedCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2235](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2235) +Defined in: [Developer/brk/modules/brk-client/index.js:1521](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1521) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2235](https://github.com/ > **netRealizedPnlRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2236](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2236) +Defined in: [Developer/brk/modules/brk-client/index.js:1522](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1522) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2236](https://github.com/ > **realizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2237](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2237) +Defined in: [Developer/brk/modules/brk-client/index.js:1523](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1523) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2237](https://github.com/ > **realizedCap30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2238](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2238) +Defined in: [Developer/brk/modules/brk-client/index.js:1524](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1524) *** @@ -86,7 +86,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2238](https://github.com/ > **realizedLoss**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2239](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2239) +Defined in: [Developer/brk/modules/brk-client/index.js:1525](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1525) *** @@ -94,7 +94,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2239](https://github.com/ > **realizedLossRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2240](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2240) +Defined in: [Developer/brk/modules/brk-client/index.js:1526](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1526) *** @@ -102,7 +102,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2240](https://github.com/ > **realizedPrice**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2241](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2241) +Defined in: [Developer/brk/modules/brk-client/index.js:1527](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1527) *** @@ -110,7 +110,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2241](https://github.com/ > **realizedPriceExtra**: [`RealizedPriceExtraPattern`](RealizedPriceExtraPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2242](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2242) +Defined in: [Developer/brk/modules/brk-client/index.js:1528](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1528) *** @@ -118,7 +118,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2242](https://github.com/ > **realizedProfit**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2243](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2243) +Defined in: [Developer/brk/modules/brk-client/index.js:1529](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1529) *** @@ -126,7 +126,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2243](https://github.com/ > **realizedProfitRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2244](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2244) +Defined in: [Developer/brk/modules/brk-client/index.js:1530](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1530) *** @@ -134,7 +134,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2244](https://github.com/ > **realizedValue**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2245](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2245) +Defined in: [Developer/brk/modules/brk-client/index.js:1531](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1531) *** @@ -142,7 +142,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2245](https://github.com/ > **sellSideRiskRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2246](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2246) +Defined in: [Developer/brk/modules/brk-client/index.js:1532](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1532) *** @@ -150,7 +150,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2246](https://github.com/ > **sellSideRiskRatio30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2247](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2247) +Defined in: [Developer/brk/modules/brk-client/index.js:1533](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1533) *** @@ -158,7 +158,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2247](https://github.com/ > **sellSideRiskRatio7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2248](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2248) +Defined in: [Developer/brk/modules/brk-client/index.js:1534](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1534) *** @@ -166,7 +166,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2248](https://github.com/ > **sopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2249](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2249) +Defined in: [Developer/brk/modules/brk-client/index.js:1535](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1535) *** @@ -174,7 +174,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2249](https://github.com/ > **sopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2250](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2250) +Defined in: [Developer/brk/modules/brk-client/index.js:1536](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1536) *** @@ -182,7 +182,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2250](https://github.com/ > **sopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2251](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2251) +Defined in: [Developer/brk/modules/brk-client/index.js:1537](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1537) *** @@ -190,7 +190,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2251](https://github.com/ > **totalRealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2252](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2252) +Defined in: [Developer/brk/modules/brk-client/index.js:1538](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1538) *** @@ -198,7 +198,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2252](https://github.com/ > **valueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2253](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2253) +Defined in: [Developer/brk/modules/brk-client/index.js:1539](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1539) *** @@ -206,4 +206,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2253](https://github.com/ > **valueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2254](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2254) +Defined in: [Developer/brk/modules/brk-client/index.js:1540](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1540) diff --git a/modules/brk-client/docs/interfaces/RealizedPattern2.md b/modules/brk-client/docs/interfaces/RealizedPattern2.md index e7e32054e..815e8f7d6 100644 --- a/modules/brk-client/docs/interfaces/RealizedPattern2.md +++ b/modules/brk-client/docs/interfaces/RealizedPattern2.md @@ -6,7 +6,7 @@ # Interface: RealizedPattern2 -Defined in: [Developer/brk/modules/brk-client/index.js:2115](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2115) +Defined in: [Developer/brk/modules/brk-client/index.js:1446](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1446) ## Properties @@ -14,15 +14,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2115](https://github.com/ > **mvrv**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2116](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2116) +Defined in: [Developer/brk/modules/brk-client/index.js:1447](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1447) *** ### negRealizedLoss -> **negRealizedLoss**: [`BitcoinPattern`](BitcoinPattern.md)\<`number`\> +> **negRealizedLoss**: [`BitcoinPattern2`](BitcoinPattern2.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2117](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2117) +Defined in: [Developer/brk/modules/brk-client/index.js:1448](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1448) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2117](https://github.com/ > **netRealizedPnl**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2118](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2118) +Defined in: [Developer/brk/modules/brk-client/index.js:1449](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1449) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2118](https://github.com/ > **netRealizedPnlCumulative30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2119](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2119) +Defined in: [Developer/brk/modules/brk-client/index.js:1450](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1450) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2119](https://github.com/ > **netRealizedPnlCumulative30dDeltaRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2120](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2120) +Defined in: [Developer/brk/modules/brk-client/index.js:1451](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1451) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2120](https://github.com/ > **netRealizedPnlCumulative30dDeltaRelToRealizedCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2121](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2121) +Defined in: [Developer/brk/modules/brk-client/index.js:1452](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1452) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2121](https://github.com/ > **netRealizedPnlRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2122](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2122) +Defined in: [Developer/brk/modules/brk-client/index.js:1453](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1453) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2122](https://github.com/ > **realizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2123](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2123) +Defined in: [Developer/brk/modules/brk-client/index.js:1454](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1454) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2123](https://github.com/ > **realizedCap30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2124](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2124) +Defined in: [Developer/brk/modules/brk-client/index.js:1455](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1455) *** @@ -86,7 +86,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2124](https://github.com/ > **realizedCapRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2125](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2125) +Defined in: [Developer/brk/modules/brk-client/index.js:1456](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1456) *** @@ -94,7 +94,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2125](https://github.com/ > **realizedLoss**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2126](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2126) +Defined in: [Developer/brk/modules/brk-client/index.js:1457](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1457) *** @@ -102,7 +102,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2126](https://github.com/ > **realizedLossRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2127](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2127) +Defined in: [Developer/brk/modules/brk-client/index.js:1458](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1458) *** @@ -110,7 +110,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2127](https://github.com/ > **realizedPrice**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2128](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2128) +Defined in: [Developer/brk/modules/brk-client/index.js:1459](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1459) *** @@ -118,7 +118,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2128](https://github.com/ > **realizedPriceExtra**: [`ActivePriceRatioPattern`](ActivePriceRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:2129](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2129) +Defined in: [Developer/brk/modules/brk-client/index.js:1460](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1460) *** @@ -126,7 +126,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2129](https://github.com/ > **realizedProfit**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2130](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2130) +Defined in: [Developer/brk/modules/brk-client/index.js:1461](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1461) *** @@ -134,7 +134,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2130](https://github.com/ > **realizedProfitRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2131](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2131) +Defined in: [Developer/brk/modules/brk-client/index.js:1462](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1462) *** @@ -142,7 +142,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2131](https://github.com/ > **realizedProfitToLossRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2132](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2132) +Defined in: [Developer/brk/modules/brk-client/index.js:1463](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1463) *** @@ -150,7 +150,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2132](https://github.com/ > **realizedValue**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2133](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2133) +Defined in: [Developer/brk/modules/brk-client/index.js:1464](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1464) *** @@ -158,7 +158,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2133](https://github.com/ > **sellSideRiskRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2134](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2134) +Defined in: [Developer/brk/modules/brk-client/index.js:1465](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1465) *** @@ -166,7 +166,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2134](https://github.com/ > **sellSideRiskRatio30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2135](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2135) +Defined in: [Developer/brk/modules/brk-client/index.js:1466](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1466) *** @@ -174,7 +174,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2135](https://github.com/ > **sellSideRiskRatio7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2136](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2136) +Defined in: [Developer/brk/modules/brk-client/index.js:1467](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1467) *** @@ -182,7 +182,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2136](https://github.com/ > **sopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2137](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2137) +Defined in: [Developer/brk/modules/brk-client/index.js:1468](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1468) *** @@ -190,7 +190,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2137](https://github.com/ > **sopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2138](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2138) +Defined in: [Developer/brk/modules/brk-client/index.js:1469](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1469) *** @@ -198,7 +198,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2138](https://github.com/ > **sopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2139](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2139) +Defined in: [Developer/brk/modules/brk-client/index.js:1470](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1470) *** @@ -206,7 +206,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2139](https://github.com/ > **totalRealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2140](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2140) +Defined in: [Developer/brk/modules/brk-client/index.js:1471](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1471) *** @@ -214,7 +214,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2140](https://github.com/ > **valueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2141](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2141) +Defined in: [Developer/brk/modules/brk-client/index.js:1472](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1472) *** @@ -222,4 +222,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2141](https://github.com/ > **valueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2142](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2142) +Defined in: [Developer/brk/modules/brk-client/index.js:1473](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1473) diff --git a/modules/brk-client/docs/interfaces/RealizedPattern3.md b/modules/brk-client/docs/interfaces/RealizedPattern3.md index 61f73a95b..553187811 100644 --- a/modules/brk-client/docs/interfaces/RealizedPattern3.md +++ b/modules/brk-client/docs/interfaces/RealizedPattern3.md @@ -6,7 +6,7 @@ # Interface: RealizedPattern3 -Defined in: [Developer/brk/modules/brk-client/index.js:1782](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1782) +Defined in: [Developer/brk/modules/brk-client/index.js:1221](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1221) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1782](https://github.com/ > **adjustedSopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1783](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1783) +Defined in: [Developer/brk/modules/brk-client/index.js:1222](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1222) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1783](https://github.com/ > **adjustedSopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1784](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1784) +Defined in: [Developer/brk/modules/brk-client/index.js:1223](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1223) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1784](https://github.com/ > **adjustedSopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1785](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1785) +Defined in: [Developer/brk/modules/brk-client/index.js:1224](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1224) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1785](https://github.com/ > **adjustedValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1786](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1786) +Defined in: [Developer/brk/modules/brk-client/index.js:1225](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1225) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1786](https://github.com/ > **adjustedValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1787](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1787) +Defined in: [Developer/brk/modules/brk-client/index.js:1226](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1226) *** @@ -54,15 +54,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1787](https://github.com/ > **mvrv**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1788](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1788) +Defined in: [Developer/brk/modules/brk-client/index.js:1227](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1227) *** ### negRealizedLoss -> **negRealizedLoss**: [`BitcoinPattern`](BitcoinPattern.md)\<`number`\> +> **negRealizedLoss**: [`BitcoinPattern2`](BitcoinPattern2.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1789](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1789) +Defined in: [Developer/brk/modules/brk-client/index.js:1228](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1228) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1789](https://github.com/ > **netRealizedPnl**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1790](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1790) +Defined in: [Developer/brk/modules/brk-client/index.js:1229](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1229) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1790](https://github.com/ > **netRealizedPnlCumulative30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1791](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1791) +Defined in: [Developer/brk/modules/brk-client/index.js:1230](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1230) *** @@ -86,7 +86,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1791](https://github.com/ > **netRealizedPnlCumulative30dDeltaRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1792](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1792) +Defined in: [Developer/brk/modules/brk-client/index.js:1231](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1231) *** @@ -94,7 +94,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1792](https://github.com/ > **netRealizedPnlCumulative30dDeltaRelToRealizedCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1793](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1793) +Defined in: [Developer/brk/modules/brk-client/index.js:1232](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1232) *** @@ -102,7 +102,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1793](https://github.com/ > **netRealizedPnlRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1794](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1794) +Defined in: [Developer/brk/modules/brk-client/index.js:1233](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1233) *** @@ -110,7 +110,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1794](https://github.com/ > **realizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1795](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1795) +Defined in: [Developer/brk/modules/brk-client/index.js:1234](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1234) *** @@ -118,7 +118,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1795](https://github.com/ > **realizedCap30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1796](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1796) +Defined in: [Developer/brk/modules/brk-client/index.js:1235](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1235) *** @@ -126,7 +126,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1796](https://github.com/ > **realizedCapRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1797](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1797) +Defined in: [Developer/brk/modules/brk-client/index.js:1236](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1236) *** @@ -134,7 +134,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1797](https://github.com/ > **realizedLoss**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1798](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1798) +Defined in: [Developer/brk/modules/brk-client/index.js:1237](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1237) *** @@ -142,7 +142,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1798](https://github.com/ > **realizedLossRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1799](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1799) +Defined in: [Developer/brk/modules/brk-client/index.js:1238](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1238) *** @@ -150,7 +150,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1799](https://github.com/ > **realizedPrice**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1800](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1800) +Defined in: [Developer/brk/modules/brk-client/index.js:1239](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1239) *** @@ -158,7 +158,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1800](https://github.com/ > **realizedPriceExtra**: [`ActivePriceRatioPattern`](ActivePriceRatioPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:1801](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1801) +Defined in: [Developer/brk/modules/brk-client/index.js:1240](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1240) *** @@ -166,7 +166,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1801](https://github.com/ > **realizedProfit**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1802](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1802) +Defined in: [Developer/brk/modules/brk-client/index.js:1241](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1241) *** @@ -174,7 +174,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1802](https://github.com/ > **realizedProfitRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1803](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1803) +Defined in: [Developer/brk/modules/brk-client/index.js:1242](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1242) *** @@ -182,7 +182,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1803](https://github.com/ > **realizedProfitToLossRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1804](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1804) +Defined in: [Developer/brk/modules/brk-client/index.js:1243](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1243) *** @@ -190,7 +190,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1804](https://github.com/ > **realizedValue**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1805](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1805) +Defined in: [Developer/brk/modules/brk-client/index.js:1244](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1244) *** @@ -198,7 +198,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1805](https://github.com/ > **sellSideRiskRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1806](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1806) +Defined in: [Developer/brk/modules/brk-client/index.js:1245](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1245) *** @@ -206,7 +206,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1806](https://github.com/ > **sellSideRiskRatio30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1807](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1807) +Defined in: [Developer/brk/modules/brk-client/index.js:1246](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1246) *** @@ -214,7 +214,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1807](https://github.com/ > **sellSideRiskRatio7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1808](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1808) +Defined in: [Developer/brk/modules/brk-client/index.js:1247](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1247) *** @@ -222,7 +222,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1808](https://github.com/ > **sopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1809](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1809) +Defined in: [Developer/brk/modules/brk-client/index.js:1248](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1248) *** @@ -230,7 +230,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1809](https://github.com/ > **sopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1810](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1810) +Defined in: [Developer/brk/modules/brk-client/index.js:1249](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1249) *** @@ -238,7 +238,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1810](https://github.com/ > **sopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1811](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1811) +Defined in: [Developer/brk/modules/brk-client/index.js:1250](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1250) *** @@ -246,7 +246,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1811](https://github.com/ > **totalRealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1812](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1812) +Defined in: [Developer/brk/modules/brk-client/index.js:1251](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1251) *** @@ -254,7 +254,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1812](https://github.com/ > **valueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1813](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1813) +Defined in: [Developer/brk/modules/brk-client/index.js:1252](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1252) *** @@ -262,4 +262,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1813](https://github.com/ > **valueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1814](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1814) +Defined in: [Developer/brk/modules/brk-client/index.js:1253](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1253) diff --git a/modules/brk-client/docs/interfaces/RealizedPattern4.md b/modules/brk-client/docs/interfaces/RealizedPattern4.md index 4693b0279..f86ba2555 100644 --- a/modules/brk-client/docs/interfaces/RealizedPattern4.md +++ b/modules/brk-client/docs/interfaces/RealizedPattern4.md @@ -6,7 +6,7 @@ # Interface: RealizedPattern4 -Defined in: [Developer/brk/modules/brk-client/index.js:1918](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1918) +Defined in: [Developer/brk/modules/brk-client/index.js:1300](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1300) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1918](https://github.com/ > **adjustedSopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1919](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1919) +Defined in: [Developer/brk/modules/brk-client/index.js:1301](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1301) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1919](https://github.com/ > **adjustedSopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1920](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1920) +Defined in: [Developer/brk/modules/brk-client/index.js:1302](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1302) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1920](https://github.com/ > **adjustedSopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1921](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1921) +Defined in: [Developer/brk/modules/brk-client/index.js:1303](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1303) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1921](https://github.com/ > **adjustedValueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1922](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1922) +Defined in: [Developer/brk/modules/brk-client/index.js:1304](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1304) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1922](https://github.com/ > **adjustedValueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1923](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1923) +Defined in: [Developer/brk/modules/brk-client/index.js:1305](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1305) *** @@ -54,15 +54,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1923](https://github.com/ > **mvrv**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1924](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1924) +Defined in: [Developer/brk/modules/brk-client/index.js:1306](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1306) *** ### negRealizedLoss -> **negRealizedLoss**: [`BitcoinPattern`](BitcoinPattern.md)\<`number`\> +> **negRealizedLoss**: [`BitcoinPattern2`](BitcoinPattern2.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1925](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1925) +Defined in: [Developer/brk/modules/brk-client/index.js:1307](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1307) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1925](https://github.com/ > **netRealizedPnl**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1926](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1926) +Defined in: [Developer/brk/modules/brk-client/index.js:1308](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1308) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1926](https://github.com/ > **netRealizedPnlCumulative30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1927](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1927) +Defined in: [Developer/brk/modules/brk-client/index.js:1309](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1309) *** @@ -86,7 +86,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1927](https://github.com/ > **netRealizedPnlCumulative30dDeltaRelToMarketCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1928](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1928) +Defined in: [Developer/brk/modules/brk-client/index.js:1310](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1310) *** @@ -94,7 +94,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1928](https://github.com/ > **netRealizedPnlCumulative30dDeltaRelToRealizedCap**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1929](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1929) +Defined in: [Developer/brk/modules/brk-client/index.js:1311](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1311) *** @@ -102,7 +102,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1929](https://github.com/ > **netRealizedPnlRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1930](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1930) +Defined in: [Developer/brk/modules/brk-client/index.js:1312](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1312) *** @@ -110,7 +110,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1930](https://github.com/ > **realizedCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1931](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1931) +Defined in: [Developer/brk/modules/brk-client/index.js:1313](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1313) *** @@ -118,7 +118,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1931](https://github.com/ > **realizedCap30dDelta**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1932](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1932) +Defined in: [Developer/brk/modules/brk-client/index.js:1314](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1314) *** @@ -126,7 +126,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1932](https://github.com/ > **realizedLoss**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1933](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1933) +Defined in: [Developer/brk/modules/brk-client/index.js:1315](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1315) *** @@ -134,7 +134,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1933](https://github.com/ > **realizedLossRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1934](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1934) +Defined in: [Developer/brk/modules/brk-client/index.js:1316](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1316) *** @@ -142,7 +142,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1934](https://github.com/ > **realizedPrice**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1935](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1935) +Defined in: [Developer/brk/modules/brk-client/index.js:1317](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1317) *** @@ -150,7 +150,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1935](https://github.com/ > **realizedPriceExtra**: [`RealizedPriceExtraPattern`](RealizedPriceExtraPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:1936](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1936) +Defined in: [Developer/brk/modules/brk-client/index.js:1318](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1318) *** @@ -158,7 +158,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1936](https://github.com/ > **realizedProfit**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1937](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1937) +Defined in: [Developer/brk/modules/brk-client/index.js:1319](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1319) *** @@ -166,7 +166,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1937](https://github.com/ > **realizedProfitRelToRealizedCap**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1938](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1938) +Defined in: [Developer/brk/modules/brk-client/index.js:1320](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1320) *** @@ -174,7 +174,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1938](https://github.com/ > **realizedValue**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1939](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1939) +Defined in: [Developer/brk/modules/brk-client/index.js:1321](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1321) *** @@ -182,7 +182,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1939](https://github.com/ > **sellSideRiskRatio**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1940](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1940) +Defined in: [Developer/brk/modules/brk-client/index.js:1322](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1322) *** @@ -190,7 +190,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1940](https://github.com/ > **sellSideRiskRatio30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1941](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1941) +Defined in: [Developer/brk/modules/brk-client/index.js:1323](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1323) *** @@ -198,7 +198,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1941](https://github.com/ > **sellSideRiskRatio7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1942](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1942) +Defined in: [Developer/brk/modules/brk-client/index.js:1324](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1324) *** @@ -206,7 +206,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1942](https://github.com/ > **sopr**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1943](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1943) +Defined in: [Developer/brk/modules/brk-client/index.js:1325](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1325) *** @@ -214,7 +214,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1943](https://github.com/ > **sopr30dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1944](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1944) +Defined in: [Developer/brk/modules/brk-client/index.js:1326](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1326) *** @@ -222,7 +222,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1944](https://github.com/ > **sopr7dEma**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1945](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1945) +Defined in: [Developer/brk/modules/brk-client/index.js:1327](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1327) *** @@ -230,7 +230,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1945](https://github.com/ > **totalRealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1946](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1946) +Defined in: [Developer/brk/modules/brk-client/index.js:1328](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1328) *** @@ -238,7 +238,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1946](https://github.com/ > **valueCreated**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1947](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1947) +Defined in: [Developer/brk/modules/brk-client/index.js:1329](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1329) *** @@ -246,4 +246,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1947](https://github.com/ > **valueDestroyed**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:1948](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1948) +Defined in: [Developer/brk/modules/brk-client/index.js:1330](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1330) diff --git a/modules/brk-client/docs/interfaces/RealizedPriceExtraPattern.md b/modules/brk-client/docs/interfaces/RealizedPriceExtraPattern.md index 6642a1527..135b6b839 100644 --- a/modules/brk-client/docs/interfaces/RealizedPriceExtraPattern.md +++ b/modules/brk-client/docs/interfaces/RealizedPriceExtraPattern.md @@ -6,7 +6,7 @@ # Interface: RealizedPriceExtraPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3702](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3702) +Defined in: [Developer/brk/modules/brk-client/index.js:2824](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2824) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3702](https://github.com/ > **ratio**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3703](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3703) +Defined in: [Developer/brk/modules/brk-client/index.js:2825](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2825) diff --git a/modules/brk-client/docs/interfaces/RecommendedFees.md b/modules/brk-client/docs/interfaces/RecommendedFees.md index 8cda3674c..9ffe4a4fb 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:391](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L391) +Defined in: [Developer/brk/modules/brk-client/index.js:575](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L575) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:391](https://github.com/b > **economyFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:392](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L392) +Defined in: [Developer/brk/modules/brk-client/index.js:579](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L579) + +Fee rate for economical confirmation *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:392](https://github.com/b > **fastestFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:393](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L393) +Defined in: [Developer/brk/modules/brk-client/index.js:576](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L576) + +Fee rate for fastest confirmation (next block) *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:393](https://github.com/b > **halfHourFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:394](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L394) +Defined in: [Developer/brk/modules/brk-client/index.js:577](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L577) + +Fee rate for confirmation within ~30 minutes (3 blocks) *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:394](https://github.com/b > **hourFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:395](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L395) +Defined in: [Developer/brk/modules/brk-client/index.js:578](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L578) + +Fee rate for confirmation within ~1 hour (6 blocks) *** @@ -46,4 +54,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:395](https://github.com/b > **minimumFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:396](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L396) +Defined in: [Developer/brk/modules/brk-client/index.js:580](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L580) + +Minimum relay fee rate diff --git a/modules/brk-client/docs/interfaces/RelativePattern.md b/modules/brk-client/docs/interfaces/RelativePattern.md index a4adb717e..1e22ed1bd 100644 --- a/modules/brk-client/docs/interfaces/RelativePattern.md +++ b/modules/brk-client/docs/interfaces/RelativePattern.md @@ -6,7 +6,7 @@ # Interface: RelativePattern -Defined in: [Developer/brk/modules/brk-client/index.js:2879](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2879) +Defined in: [Developer/brk/modules/brk-client/index.js:2108](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2108) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2879](https://github.com/ > **negUnrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2880](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2880) +Defined in: [Developer/brk/modules/brk-client/index.js:2109](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2109) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2880](https://github.com/ > **netUnrealizedPnlRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2881](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2881) +Defined in: [Developer/brk/modules/brk-client/index.js:2110](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2110) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2881](https://github.com/ > **nupl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2882](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2882) +Defined in: [Developer/brk/modules/brk-client/index.js:2111](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2111) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2882](https://github.com/ > **supplyInLossRelToCirculatingSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2883](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2883) +Defined in: [Developer/brk/modules/brk-client/index.js:2112](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2112) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2883](https://github.com/ > **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2884](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2884) +Defined in: [Developer/brk/modules/brk-client/index.js:2113](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2113) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2884](https://github.com/ > **supplyInProfitRelToCirculatingSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2885](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2885) +Defined in: [Developer/brk/modules/brk-client/index.js:2114](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2114) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2885](https://github.com/ > **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2886](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2886) +Defined in: [Developer/brk/modules/brk-client/index.js:2115](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2115) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2886](https://github.com/ > **supplyRelToCirculatingSupply**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2887](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2887) +Defined in: [Developer/brk/modules/brk-client/index.js:2116](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2116) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2887](https://github.com/ > **unrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2888](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2888) +Defined in: [Developer/brk/modules/brk-client/index.js:2117](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2117) *** @@ -86,4 +86,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2888](https://github.com/ > **unrealizedProfitRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2889](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2889) +Defined in: [Developer/brk/modules/brk-client/index.js:2118](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2118) diff --git a/modules/brk-client/docs/interfaces/RelativePattern2.md b/modules/brk-client/docs/interfaces/RelativePattern2.md index 16619694a..86ca60271 100644 --- a/modules/brk-client/docs/interfaces/RelativePattern2.md +++ b/modules/brk-client/docs/interfaces/RelativePattern2.md @@ -6,7 +6,7 @@ # Interface: RelativePattern2 -Defined in: [Developer/brk/modules/brk-client/index.js:2941](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2941) +Defined in: [Developer/brk/modules/brk-client/index.js:2073](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2073) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2941](https://github.com/ > **negUnrealizedLossRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2942](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2942) +Defined in: [Developer/brk/modules/brk-client/index.js:2074](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2074) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2942](https://github.com/ > **negUnrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2943](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2943) +Defined in: [Developer/brk/modules/brk-client/index.js:2075](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2075) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2943](https://github.com/ > **netUnrealizedPnlRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2944](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2944) +Defined in: [Developer/brk/modules/brk-client/index.js:2076](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2076) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2944](https://github.com/ > **netUnrealizedPnlRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2945](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2945) +Defined in: [Developer/brk/modules/brk-client/index.js:2077](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2077) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2945](https://github.com/ > **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2946](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2946) +Defined in: [Developer/brk/modules/brk-client/index.js:2078](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2078) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2946](https://github.com/ > **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2947](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2947) +Defined in: [Developer/brk/modules/brk-client/index.js:2079](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2079) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2947](https://github.com/ > **unrealizedLossRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2948](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2948) +Defined in: [Developer/brk/modules/brk-client/index.js:2080](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2080) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2948](https://github.com/ > **unrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2949](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2949) +Defined in: [Developer/brk/modules/brk-client/index.js:2081](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2081) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2949](https://github.com/ > **unrealizedProfitRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2950](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2950) +Defined in: [Developer/brk/modules/brk-client/index.js:2082](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2082) *** @@ -86,4 +86,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2950](https://github.com/ > **unrealizedProfitRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2951](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2951) +Defined in: [Developer/brk/modules/brk-client/index.js:2083](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2083) diff --git a/modules/brk-client/docs/interfaces/RelativePattern4.md b/modules/brk-client/docs/interfaces/RelativePattern4.md index ff9428fea..16f121bd3 100644 --- a/modules/brk-client/docs/interfaces/RelativePattern4.md +++ b/modules/brk-client/docs/interfaces/RelativePattern4.md @@ -6,7 +6,7 @@ # Interface: RelativePattern4 -Defined in: [Developer/brk/modules/brk-client/index.js:3578](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3578) +Defined in: [Developer/brk/modules/brk-client/index.js:2723](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2723) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3578](https://github.com/ > **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3579](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3579) +Defined in: [Developer/brk/modules/brk-client/index.js:2724](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2724) *** @@ -22,4 +22,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3579](https://github.com/ > **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3580](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3580) +Defined in: [Developer/brk/modules/brk-client/index.js:2725](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2725) diff --git a/modules/brk-client/docs/interfaces/RelativePattern5.md b/modules/brk-client/docs/interfaces/RelativePattern5.md index 5006ffa06..410d0f455 100644 --- a/modules/brk-client/docs/interfaces/RelativePattern5.md +++ b/modules/brk-client/docs/interfaces/RelativePattern5.md @@ -6,7 +6,7 @@ # Interface: RelativePattern5 -Defined in: [Developer/brk/modules/brk-client/index.js:2494](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2494) +Defined in: [Developer/brk/modules/brk-client/index.js:1741](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1741) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2494](https://github.com/ > **negUnrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2495](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2495) +Defined in: [Developer/brk/modules/brk-client/index.js:1742](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1742) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2495](https://github.com/ > **negUnrealizedLossRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2496](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2496) +Defined in: [Developer/brk/modules/brk-client/index.js:1743](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1743) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2496](https://github.com/ > **negUnrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2497](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2497) +Defined in: [Developer/brk/modules/brk-client/index.js:1744](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1744) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2497](https://github.com/ > **netUnrealizedPnlRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2498](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2498) +Defined in: [Developer/brk/modules/brk-client/index.js:1745](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1745) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2498](https://github.com/ > **netUnrealizedPnlRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2499](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2499) +Defined in: [Developer/brk/modules/brk-client/index.js:1746](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1746) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2499](https://github.com/ > **netUnrealizedPnlRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2500](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2500) +Defined in: [Developer/brk/modules/brk-client/index.js:1747](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1747) *** @@ -62,7 +62,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2500](https://github.com/ > **nupl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2501](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2501) +Defined in: [Developer/brk/modules/brk-client/index.js:1748](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1748) *** @@ -70,7 +70,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2501](https://github.com/ > **supplyInLossRelToCirculatingSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2502](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2502) +Defined in: [Developer/brk/modules/brk-client/index.js:1749](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1749) *** @@ -78,7 +78,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2502](https://github.com/ > **supplyInLossRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2503](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2503) +Defined in: [Developer/brk/modules/brk-client/index.js:1750](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1750) *** @@ -86,7 +86,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2503](https://github.com/ > **supplyInProfitRelToCirculatingSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2504](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2504) +Defined in: [Developer/brk/modules/brk-client/index.js:1751](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1751) *** @@ -94,7 +94,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2504](https://github.com/ > **supplyInProfitRelToOwnSupply**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2505](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2505) +Defined in: [Developer/brk/modules/brk-client/index.js:1752](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1752) *** @@ -102,7 +102,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2505](https://github.com/ > **supplyRelToCirculatingSupply**: [`MetricPattern4`](../type-aliases/MetricPattern4.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2506](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2506) +Defined in: [Developer/brk/modules/brk-client/index.js:1753](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1753) *** @@ -110,7 +110,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2506](https://github.com/ > **unrealizedLossRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2507](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2507) +Defined in: [Developer/brk/modules/brk-client/index.js:1754](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1754) *** @@ -118,7 +118,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2507](https://github.com/ > **unrealizedLossRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2508](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2508) +Defined in: [Developer/brk/modules/brk-client/index.js:1755](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1755) *** @@ -126,7 +126,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2508](https://github.com/ > **unrealizedLossRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2509](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2509) +Defined in: [Developer/brk/modules/brk-client/index.js:1756](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1756) *** @@ -134,7 +134,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2509](https://github.com/ > **unrealizedProfitRelToMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2510](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2510) +Defined in: [Developer/brk/modules/brk-client/index.js:1757](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1757) *** @@ -142,7 +142,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2510](https://github.com/ > **unrealizedProfitRelToOwnMarketCap**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2511](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2511) +Defined in: [Developer/brk/modules/brk-client/index.js:1758](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1758) *** @@ -150,4 +150,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:2511](https://github.com/ > **unrealizedProfitRelToOwnTotalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:2512](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L2512) +Defined in: [Developer/brk/modules/brk-client/index.js:1759](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1759) diff --git a/modules/brk-client/docs/interfaces/RewardStats.md b/modules/brk-client/docs/interfaces/RewardStats.md index ef7b280b5..74fcdc0a2 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:399](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L399) +Defined in: [Developer/brk/modules/brk-client/index.js:585](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L585) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:399](https://github.com/b > **endBlock**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:400](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L400) +Defined in: [Developer/brk/modules/brk-client/index.js:587](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L587) + +Last block in the range *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:400](https://github.com/b > **startBlock**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:401](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L401) +Defined in: [Developer/brk/modules/brk-client/index.js:586](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L586) + +First block in the range *** @@ -30,7 +34,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:401](https://github.com/b > **totalFee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:402](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L402) +Defined in: [Developer/brk/modules/brk-client/index.js:589](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L589) *** @@ -38,7 +42,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:402](https://github.com/b > **totalReward**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:403](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L403) +Defined in: [Developer/brk/modules/brk-client/index.js:588](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L588) *** @@ -46,4 +50,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:403](https://github.com/b > **totalTx**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:404](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L404) +Defined in: [Developer/brk/modules/brk-client/index.js:590](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L590) diff --git a/modules/brk-client/docs/interfaces/SatsPattern.md b/modules/brk-client/docs/interfaces/SatsPattern.md index adcbec47d..44069f953 100644 --- a/modules/brk-client/docs/interfaces/SatsPattern.md +++ b/modules/brk-client/docs/interfaces/SatsPattern.md @@ -6,7 +6,7 @@ # Interface: SatsPattern\ -Defined in: [Developer/brk/modules/brk-client/index.js:3623](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3623) +Defined in: [Developer/brk/modules/brk-client/index.js:2804](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2804) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3623](https://github.com/ > **ohlc**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3624](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3624) +Defined in: [Developer/brk/modules/brk-client/index.js:2805](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2805) *** @@ -28,4 +28,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3624](https://github.com/ > **split**: [`SplitPattern2`](SplitPattern2.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3625](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3625) +Defined in: [Developer/brk/modules/brk-client/index.js:2806](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2806) diff --git a/modules/brk-client/docs/interfaces/SegwitAdoptionPattern.md b/modules/brk-client/docs/interfaces/SegwitAdoptionPattern.md index 0bf145be8..6ca75c304 100644 --- a/modules/brk-client/docs/interfaces/SegwitAdoptionPattern.md +++ b/modules/brk-client/docs/interfaces/SegwitAdoptionPattern.md @@ -6,7 +6,7 @@ # Interface: SegwitAdoptionPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3498](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3498) +Defined in: [Developer/brk/modules/brk-client/index.js:2601](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2601) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3498](https://github.com/ > **base**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3499](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3499) +Defined in: [Developer/brk/modules/brk-client/index.js:2602](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2602) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3499](https://github.com/ > **cumulative**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3500](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3500) +Defined in: [Developer/brk/modules/brk-client/index.js:2603](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2603) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3500](https://github.com/ > **sum**: [`MetricPattern2`](../type-aliases/MetricPattern2.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3501](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3501) +Defined in: [Developer/brk/modules/brk-client/index.js:2604](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2604) diff --git a/modules/brk-client/docs/interfaces/SingleItemBuilder.md b/modules/brk-client/docs/interfaces/SingleItemBuilder.md new file mode 100644 index 000000000..7434868cd --- /dev/null +++ b/modules/brk-client/docs/interfaces/SingleItemBuilder.md @@ -0,0 +1,59 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SingleItemBuilder + +# Interface: SingleItemBuilder\ + +Defined in: [Developer/brk/modules/brk-client/index.js:863](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L863) + +## Type Parameters + +### T + +`T` + +## Properties + +### fetch() + +> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:864](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L864) + +Fetch the item + +#### Parameters + +##### onUpdate? + +(`value`) => `void` + +#### Returns + +`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> + +*** + +### fetchCsv() + +> **fetchCsv**: () => `Promise`\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:865](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L865) + +Fetch as CSV + +#### Returns + +`Promise`\<`string`\> + +*** + +### then + +> **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:866](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L866) + +Thenable diff --git a/modules/brk-client/docs/interfaces/SkippedBuilder.md b/modules/brk-client/docs/interfaces/SkippedBuilder.md new file mode 100644 index 000000000..8f9b0eb14 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SkippedBuilder.md @@ -0,0 +1,79 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SkippedBuilder + +# Interface: SkippedBuilder\ + +Defined in: [Developer/brk/modules/brk-client/index.js:871](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L871) + +## Type Parameters + +### T + +`T` + +## Properties + +### fetch() + +> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:873](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L873) + +Fetch from skipped position to end + +#### Parameters + +##### onUpdate? + +(`value`) => `void` + +#### Returns + +`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\> + +*** + +### fetchCsv() + +> **fetchCsv**: () => `Promise`\<`string`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:874](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L874) + +Fetch as CSV + +#### Returns + +`Promise`\<`string`\> + +*** + +### take() + +> **take**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:872](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L872) + +Take n items after skipped position + +#### Parameters + +##### n + +`number` + +#### Returns + +[`RangeBuilder`](RangeBuilder.md)\<`T`\> + +*** + +### then + +> **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\> + +Defined in: [Developer/brk/modules/brk-client/index.js:875](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L875) + +Thenable diff --git a/modules/brk-client/docs/interfaces/SplitPattern2.md b/modules/brk-client/docs/interfaces/SplitPattern2.md index 24cfc2ff1..2f1a5c656 100644 --- a/modules/brk-client/docs/interfaces/SplitPattern2.md +++ b/modules/brk-client/docs/interfaces/SplitPattern2.md @@ -6,7 +6,7 @@ # Interface: SplitPattern2\ -Defined in: [Developer/brk/modules/brk-client/index.js:3369](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3369) +Defined in: [Developer/brk/modules/brk-client/index.js:2514](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2514) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3369](https://github.com/ > **close**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3370](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3370) +Defined in: [Developer/brk/modules/brk-client/index.js:2515](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2515) *** @@ -28,7 +28,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3370](https://github.com/ > **high**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3371](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3371) +Defined in: [Developer/brk/modules/brk-client/index.js:2516](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2516) *** @@ -36,7 +36,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3371](https://github.com/ > **low**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3372](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3372) +Defined in: [Developer/brk/modules/brk-client/index.js:2517](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2517) *** @@ -44,4 +44,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3372](https://github.com/ > **open**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`T`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3373](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3373) +Defined in: [Developer/brk/modules/brk-client/index.js:2518](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2518) diff --git a/modules/brk-client/docs/interfaces/SupplyPattern2.md b/modules/brk-client/docs/interfaces/SupplyPattern2.md index 3e77c0c0e..40877fb77 100644 --- a/modules/brk-client/docs/interfaces/SupplyPattern2.md +++ b/modules/brk-client/docs/interfaces/SupplyPattern2.md @@ -6,7 +6,7 @@ # Interface: SupplyPattern2 -Defined in: [Developer/brk/modules/brk-client/index.js:3540](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3540) +Defined in: [Developer/brk/modules/brk-client/index.js:2704](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2704) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3540](https://github.com/ > **halved**: [`ActiveSupplyPattern`](ActiveSupplyPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3541](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3541) +Defined in: [Developer/brk/modules/brk-client/index.js:2705](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2705) *** @@ -22,4 +22,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3541](https://github.com/ > **total**: [`ActiveSupplyPattern`](ActiveSupplyPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3542](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3542) +Defined in: [Developer/brk/modules/brk-client/index.js:2706](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2706) diff --git a/modules/brk-client/docs/interfaces/SupplyState.md b/modules/brk-client/docs/interfaces/SupplyState.md index ffbe66599..80b55c24a 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:416](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L416) +Defined in: [Developer/brk/modules/brk-client/index.js:628](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L628) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:416](https://github.com/b > **utxoCount**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:417](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L417) +Defined in: [Developer/brk/modules/brk-client/index.js:629](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L629) + +Number of unspent transaction outputs *** @@ -22,4 +24,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:417](https://github.com/b > **value**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:418](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L418) +Defined in: [Developer/brk/modules/brk-client/index.js:630](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L630) + +Total value in satoshis diff --git a/modules/brk-client/docs/interfaces/SyncStatus.md b/modules/brk-client/docs/interfaces/SyncStatus.md new file mode 100644 index 000000000..ae30e2115 --- /dev/null +++ b/modules/brk-client/docs/interfaces/SyncStatus.md @@ -0,0 +1,59 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / SyncStatus + +# Interface: SyncStatus + +Defined in: [Developer/brk/modules/brk-client/index.js:635](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L635) + +## Properties + +### blocksBehind + +> **blocksBehind**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:638](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L638) + +Number of blocks behind the tip + +*** + +### indexedHeight + +> **indexedHeight**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:636](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L636) + +Height of the last indexed block + +*** + +### lastIndexedAt + +> **lastIndexedAt**: `string` + +Defined in: [Developer/brk/modules/brk-client/index.js:639](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L639) + +Human-readable timestamp of the last indexed block (ISO 8601) + +*** + +### lastIndexedAtUnix + +> **lastIndexedAtUnix**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:640](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L640) + +Unix timestamp of the last indexed block + +*** + +### tipHeight + +> **tipHeight**: `number` + +Defined in: [Developer/brk/modules/brk-client/index.js:637](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L637) + +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 707b6e695..0cc4b3439 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:422](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L422) +Defined in: [Developer/brk/modules/brk-client/index.js:651](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L651) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:422](https://github.com/b > **timePeriod**: [`TimePeriod`](../type-aliases/TimePeriod.md) -Defined in: [Developer/brk/modules/brk-client/index.js:423](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L423) +Defined in: [Developer/brk/modules/brk-client/index.js:652](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L652) diff --git a/modules/brk-client/docs/interfaces/TimestampParam.md b/modules/brk-client/docs/interfaces/TimestampParam.md index 3b49fc3e1..f599d0aa5 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:427](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L427) +Defined in: [Developer/brk/modules/brk-client/index.js:660](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L660) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:427](https://github.com/b > **timestamp**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:428](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L428) +Defined in: [Developer/brk/modules/brk-client/index.js:661](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L661) diff --git a/modules/brk-client/docs/interfaces/Transaction.md b/modules/brk-client/docs/interfaces/Transaction.md index 48e81cee8..4f4fe9e31 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:431](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L431) +Defined in: [Developer/brk/modules/brk-client/index.js:666](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L666) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:431](https://github.com/b > **fee**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:432](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L432) +Defined in: [Developer/brk/modules/brk-client/index.js:674](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L674) + +Transaction fee in satoshis *** @@ -22,7 +24,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:432](https://github.com/b > `optional` **index**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:433](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L433) +Defined in: [Developer/brk/modules/brk-client/index.js:667](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L667) *** @@ -30,7 +32,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:433](https://github.com/b > **locktime**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:434](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L434) +Defined in: [Developer/brk/modules/brk-client/index.js:670](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L670) *** @@ -38,7 +40,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:434](https://github.com/b > **sigops**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:435](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L435) +Defined in: [Developer/brk/modules/brk-client/index.js:673](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L673) + +Number of signature operations *** @@ -46,7 +50,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:435](https://github.com/b > **size**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:436](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L436) +Defined in: [Developer/brk/modules/brk-client/index.js:671](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L671) + +Transaction size in bytes *** @@ -54,7 +60,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:436](https://github.com/b > **status**: [`TxStatus`](TxStatus.md) -Defined in: [Developer/brk/modules/brk-client/index.js:437](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L437) +Defined in: [Developer/brk/modules/brk-client/index.js:677](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L677) *** @@ -62,7 +68,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:437](https://github.com/b > **txid**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:438](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L438) +Defined in: [Developer/brk/modules/brk-client/index.js:668](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L668) *** @@ -70,7 +76,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:438](https://github.com/b > **version**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:439](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L439) +Defined in: [Developer/brk/modules/brk-client/index.js:669](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L669) *** @@ -78,7 +84,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:439](https://github.com/b > **vin**: [`TxIn`](TxIn.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:440](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L440) +Defined in: [Developer/brk/modules/brk-client/index.js:675](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L675) + +Transaction inputs *** @@ -86,7 +94,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:440](https://github.com/b > **vout**: [`TxOut`](TxOut.md)[] -Defined in: [Developer/brk/modules/brk-client/index.js:441](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L441) +Defined in: [Developer/brk/modules/brk-client/index.js:676](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L676) + +Transaction outputs *** @@ -94,4 +104,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:441](https://github.com/b > **weight**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:442](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L442) +Defined in: [Developer/brk/modules/brk-client/index.js:672](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L672) + +Transaction weight diff --git a/modules/brk-client/docs/interfaces/TxIn.md b/modules/brk-client/docs/interfaces/TxIn.md index 9a614fb6b..bd23c912f 100644 --- a/modules/brk-client/docs/interfaces/TxIn.md +++ b/modules/brk-client/docs/interfaces/TxIn.md @@ -6,7 +6,7 @@ # Interface: TxIn -Defined in: [Developer/brk/modules/brk-client/index.js:446](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L446) +Defined in: [Developer/brk/modules/brk-client/index.js:687](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L687) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:446](https://github.com/b > `optional` **innerRedeemscriptAsm**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:447](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L447) +Defined in: [Developer/brk/modules/brk-client/index.js:695](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L695) + +Inner redeemscript in assembly format (for P2SH-wrapped SegWit) *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:447](https://github.com/b > **isCoinbase**: `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:448](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L448) +Defined in: [Developer/brk/modules/brk-client/index.js:693](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L693) + +Whether this input is a coinbase (block reward) input *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:448](https://github.com/b > `optional` **prevout**: [`TxOut`](TxOut.md) \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:449](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L449) +Defined in: [Developer/brk/modules/brk-client/index.js:690](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L690) + +Information about the previous output being spent *** @@ -38,7 +44,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:449](https://github.com/b > **scriptsig**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:450](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L450) +Defined in: [Developer/brk/modules/brk-client/index.js:691](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L691) + +Signature script (for non-SegWit inputs) *** @@ -46,7 +54,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:450](https://github.com/b > **scriptsigAsm**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:451](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L451) +Defined in: [Developer/brk/modules/brk-client/index.js:692](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L692) + +Signature script in assembly format *** @@ -54,7 +64,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:451](https://github.com/b > **sequence**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:452](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L452) +Defined in: [Developer/brk/modules/brk-client/index.js:694](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L694) + +Input sequence number *** @@ -62,7 +74,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:452](https://github.com/b > **txid**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:453](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L453) +Defined in: [Developer/brk/modules/brk-client/index.js:688](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L688) + +Transaction ID of the output being spent *** @@ -70,4 +84,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:453](https://github.com/b > **vout**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:454](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L454) +Defined in: [Developer/brk/modules/brk-client/index.js:689](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L689) diff --git a/modules/brk-client/docs/interfaces/TxOut.md b/modules/brk-client/docs/interfaces/TxOut.md index f1f7a2aad..df44086e0 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:459](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L459) +Defined in: [Developer/brk/modules/brk-client/index.js:702](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L702) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:459](https://github.com/b > **scriptpubkey**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:460](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L460) +Defined in: [Developer/brk/modules/brk-client/index.js:703](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L703) + +Script pubkey (locking script) *** @@ -22,4 +24,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:460](https://github.com/b > **value**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:461](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L461) +Defined in: [Developer/brk/modules/brk-client/index.js:704](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L704) + +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 4babb63e4..05a6b3afa 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:465](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L465) +Defined in: [Developer/brk/modules/brk-client/index.js:710](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L710) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:465](https://github.com/b > **spent**: `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:466](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L466) +Defined in: [Developer/brk/modules/brk-client/index.js:711](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L711) + +Whether the output has been spent *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:466](https://github.com/b > `optional` **status**: [`TxStatus`](TxStatus.md) \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:467](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L467) +Defined in: [Developer/brk/modules/brk-client/index.js:714](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L714) + +Status of the spending transaction (only present if spent) *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:467](https://github.com/b > `optional` **txid**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:468](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L468) +Defined in: [Developer/brk/modules/brk-client/index.js:712](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L712) + +Transaction ID of the spending transaction (only present if spent) *** @@ -38,4 +44,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:468](https://github.com/b > `optional` **vin**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:469](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L469) +Defined in: [Developer/brk/modules/brk-client/index.js:713](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L713) + +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 fe0a6a0d8..954abc570 100644 --- a/modules/brk-client/docs/interfaces/TxStatus.md +++ b/modules/brk-client/docs/interfaces/TxStatus.md @@ -6,7 +6,7 @@ # Interface: TxStatus -Defined in: [Developer/brk/modules/brk-client/index.js:472](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L472) +Defined in: [Developer/brk/modules/brk-client/index.js:719](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L719) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:472](https://github.com/b > `optional` **blockHash**: `string` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:473](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L473) +Defined in: [Developer/brk/modules/brk-client/index.js:722](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L722) + +Block hash (only present if confirmed) *** @@ -22,7 +24,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:473](https://github.com/b > `optional` **blockHeight**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:474](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L474) +Defined in: [Developer/brk/modules/brk-client/index.js:721](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L721) + +Block height (only present if confirmed) *** @@ -30,7 +34,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:474](https://github.com/b > `optional` **blockTime**: `number` \| `null` -Defined in: [Developer/brk/modules/brk-client/index.js:475](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L475) +Defined in: [Developer/brk/modules/brk-client/index.js:723](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L723) + +Block timestamp (only present if confirmed) *** @@ -38,4 +44,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:475](https://github.com/b > **confirmed**: `boolean` -Defined in: [Developer/brk/modules/brk-client/index.js:476](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L476) +Defined in: [Developer/brk/modules/brk-client/index.js:720](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L720) + +Whether the transaction is confirmed diff --git a/modules/brk-client/docs/interfaces/TxidParam.md b/modules/brk-client/docs/interfaces/TxidParam.md index b35ccae4a..e59af40c7 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:481](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L481) +Defined in: [Developer/brk/modules/brk-client/index.js:736](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L736) ## Properties @@ -14,4 +14,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:481](https://github.com/b > **txid**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:482](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L482) +Defined in: [Developer/brk/modules/brk-client/index.js:737](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L737) diff --git a/modules/brk-client/docs/interfaces/TxidVout.md b/modules/brk-client/docs/interfaces/TxidVout.md index a5ce6b0e3..e9ce9fcdc 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:485](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L485) +Defined in: [Developer/brk/modules/brk-client/index.js:742](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L742) ## Properties @@ -14,7 +14,9 @@ Defined in: [Developer/brk/modules/brk-client/index.js:485](https://github.com/b > **txid**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:486](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L486) +Defined in: [Developer/brk/modules/brk-client/index.js:743](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L743) + +Transaction ID *** @@ -22,4 +24,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:486](https://github.com/b > **vout**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:487](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L487) +Defined in: [Developer/brk/modules/brk-client/index.js:744](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L744) + +Output index diff --git a/modules/brk-client/docs/interfaces/UnclaimedRewardsPattern.md b/modules/brk-client/docs/interfaces/UnclaimedRewardsPattern.md index b96b19cea..8216d7803 100644 --- a/modules/brk-client/docs/interfaces/UnclaimedRewardsPattern.md +++ b/modules/brk-client/docs/interfaces/UnclaimedRewardsPattern.md @@ -6,15 +6,15 @@ # Interface: UnclaimedRewardsPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3519](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3519) +Defined in: [Developer/brk/modules/brk-client/index.js:2664](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2664) ## Properties ### bitcoin -> **bitcoin**: [`BitcoinPattern`](BitcoinPattern.md)\<`number`\> +> **bitcoin**: [`BitcoinPattern2`](BitcoinPattern2.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3520](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3520) +Defined in: [Developer/brk/modules/brk-client/index.js:2665](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2665) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3520](https://github.com/ > **dollars**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3521](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3521) +Defined in: [Developer/brk/modules/brk-client/index.js:2666](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2666) *** @@ -30,4 +30,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3521](https://github.com/ > **sats**: [`BlockCountPattern`](BlockCountPattern.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3522](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3522) +Defined in: [Developer/brk/modules/brk-client/index.js:2667](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2667) diff --git a/modules/brk-client/docs/interfaces/UnrealizedPattern.md b/modules/brk-client/docs/interfaces/UnrealizedPattern.md index 371176aef..56c27c1cb 100644 --- a/modules/brk-client/docs/interfaces/UnrealizedPattern.md +++ b/modules/brk-client/docs/interfaces/UnrealizedPattern.md @@ -6,7 +6,7 @@ # Interface: UnrealizedPattern -Defined in: [Developer/brk/modules/brk-client/index.js:3142](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3142) +Defined in: [Developer/brk/modules/brk-client/index.js:2372](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2372) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3142](https://github.com/ > **negUnrealizedLoss**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3143](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3143) +Defined in: [Developer/brk/modules/brk-client/index.js:2373](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2373) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3143](https://github.com/ > **netUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3144](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3144) +Defined in: [Developer/brk/modules/brk-client/index.js:2374](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2374) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3144](https://github.com/ > **supplyInLoss**: [`ActiveSupplyPattern`](ActiveSupplyPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3145](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3145) +Defined in: [Developer/brk/modules/brk-client/index.js:2375](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2375) *** @@ -38,7 +38,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3145](https://github.com/ > **supplyInProfit**: [`ActiveSupplyPattern`](ActiveSupplyPattern.md) -Defined in: [Developer/brk/modules/brk-client/index.js:3146](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3146) +Defined in: [Developer/brk/modules/brk-client/index.js:2376](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2376) *** @@ -46,7 +46,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3146](https://github.com/ > **totalUnrealizedPnl**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3147](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3147) +Defined in: [Developer/brk/modules/brk-client/index.js:2377](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2377) *** @@ -54,7 +54,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3147](https://github.com/ > **unrealizedLoss**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3148](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3148) +Defined in: [Developer/brk/modules/brk-client/index.js:2378](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2378) *** @@ -62,4 +62,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:3148](https://github.com/ > **unrealizedProfit**: [`MetricPattern1`](../type-aliases/MetricPattern1.md)\<`number`\> -Defined in: [Developer/brk/modules/brk-client/index.js:3149](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L3149) +Defined in: [Developer/brk/modules/brk-client/index.js:2379](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L2379) diff --git a/modules/brk-client/docs/interfaces/Utxo.md b/modules/brk-client/docs/interfaces/Utxo.md index 474477008..a07d5b7bc 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:497](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L497) +Defined in: [Developer/brk/modules/brk-client/index.js:760](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L760) ## Properties @@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:497](https://github.com/b > **status**: [`TxStatus`](TxStatus.md) -Defined in: [Developer/brk/modules/brk-client/index.js:498](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L498) +Defined in: [Developer/brk/modules/brk-client/index.js:763](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L763) *** @@ -22,7 +22,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:498](https://github.com/b > **txid**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:499](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L499) +Defined in: [Developer/brk/modules/brk-client/index.js:761](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L761) *** @@ -30,7 +30,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:499](https://github.com/b > **value**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:500](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L500) +Defined in: [Developer/brk/modules/brk-client/index.js:764](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L764) *** @@ -38,4 +38,4 @@ Defined in: [Developer/brk/modules/brk-client/index.js:500](https://github.com/b > **vout**: `number` -Defined in: [Developer/brk/modules/brk-client/index.js:501](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L501) +Defined in: [Developer/brk/modules/brk-client/index.js:762](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L762) diff --git a/modules/brk-client/docs/interfaces/ValidateAddressParam.md b/modules/brk-client/docs/interfaces/ValidateAddressParam.md index a1b62a521..8526b5cf0 100644 --- a/modules/brk-client/docs/interfaces/ValidateAddressParam.md +++ b/modules/brk-client/docs/interfaces/ValidateAddressParam.md @@ -6,7 +6,7 @@ # Interface: ValidateAddressParam -Defined in: [Developer/brk/modules/brk-client/index.js:505](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L505) +Defined in: [Developer/brk/modules/brk-client/index.js:772](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L772) ## Properties @@ -14,4 +14,6 @@ Defined in: [Developer/brk/modules/brk-client/index.js:505](https://github.com/b > **address**: `string` -Defined in: [Developer/brk/modules/brk-client/index.js:506](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L506) +Defined in: [Developer/brk/modules/brk-client/index.js:773](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L773) + +Bitcoin address to validate (can be any string) diff --git a/modules/brk-client/docs/type-aliases/Address.md b/modules/brk-client/docs/type-aliases/Address.md index c3d93cb50..78ae1aa16 100644 --- a/modules/brk-client/docs/type-aliases/Address.md +++ b/modules/brk-client/docs/type-aliases/Address.md @@ -8,6 +8,6 @@ > **Address**\<\> = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:6](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L6) +Defined in: [Developer/brk/modules/brk-client/index.js:9](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L9) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnyAddressIndex.md b/modules/brk-client/docs/type-aliases/AnyAddressIndex.md index ad4619e5c..419c46545 100644 --- a/modules/brk-client/docs/type-aliases/AnyAddressIndex.md +++ b/modules/brk-client/docs/type-aliases/AnyAddressIndex.md @@ -8,6 +8,6 @@ > **AnyAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:49](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L49) +Defined in: [Developer/brk/modules/brk-client/index.js:68](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/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 index 8280e74ec..87ef4ca7d 100644 --- a/modules/brk-client/docs/type-aliases/AnyMetricData.md +++ b/modules/brk-client/docs/type-aliases/AnyMetricData.md @@ -6,8 +6,8 @@ # Type Alias: AnyMetricData -> **AnyMetricData**\<\> = [`MetricData`](../interfaces/MetricData.md)\<`unknown`\> +> **AnyMetricData**\<\> = [`MetricData`](../interfaces/MetricData.md)\<`any`\> -Defined in: [Developer/brk/modules/brk-client/index.js:552](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L552) +Defined in: [Developer/brk/modules/brk-client/index.js:837](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L837) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnyMetricEndpoint.md b/modules/brk-client/docs/type-aliases/AnyMetricEndpoint.md deleted file mode 100644 index add877c63..000000000 --- a/modules/brk-client/docs/type-aliases/AnyMetricEndpoint.md +++ /dev/null @@ -1,13 +0,0 @@ -[**brk-client**](../README.md) - -*** - -[brk-client](../globals.md) / AnyMetricEndpoint - -# Type Alias: AnyMetricEndpoint - -> **AnyMetricEndpoint**\<\> = [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`unknown`\> - -Defined in: [Developer/brk/modules/brk-client/index.js:561](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L561) - -## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnyMetricEndpointBuilder.md b/modules/brk-client/docs/type-aliases/AnyMetricEndpointBuilder.md new file mode 100644 index 000000000..ff297a86d --- /dev/null +++ b/modules/brk-client/docs/type-aliases/AnyMetricEndpointBuilder.md @@ -0,0 +1,13 @@ +[**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:859](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L859) + +## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/AnyMetricPattern.md b/modules/brk-client/docs/type-aliases/AnyMetricPattern.md index 43ace480a..b16f592ff 100644 --- a/modules/brk-client/docs/type-aliases/AnyMetricPattern.md +++ b/modules/brk-client/docs/type-aliases/AnyMetricPattern.md @@ -6,8 +6,8 @@ # Type Alias: AnyMetricPattern -> **AnyMetricPattern**\<\> = [`MetricPattern`](../interfaces/MetricPattern.md)\<`unknown`\> +> **AnyMetricPattern**\<\> = [`MetricPattern`](../interfaces/MetricPattern.md)\<`any`\> -Defined in: [Developer/brk/modules/brk-client/index.js:572](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L572) +Defined in: [Developer/brk/modules/brk-client/index.js:895](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L895) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Bitcoin.md b/modules/brk-client/docs/type-aliases/Bitcoin.md index 2a0124d37..69180f84f 100644 --- a/modules/brk-client/docs/type-aliases/Bitcoin.md +++ b/modules/brk-client/docs/type-aliases/Bitcoin.md @@ -8,6 +8,6 @@ > **Bitcoin**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:50](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L50) +Defined in: [Developer/brk/modules/brk-client/index.js:73](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L73) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/BlkPosition.md b/modules/brk-client/docs/type-aliases/BlkPosition.md index 66016011e..79dbf5c99 100644 --- a/modules/brk-client/docs/type-aliases/BlkPosition.md +++ b/modules/brk-client/docs/type-aliases/BlkPosition.md @@ -8,6 +8,6 @@ > **BlkPosition**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:51](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L51) +Defined in: [Developer/brk/modules/brk-client/index.js:78](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/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 12fc719f0..803492ee7 100644 --- a/modules/brk-client/docs/type-aliases/BlockHash.md +++ b/modules/brk-client/docs/type-aliases/BlockHash.md @@ -8,6 +8,6 @@ > **BlockHash**\<\> = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:62](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L62) +Defined in: [Developer/brk/modules/brk-client/index.js:95](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L95) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Cents.md b/modules/brk-client/docs/type-aliases/Cents.md index 10e811963..893511406 100644 --- a/modules/brk-client/docs/type-aliases/Cents.md +++ b/modules/brk-client/docs/type-aliases/Cents.md @@ -8,6 +8,6 @@ > **Cents**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:122](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L122) +Defined in: [Developer/brk/modules/brk-client/index.js:170](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L170) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Close.md b/modules/brk-client/docs/type-aliases/Close.md index ed8cca5a2..2349a1e17 100644 --- a/modules/brk-client/docs/type-aliases/Close.md +++ b/modules/brk-client/docs/type-aliases/Close.md @@ -8,6 +8,6 @@ > **Close**\<\> = [`Cents`](Cents.md) -Defined in: [Developer/brk/modules/brk-client/index.js:123](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L123) +Defined in: [Developer/brk/modules/brk-client/index.js:174](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L174) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Date.md b/modules/brk-client/docs/type-aliases/Date.md index 6523165bd..53c547ba9 100644 --- a/modules/brk-client/docs/type-aliases/Date.md +++ b/modules/brk-client/docs/type-aliases/Date.md @@ -8,6 +8,6 @@ > **Date**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:131](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L131) +Defined in: [Developer/brk/modules/brk-client/index.js:188](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L188) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/DateIndex.md b/modules/brk-client/docs/type-aliases/DateIndex.md index d8dfa476c..ae6441cae 100644 --- a/modules/brk-client/docs/type-aliases/DateIndex.md +++ b/modules/brk-client/docs/type-aliases/DateIndex.md @@ -8,6 +8,6 @@ > **DateIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:132](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L132) +Defined in: [Developer/brk/modules/brk-client/index.js:190](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L190) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/DecadeIndex.md b/modules/brk-client/docs/type-aliases/DecadeIndex.md index 37e02cbf0..1436ed1a9 100644 --- a/modules/brk-client/docs/type-aliases/DecadeIndex.md +++ b/modules/brk-client/docs/type-aliases/DecadeIndex.md @@ -8,6 +8,6 @@ > **DecadeIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:133](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L133) +Defined in: [Developer/brk/modules/brk-client/index.js:191](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L191) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/DifficultyEpoch.md b/modules/brk-client/docs/type-aliases/DifficultyEpoch.md index 92bee210e..fbf1f451e 100644 --- a/modules/brk-client/docs/type-aliases/DifficultyEpoch.md +++ b/modules/brk-client/docs/type-aliases/DifficultyEpoch.md @@ -8,6 +8,6 @@ > **DifficultyEpoch**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:160](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L160) +Defined in: [Developer/brk/modules/brk-client/index.js:225](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L225) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Dollars.md b/modules/brk-client/docs/type-aliases/Dollars.md index f5ab01544..af60dd3bb 100644 --- a/modules/brk-client/docs/type-aliases/Dollars.md +++ b/modules/brk-client/docs/type-aliases/Dollars.md @@ -8,6 +8,6 @@ > **Dollars**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:161](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L161) +Defined in: [Developer/brk/modules/brk-client/index.js:239](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L239) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/EmptyAddressIndex.md b/modules/brk-client/docs/type-aliases/EmptyAddressIndex.md index 546d1938e..2baf01544 100644 --- a/modules/brk-client/docs/type-aliases/EmptyAddressIndex.md +++ b/modules/brk-client/docs/type-aliases/EmptyAddressIndex.md @@ -8,6 +8,6 @@ > **EmptyAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:168](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L168) +Defined in: [Developer/brk/modules/brk-client/index.js:249](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L249) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/EmptyOutputIndex.md b/modules/brk-client/docs/type-aliases/EmptyOutputIndex.md index 1a411254d..7b2f30c43 100644 --- a/modules/brk-client/docs/type-aliases/EmptyOutputIndex.md +++ b/modules/brk-client/docs/type-aliases/EmptyOutputIndex.md @@ -8,6 +8,6 @@ > **EmptyOutputIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:169](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L169) +Defined in: [Developer/brk/modules/brk-client/index.js:250](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L250) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/FeeRate.md b/modules/brk-client/docs/type-aliases/FeeRate.md index 3d32ec787..cd5d96230 100644 --- a/modules/brk-client/docs/type-aliases/FeeRate.md +++ b/modules/brk-client/docs/type-aliases/FeeRate.md @@ -8,6 +8,6 @@ > **FeeRate**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:170](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L170) +Defined in: [Developer/brk/modules/brk-client/index.js:254](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L254) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Format.md b/modules/brk-client/docs/type-aliases/Format.md index d42c16a36..e5be92f3e 100644 --- a/modules/brk-client/docs/type-aliases/Format.md +++ b/modules/brk-client/docs/type-aliases/Format.md @@ -8,6 +8,6 @@ > **Format**\<\> = `"json"` \| `"csv"` -Defined in: [Developer/brk/modules/brk-client/index.js:171](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L171) +Defined in: [Developer/brk/modules/brk-client/index.js:259](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L259) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/HalvingEpoch.md b/modules/brk-client/docs/type-aliases/HalvingEpoch.md index 83b063099..a9f333581 100644 --- a/modules/brk-client/docs/type-aliases/HalvingEpoch.md +++ b/modules/brk-client/docs/type-aliases/HalvingEpoch.md @@ -8,6 +8,6 @@ > **HalvingEpoch**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:172](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L172) +Defined in: [Developer/brk/modules/brk-client/index.js:261](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L261) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Height.md b/modules/brk-client/docs/type-aliases/Height.md index dcde963dc..ab9d7da93 100644 --- a/modules/brk-client/docs/type-aliases/Height.md +++ b/modules/brk-client/docs/type-aliases/Height.md @@ -8,6 +8,6 @@ > **Height**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:191](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L191) +Defined in: [Developer/brk/modules/brk-client/index.js:291](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L291) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Hex.md b/modules/brk-client/docs/type-aliases/Hex.md index b8f12e052..1f2515429 100644 --- a/modules/brk-client/docs/type-aliases/Hex.md +++ b/modules/brk-client/docs/type-aliases/Hex.md @@ -8,6 +8,6 @@ > **Hex**\<\> = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:196](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L196) +Defined in: [Developer/brk/modules/brk-client/index.js:300](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L300) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/High.md b/modules/brk-client/docs/type-aliases/High.md index 72836488f..c45673a08 100644 --- a/modules/brk-client/docs/type-aliases/High.md +++ b/modules/brk-client/docs/type-aliases/High.md @@ -8,6 +8,6 @@ > **High**\<\> = [`Cents`](Cents.md) -Defined in: [Developer/brk/modules/brk-client/index.js:197](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L197) +Defined in: [Developer/brk/modules/brk-client/index.js:305](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L305) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Index.md b/modules/brk-client/docs/type-aliases/Index.md index 485288781..abb47c894 100644 --- a/modules/brk-client/docs/type-aliases/Index.md +++ b/modules/brk-client/docs/type-aliases/Index.md @@ -8,6 +8,6 @@ > **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"` \| `"loadedaddressindex"` \| `"emptyaddressindex"` -Defined in: [Developer/brk/modules/brk-client/index.js:198](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L198) +Defined in: [Developer/brk/modules/brk-client/index.js:311](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L311) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Limit.md b/modules/brk-client/docs/type-aliases/Limit.md index f7c881809..c4760e63b 100644 --- a/modules/brk-client/docs/type-aliases/Limit.md +++ b/modules/brk-client/docs/type-aliases/Limit.md @@ -8,6 +8,6 @@ > **Limit**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:204](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L204) +Defined in: [Developer/brk/modules/brk-client/index.js:323](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L323) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/LoadedAddressIndex.md b/modules/brk-client/docs/type-aliases/LoadedAddressIndex.md index d2f6ac98d..fd0b3c991 100644 --- a/modules/brk-client/docs/type-aliases/LoadedAddressIndex.md +++ b/modules/brk-client/docs/type-aliases/LoadedAddressIndex.md @@ -8,6 +8,6 @@ > **LoadedAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:218](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L218) +Defined in: [Developer/brk/modules/brk-client/index.js:340](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L340) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Low.md b/modules/brk-client/docs/type-aliases/Low.md index 1948bf5db..c338180d4 100644 --- a/modules/brk-client/docs/type-aliases/Low.md +++ b/modules/brk-client/docs/type-aliases/Low.md @@ -8,6 +8,6 @@ > **Low**\<\> = [`Cents`](Cents.md) -Defined in: [Developer/brk/modules/brk-client/index.js:219](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L219) +Defined in: [Developer/brk/modules/brk-client/index.js:344](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L344) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Metric.md b/modules/brk-client/docs/type-aliases/Metric.md index c7860990c..2c8235bd0 100644 --- a/modules/brk-client/docs/type-aliases/Metric.md +++ b/modules/brk-client/docs/type-aliases/Metric.md @@ -8,6 +8,6 @@ > **Metric**\<\> = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:235](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L235) +Defined in: [Developer/brk/modules/brk-client/index.js:368](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L368) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/MetricPattern1.md b/modules/brk-client/docs/type-aliases/MetricPattern1.md index 5bca3a95e..a20ad5c30 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern1.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern1.md @@ -8,7 +8,7 @@ > **MetricPattern1**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:666](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L666) +Defined in: [Developer/brk/modules/brk-client/index.js:1121](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1121) ## Type Parameters @@ -24,43 +24,43 @@ Defined in: [Developer/brk/modules/brk-client/index.js:666](https://github.com/b #### by.dateindex -> **dateindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.decadeindex -> **decadeindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **decadeindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.difficultyepoch -> **difficultyepoch**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **difficultyepoch**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.height -> **height**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **height**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.monthindex -> **monthindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **monthindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.quarterindex -> **quarterindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **quarterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.semesterindex -> **semesterindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **semesterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.weekindex -> **weekindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **weekindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.yearindex -> **yearindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **yearindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -70,15 +70,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:666](https://github.com/b #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern10.md b/modules/brk-client/docs/type-aliases/MetricPattern10.md index d3e38fa80..aae05ecc5 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern10.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern10.md @@ -8,7 +8,7 @@ > **MetricPattern10**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1068](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1068) +Defined in: [Developer/brk/modules/brk-client/index.js:1148](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1148) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1068](https://github.com/ #### by.halvingepoch -> **halvingepoch**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **halvingepoch**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1068](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern11.md b/modules/brk-client/docs/type-aliases/MetricPattern11.md index 75f0f474d..5467cf4b5 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern11.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern11.md @@ -8,7 +8,7 @@ > **MetricPattern11**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1099](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1099) +Defined in: [Developer/brk/modules/brk-client/index.js:1151](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1151) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1099](https://github.com/ #### by.height -> **height**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **height**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1099](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern12.md b/modules/brk-client/docs/type-aliases/MetricPattern12.md index 804c03939..71ccbf63f 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern12.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern12.md @@ -8,7 +8,7 @@ > **MetricPattern12**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1130](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1130) +Defined in: [Developer/brk/modules/brk-client/index.js:1154](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1154) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1130](https://github.com/ #### by.txinindex -> **txinindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **txinindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1130](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern13.md b/modules/brk-client/docs/type-aliases/MetricPattern13.md index 633bfa27a..a9f78a7e5 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern13.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern13.md @@ -8,7 +8,7 @@ > **MetricPattern13**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1161](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1161) +Defined in: [Developer/brk/modules/brk-client/index.js:1157](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1157) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1161](https://github.com/ #### by.monthindex -> **monthindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **monthindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1161](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern14.md b/modules/brk-client/docs/type-aliases/MetricPattern14.md index 85784429c..89a46cb77 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern14.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern14.md @@ -8,7 +8,7 @@ > **MetricPattern14**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1192](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1192) +Defined in: [Developer/brk/modules/brk-client/index.js:1160](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1160) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1192](https://github.com/ #### by.opreturnindex -> **opreturnindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **opreturnindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1192](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern15.md b/modules/brk-client/docs/type-aliases/MetricPattern15.md index f8a5236b8..a01b7ae91 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern15.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern15.md @@ -8,7 +8,7 @@ > **MetricPattern15**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1223](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1223) +Defined in: [Developer/brk/modules/brk-client/index.js:1163](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1163) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1223](https://github.com/ #### by.txoutindex -> **txoutindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **txoutindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1223](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern16.md b/modules/brk-client/docs/type-aliases/MetricPattern16.md index b5ddb0920..066c9123b 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern16.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern16.md @@ -8,7 +8,7 @@ > **MetricPattern16**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1254](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1254) +Defined in: [Developer/brk/modules/brk-client/index.js:1166](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1166) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1254](https://github.com/ #### by.p2aaddressindex -> **p2aaddressindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **p2aaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1254](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern17.md b/modules/brk-client/docs/type-aliases/MetricPattern17.md index 2b91eafd1..6204d762f 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern17.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern17.md @@ -8,7 +8,7 @@ > **MetricPattern17**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1285](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1285) +Defined in: [Developer/brk/modules/brk-client/index.js:1169](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1169) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1285](https://github.com/ #### by.p2msoutputindex -> **p2msoutputindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **p2msoutputindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1285](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern18.md b/modules/brk-client/docs/type-aliases/MetricPattern18.md index 3b47b46c9..0f09b0370 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern18.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern18.md @@ -8,7 +8,7 @@ > **MetricPattern18**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1316](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1316) +Defined in: [Developer/brk/modules/brk-client/index.js:1172](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1172) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1316](https://github.com/ #### by.p2pk33addressindex -> **p2pk33addressindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **p2pk33addressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1316](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern19.md b/modules/brk-client/docs/type-aliases/MetricPattern19.md index 4cafed9d1..4b987d4f6 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern19.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern19.md @@ -8,7 +8,7 @@ > **MetricPattern19**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1347](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1347) +Defined in: [Developer/brk/modules/brk-client/index.js:1175](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1175) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1347](https://github.com/ #### by.p2pk65addressindex -> **p2pk65addressindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **p2pk65addressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1347](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern2.md b/modules/brk-client/docs/type-aliases/MetricPattern2.md index ff48fb829..b748fdecf 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern2.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern2.md @@ -8,7 +8,7 @@ > **MetricPattern2**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:731](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L731) +Defined in: [Developer/brk/modules/brk-client/index.js:1124](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1124) ## Type Parameters @@ -24,39 +24,39 @@ Defined in: [Developer/brk/modules/brk-client/index.js:731](https://github.com/b #### by.dateindex -> **dateindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.decadeindex -> **decadeindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **decadeindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.difficultyepoch -> **difficultyepoch**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **difficultyepoch**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.monthindex -> **monthindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **monthindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.quarterindex -> **quarterindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **quarterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.semesterindex -> **semesterindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **semesterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.weekindex -> **weekindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **weekindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.yearindex -> **yearindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **yearindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -66,15 +66,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:731](https://github.com/b #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern20.md b/modules/brk-client/docs/type-aliases/MetricPattern20.md index 16f5415a6..9d28db6ff 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern20.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern20.md @@ -8,7 +8,7 @@ > **MetricPattern20**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1378](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1378) +Defined in: [Developer/brk/modules/brk-client/index.js:1178](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1178) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1378](https://github.com/ #### by.p2pkhaddressindex -> **p2pkhaddressindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **p2pkhaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1378](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern21.md b/modules/brk-client/docs/type-aliases/MetricPattern21.md index 5cee32795..e2a8b16d5 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern21.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern21.md @@ -8,7 +8,7 @@ > **MetricPattern21**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1409](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1409) +Defined in: [Developer/brk/modules/brk-client/index.js:1181](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1181) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1409](https://github.com/ #### by.p2shaddressindex -> **p2shaddressindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **p2shaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1409](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern22.md b/modules/brk-client/docs/type-aliases/MetricPattern22.md index 625761eca..452e57c94 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern22.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern22.md @@ -8,7 +8,7 @@ > **MetricPattern22**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1440](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1440) +Defined in: [Developer/brk/modules/brk-client/index.js:1184](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1184) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1440](https://github.com/ #### by.p2traddressindex -> **p2traddressindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **p2traddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1440](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern23.md b/modules/brk-client/docs/type-aliases/MetricPattern23.md index a0fdf7951..71967b933 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern23.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern23.md @@ -8,7 +8,7 @@ > **MetricPattern23**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1471](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1471) +Defined in: [Developer/brk/modules/brk-client/index.js:1187](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1187) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1471](https://github.com/ #### by.p2wpkhaddressindex -> **p2wpkhaddressindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **p2wpkhaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1471](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern24.md b/modules/brk-client/docs/type-aliases/MetricPattern24.md index 1b7973f97..5c8b44571 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern24.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern24.md @@ -8,7 +8,7 @@ > **MetricPattern24**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1502](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1502) +Defined in: [Developer/brk/modules/brk-client/index.js:1190](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1190) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1502](https://github.com/ #### by.p2wshaddressindex -> **p2wshaddressindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **p2wshaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1502](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern25.md b/modules/brk-client/docs/type-aliases/MetricPattern25.md index 08767fbae..b8ba08556 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern25.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern25.md @@ -8,7 +8,7 @@ > **MetricPattern25**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1533](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1533) +Defined in: [Developer/brk/modules/brk-client/index.js:1193](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1193) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1533](https://github.com/ #### by.quarterindex -> **quarterindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **quarterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1533](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern26.md b/modules/brk-client/docs/type-aliases/MetricPattern26.md index f316aaa2b..324fefb23 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern26.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern26.md @@ -8,7 +8,7 @@ > **MetricPattern26**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1564](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1564) +Defined in: [Developer/brk/modules/brk-client/index.js:1196](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1196) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1564](https://github.com/ #### by.semesterindex -> **semesterindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **semesterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1564](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern27.md b/modules/brk-client/docs/type-aliases/MetricPattern27.md index 7832e7012..199e1fb31 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern27.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern27.md @@ -8,7 +8,7 @@ > **MetricPattern27**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1595](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1595) +Defined in: [Developer/brk/modules/brk-client/index.js:1199](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1199) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1595](https://github.com/ #### by.txindex -> **txindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **txindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1595](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern28.md b/modules/brk-client/docs/type-aliases/MetricPattern28.md index c0ff08db7..30bfe9b84 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern28.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern28.md @@ -8,7 +8,7 @@ > **MetricPattern28**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1626](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1626) +Defined in: [Developer/brk/modules/brk-client/index.js:1202](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1202) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1626](https://github.com/ #### by.unknownoutputindex -> **unknownoutputindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **unknownoutputindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1626](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern29.md b/modules/brk-client/docs/type-aliases/MetricPattern29.md index 6c8af9933..56e372bd8 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern29.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern29.md @@ -8,7 +8,7 @@ > **MetricPattern29**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1657](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1657) +Defined in: [Developer/brk/modules/brk-client/index.js:1205](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1205) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1657](https://github.com/ #### by.weekindex -> **weekindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **weekindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1657](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern3.md b/modules/brk-client/docs/type-aliases/MetricPattern3.md index 435575e1f..932e034bf 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern3.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern3.md @@ -8,7 +8,7 @@ > **MetricPattern3**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:792](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L792) +Defined in: [Developer/brk/modules/brk-client/index.js:1127](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1127) ## Type Parameters @@ -24,39 +24,39 @@ Defined in: [Developer/brk/modules/brk-client/index.js:792](https://github.com/b #### by.dateindex -> **dateindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.decadeindex -> **decadeindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **decadeindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.height -> **height**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **height**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.monthindex -> **monthindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **monthindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.quarterindex -> **quarterindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **quarterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.semesterindex -> **semesterindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **semesterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.weekindex -> **weekindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **weekindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.yearindex -> **yearindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **yearindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -66,15 +66,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:792](https://github.com/b #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern30.md b/modules/brk-client/docs/type-aliases/MetricPattern30.md index c7cf4af67..944f89d5d 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern30.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern30.md @@ -8,7 +8,7 @@ > **MetricPattern30**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1688](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1688) +Defined in: [Developer/brk/modules/brk-client/index.js:1208](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1208) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1688](https://github.com/ #### by.yearindex -> **yearindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **yearindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1688](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern31.md b/modules/brk-client/docs/type-aliases/MetricPattern31.md index 088f7b37d..3acc9503a 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern31.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern31.md @@ -8,7 +8,7 @@ > **MetricPattern31**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1719](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1719) +Defined in: [Developer/brk/modules/brk-client/index.js:1211](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1211) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1719](https://github.com/ #### by.loadedaddressindex -> **loadedaddressindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **loadedaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1719](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern32.md b/modules/brk-client/docs/type-aliases/MetricPattern32.md index f2b704c1d..8cef248ce 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern32.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern32.md @@ -8,7 +8,7 @@ > **MetricPattern32**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1750](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1750) +Defined in: [Developer/brk/modules/brk-client/index.js:1214](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1214) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1750](https://github.com/ #### by.emptyaddressindex -> **emptyaddressindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **emptyaddressindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1750](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern4.md b/modules/brk-client/docs/type-aliases/MetricPattern4.md index 7efa07c4d..1a5dd60b4 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern4.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern4.md @@ -8,7 +8,7 @@ > **MetricPattern4**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:853](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L853) +Defined in: [Developer/brk/modules/brk-client/index.js:1130](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1130) ## Type Parameters @@ -24,35 +24,35 @@ Defined in: [Developer/brk/modules/brk-client/index.js:853](https://github.com/b #### by.dateindex -> **dateindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.decadeindex -> **decadeindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **decadeindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.monthindex -> **monthindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **monthindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.quarterindex -> **quarterindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **quarterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.semesterindex -> **semesterindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **semesterindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.weekindex -> **weekindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **weekindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.yearindex -> **yearindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **yearindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -62,15 +62,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:853](https://github.com/b #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern5.md b/modules/brk-client/docs/type-aliases/MetricPattern5.md index 8a67052c6..26b8c86e8 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern5.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern5.md @@ -8,7 +8,7 @@ > **MetricPattern5**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:910](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L910) +Defined in: [Developer/brk/modules/brk-client/index.js:1133](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1133) ## Type Parameters @@ -24,15 +24,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:910](https://github.com/b #### by.dateindex -> **dateindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> #### by.height -> **height**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **height**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -42,15 +42,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:910](https://github.com/b #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern6.md b/modules/brk-client/docs/type-aliases/MetricPattern6.md index 8547c1c30..28ccfbc9c 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern6.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern6.md @@ -8,7 +8,7 @@ > **MetricPattern6**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:944](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L944) +Defined in: [Developer/brk/modules/brk-client/index.js:1136](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1136) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:944](https://github.com/b #### by.dateindex -> **dateindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **dateindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:944](https://github.com/b #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern7.md b/modules/brk-client/docs/type-aliases/MetricPattern7.md index 4ca139220..72a2de3aa 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern7.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern7.md @@ -8,7 +8,7 @@ > **MetricPattern7**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:975](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L975) +Defined in: [Developer/brk/modules/brk-client/index.js:1139](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1139) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:975](https://github.com/b #### by.decadeindex -> **decadeindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **decadeindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:975](https://github.com/b #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern8.md b/modules/brk-client/docs/type-aliases/MetricPattern8.md index cf84934f8..ee08d6126 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern8.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern8.md @@ -8,7 +8,7 @@ > **MetricPattern8**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1006](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1006) +Defined in: [Developer/brk/modules/brk-client/index.js:1142](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1142) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1006](https://github.com/ #### by.difficultyepoch -> **difficultyepoch**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **difficultyepoch**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1006](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/MetricPattern9.md b/modules/brk-client/docs/type-aliases/MetricPattern9.md index 7ec8434a4..7d02ad51a 100644 --- a/modules/brk-client/docs/type-aliases/MetricPattern9.md +++ b/modules/brk-client/docs/type-aliases/MetricPattern9.md @@ -8,7 +8,7 @@ > **MetricPattern9**\<`T`\> = `object` -Defined in: [Developer/brk/modules/brk-client/index.js:1037](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L1037) +Defined in: [Developer/brk/modules/brk-client/index.js:1145](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L1145) ## Type Parameters @@ -24,11 +24,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1037](https://github.com/ #### by.emptyoutputindex -> **emptyoutputindex**: [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> +> `readonly` **emptyoutputindex**: [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> ### get() -> **get**: (`index`) => [`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +> **get**: (`index`) => [`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` #### Parameters @@ -38,15 +38,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1037](https://github.com/ #### Returns -[`MetricEndpoint`](../interfaces/MetricEndpoint.md)\<`T`\> \| `undefined` +[`MetricEndpointBuilder`](../interfaces/MetricEndpointBuilder.md)\<`T`\> \| `undefined` ### indexes() -> **indexes**: () => [`Index`](Index.md)[] +> **indexes**: () => readonly [`Index`](Index.md)[] #### Returns -[`Index`](Index.md)[] +readonly [`Index`](Index.md)[] ### name diff --git a/modules/brk-client/docs/type-aliases/Metrics.md b/modules/brk-client/docs/type-aliases/Metrics.md index 50734695a..c55b363c9 100644 --- a/modules/brk-client/docs/type-aliases/Metrics.md +++ b/modules/brk-client/docs/type-aliases/Metrics.md @@ -8,6 +8,6 @@ > **Metrics**\<\> = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:277](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L277) +Defined in: [Developer/brk/modules/brk-client/index.js:422](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L422) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/MonthIndex.md b/modules/brk-client/docs/type-aliases/MonthIndex.md index 9c2e1f664..2a2ed76d0 100644 --- a/modules/brk-client/docs/type-aliases/MonthIndex.md +++ b/modules/brk-client/docs/type-aliases/MonthIndex.md @@ -8,6 +8,6 @@ > **MonthIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:278](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L278) +Defined in: [Developer/brk/modules/brk-client/index.js:424](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L424) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/OpReturnIndex.md b/modules/brk-client/docs/type-aliases/OpReturnIndex.md index a09e54126..bea2026fe 100644 --- a/modules/brk-client/docs/type-aliases/OpReturnIndex.md +++ b/modules/brk-client/docs/type-aliases/OpReturnIndex.md @@ -8,6 +8,6 @@ > **OpReturnIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:300](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L300) +Defined in: [Developer/brk/modules/brk-client/index.js:452](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L452) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Open.md b/modules/brk-client/docs/type-aliases/Open.md index 3a92d6009..48a334f6d 100644 --- a/modules/brk-client/docs/type-aliases/Open.md +++ b/modules/brk-client/docs/type-aliases/Open.md @@ -8,6 +8,6 @@ > **Open**\<\> = [`Cents`](Cents.md) -Defined in: [Developer/brk/modules/brk-client/index.js:301](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L301) +Defined in: [Developer/brk/modules/brk-client/index.js:456](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L456) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/OutPoint.md b/modules/brk-client/docs/type-aliases/OutPoint.md index 4178e606c..81ca21306 100644 --- a/modules/brk-client/docs/type-aliases/OutPoint.md +++ b/modules/brk-client/docs/type-aliases/OutPoint.md @@ -8,6 +8,6 @@ > **OutPoint**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:302](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L302) +Defined in: [Developer/brk/modules/brk-client/index.js:458](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L458) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/OutputType.md b/modules/brk-client/docs/type-aliases/OutputType.md index be5a223f3..74353bc86 100644 --- a/modules/brk-client/docs/type-aliases/OutputType.md +++ b/modules/brk-client/docs/type-aliases/OutputType.md @@ -8,6 +8,6 @@ > **OutputType**\<\> = `"p2pk65"` \| `"p2pk33"` \| `"p2pkh"` \| `"p2ms"` \| `"p2sh"` \| `"opreturn"` \| `"p2wpkh"` \| `"p2wsh"` \| `"p2tr"` \| `"p2a"` \| `"empty"` \| `"unknown"` -Defined in: [Developer/brk/modules/brk-client/index.js:303](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L303) +Defined in: [Developer/brk/modules/brk-client/index.js:462](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L462) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2AAddressIndex.md b/modules/brk-client/docs/type-aliases/P2AAddressIndex.md index 51706e952..a2c6f8f37 100644 --- a/modules/brk-client/docs/type-aliases/P2AAddressIndex.md +++ b/modules/brk-client/docs/type-aliases/P2AAddressIndex.md @@ -8,6 +8,6 @@ > **P2AAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:304](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L304) +Defined in: [Developer/brk/modules/brk-client/index.js:464](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L464) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2ABytes.md b/modules/brk-client/docs/type-aliases/P2ABytes.md index e0a5eb12d..bfb0f0e8a 100644 --- a/modules/brk-client/docs/type-aliases/P2ABytes.md +++ b/modules/brk-client/docs/type-aliases/P2ABytes.md @@ -8,6 +8,6 @@ > **P2ABytes**\<\> = [`U8x2`](U8x2.md) -Defined in: [Developer/brk/modules/brk-client/index.js:305](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L305) +Defined in: [Developer/brk/modules/brk-client/index.js:465](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L465) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2MSOutputIndex.md b/modules/brk-client/docs/type-aliases/P2MSOutputIndex.md index 4fc5a20a5..928504b5e 100644 --- a/modules/brk-client/docs/type-aliases/P2MSOutputIndex.md +++ b/modules/brk-client/docs/type-aliases/P2MSOutputIndex.md @@ -8,6 +8,6 @@ > **P2MSOutputIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:306](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L306) +Defined in: [Developer/brk/modules/brk-client/index.js:466](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L466) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PK33AddressIndex.md b/modules/brk-client/docs/type-aliases/P2PK33AddressIndex.md index 0705e3438..949bf67cc 100644 --- a/modules/brk-client/docs/type-aliases/P2PK33AddressIndex.md +++ b/modules/brk-client/docs/type-aliases/P2PK33AddressIndex.md @@ -8,6 +8,6 @@ > **P2PK33AddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:307](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L307) +Defined in: [Developer/brk/modules/brk-client/index.js:467](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L467) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PK33Bytes.md b/modules/brk-client/docs/type-aliases/P2PK33Bytes.md index 9ff1e8d30..9d9f5eb10 100644 --- a/modules/brk-client/docs/type-aliases/P2PK33Bytes.md +++ b/modules/brk-client/docs/type-aliases/P2PK33Bytes.md @@ -8,6 +8,6 @@ > **P2PK33Bytes**\<\> = [`U8x33`](U8x33.md) -Defined in: [Developer/brk/modules/brk-client/index.js:308](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L308) +Defined in: [Developer/brk/modules/brk-client/index.js:468](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L468) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PK65AddressIndex.md b/modules/brk-client/docs/type-aliases/P2PK65AddressIndex.md index 65ea1375a..ecbbcdf33 100644 --- a/modules/brk-client/docs/type-aliases/P2PK65AddressIndex.md +++ b/modules/brk-client/docs/type-aliases/P2PK65AddressIndex.md @@ -8,6 +8,6 @@ > **P2PK65AddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:309](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L309) +Defined in: [Developer/brk/modules/brk-client/index.js:469](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L469) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PK65Bytes.md b/modules/brk-client/docs/type-aliases/P2PK65Bytes.md index 2ae77c41d..c65d2a5b1 100644 --- a/modules/brk-client/docs/type-aliases/P2PK65Bytes.md +++ b/modules/brk-client/docs/type-aliases/P2PK65Bytes.md @@ -8,6 +8,6 @@ > **P2PK65Bytes**\<\> = [`U8x65`](U8x65.md) -Defined in: [Developer/brk/modules/brk-client/index.js:310](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L310) +Defined in: [Developer/brk/modules/brk-client/index.js:470](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L470) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PKHAddressIndex.md b/modules/brk-client/docs/type-aliases/P2PKHAddressIndex.md index 21da192cd..0ad76b0ad 100644 --- a/modules/brk-client/docs/type-aliases/P2PKHAddressIndex.md +++ b/modules/brk-client/docs/type-aliases/P2PKHAddressIndex.md @@ -8,6 +8,6 @@ > **P2PKHAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:311](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L311) +Defined in: [Developer/brk/modules/brk-client/index.js:471](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L471) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2PKHBytes.md b/modules/brk-client/docs/type-aliases/P2PKHBytes.md index bbc61710f..4ee731b10 100644 --- a/modules/brk-client/docs/type-aliases/P2PKHBytes.md +++ b/modules/brk-client/docs/type-aliases/P2PKHBytes.md @@ -8,6 +8,6 @@ > **P2PKHBytes**\<\> = [`U8x20`](U8x20.md) -Defined in: [Developer/brk/modules/brk-client/index.js:312](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L312) +Defined in: [Developer/brk/modules/brk-client/index.js:472](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L472) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2SHAddressIndex.md b/modules/brk-client/docs/type-aliases/P2SHAddressIndex.md index 564855f62..ff651d2bd 100644 --- a/modules/brk-client/docs/type-aliases/P2SHAddressIndex.md +++ b/modules/brk-client/docs/type-aliases/P2SHAddressIndex.md @@ -8,6 +8,6 @@ > **P2SHAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:313](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L313) +Defined in: [Developer/brk/modules/brk-client/index.js:473](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L473) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2SHBytes.md b/modules/brk-client/docs/type-aliases/P2SHBytes.md index da5a9db87..a25407623 100644 --- a/modules/brk-client/docs/type-aliases/P2SHBytes.md +++ b/modules/brk-client/docs/type-aliases/P2SHBytes.md @@ -8,6 +8,6 @@ > **P2SHBytes**\<\> = [`U8x20`](U8x20.md) -Defined in: [Developer/brk/modules/brk-client/index.js:314](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L314) +Defined in: [Developer/brk/modules/brk-client/index.js:474](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L474) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2TRAddressIndex.md b/modules/brk-client/docs/type-aliases/P2TRAddressIndex.md index 3ef791b96..3deb3e85f 100644 --- a/modules/brk-client/docs/type-aliases/P2TRAddressIndex.md +++ b/modules/brk-client/docs/type-aliases/P2TRAddressIndex.md @@ -8,6 +8,6 @@ > **P2TRAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:315](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L315) +Defined in: [Developer/brk/modules/brk-client/index.js:475](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L475) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2TRBytes.md b/modules/brk-client/docs/type-aliases/P2TRBytes.md index 1c1be4b50..84fb642f7 100644 --- a/modules/brk-client/docs/type-aliases/P2TRBytes.md +++ b/modules/brk-client/docs/type-aliases/P2TRBytes.md @@ -8,6 +8,6 @@ > **P2TRBytes**\<\> = [`U8x32`](U8x32.md) -Defined in: [Developer/brk/modules/brk-client/index.js:316](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L316) +Defined in: [Developer/brk/modules/brk-client/index.js:476](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L476) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2WPKHAddressIndex.md b/modules/brk-client/docs/type-aliases/P2WPKHAddressIndex.md index 36d7b122e..cdbc194eb 100644 --- a/modules/brk-client/docs/type-aliases/P2WPKHAddressIndex.md +++ b/modules/brk-client/docs/type-aliases/P2WPKHAddressIndex.md @@ -8,6 +8,6 @@ > **P2WPKHAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:317](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L317) +Defined in: [Developer/brk/modules/brk-client/index.js:477](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L477) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2WPKHBytes.md b/modules/brk-client/docs/type-aliases/P2WPKHBytes.md index e5c2272e7..b5e8c9c78 100644 --- a/modules/brk-client/docs/type-aliases/P2WPKHBytes.md +++ b/modules/brk-client/docs/type-aliases/P2WPKHBytes.md @@ -8,6 +8,6 @@ > **P2WPKHBytes**\<\> = [`U8x20`](U8x20.md) -Defined in: [Developer/brk/modules/brk-client/index.js:318](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L318) +Defined in: [Developer/brk/modules/brk-client/index.js:478](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L478) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2WSHAddressIndex.md b/modules/brk-client/docs/type-aliases/P2WSHAddressIndex.md index 75d8496b5..9a60a75bb 100644 --- a/modules/brk-client/docs/type-aliases/P2WSHAddressIndex.md +++ b/modules/brk-client/docs/type-aliases/P2WSHAddressIndex.md @@ -8,6 +8,6 @@ > **P2WSHAddressIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:319](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L319) +Defined in: [Developer/brk/modules/brk-client/index.js:479](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L479) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/P2WSHBytes.md b/modules/brk-client/docs/type-aliases/P2WSHBytes.md index 4dad36788..66fcd3358 100644 --- a/modules/brk-client/docs/type-aliases/P2WSHBytes.md +++ b/modules/brk-client/docs/type-aliases/P2WSHBytes.md @@ -8,6 +8,6 @@ > **P2WSHBytes**\<\> = [`U8x32`](U8x32.md) -Defined in: [Developer/brk/modules/brk-client/index.js:320](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L320) +Defined in: [Developer/brk/modules/brk-client/index.js:480](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L480) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/PoolSlug.md b/modules/brk-client/docs/type-aliases/PoolSlug.md index 6c209dbc4..77d3921ef 100644 --- a/modules/brk-client/docs/type-aliases/PoolSlug.md +++ b/modules/brk-client/docs/type-aliases/PoolSlug.md @@ -8,6 +8,6 @@ > **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"` -Defined in: [Developer/brk/modules/brk-client/index.js:366](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L366) +Defined in: [Developer/brk/modules/brk-client/index.js:540](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L540) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/QuarterIndex.md b/modules/brk-client/docs/type-aliases/QuarterIndex.md index 8bae3b0eb..03e337c52 100644 --- a/modules/brk-client/docs/type-aliases/QuarterIndex.md +++ b/modules/brk-client/docs/type-aliases/QuarterIndex.md @@ -8,6 +8,6 @@ > **QuarterIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:388](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L388) +Defined in: [Developer/brk/modules/brk-client/index.js:566](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L566) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/RawLockTime.md b/modules/brk-client/docs/type-aliases/RawLockTime.md index 1c37db014..ada736a9b 100644 --- a/modules/brk-client/docs/type-aliases/RawLockTime.md +++ b/modules/brk-client/docs/type-aliases/RawLockTime.md @@ -8,6 +8,6 @@ > **RawLockTime**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:389](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L389) +Defined in: [Developer/brk/modules/brk-client/index.js:570](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L570) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Sats.md b/modules/brk-client/docs/type-aliases/Sats.md index 9d989d285..27d14f0db 100644 --- a/modules/brk-client/docs/type-aliases/Sats.md +++ b/modules/brk-client/docs/type-aliases/Sats.md @@ -8,6 +8,6 @@ > **Sats**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:406](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L406) +Defined in: [Developer/brk/modules/brk-client/index.js:595](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L595) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/SemesterIndex.md b/modules/brk-client/docs/type-aliases/SemesterIndex.md index c7055286c..4f0f5f440 100644 --- a/modules/brk-client/docs/type-aliases/SemesterIndex.md +++ b/modules/brk-client/docs/type-aliases/SemesterIndex.md @@ -8,6 +8,6 @@ > **SemesterIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:407](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L407) +Defined in: [Developer/brk/modules/brk-client/index.js:597](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L597) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredBool.md b/modules/brk-client/docs/type-aliases/StoredBool.md index f1cc64f95..1ebb98553 100644 --- a/modules/brk-client/docs/type-aliases/StoredBool.md +++ b/modules/brk-client/docs/type-aliases/StoredBool.md @@ -8,6 +8,6 @@ > **StoredBool**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:408](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L408) +Defined in: [Developer/brk/modules/brk-client/index.js:601](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L601) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredF32.md b/modules/brk-client/docs/type-aliases/StoredF32.md index ac7ba39b6..27a129c94 100644 --- a/modules/brk-client/docs/type-aliases/StoredF32.md +++ b/modules/brk-client/docs/type-aliases/StoredF32.md @@ -8,6 +8,6 @@ > **StoredF32**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:409](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L409) +Defined in: [Developer/brk/modules/brk-client/index.js:606](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L606) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredF64.md b/modules/brk-client/docs/type-aliases/StoredF64.md index cf41623ad..6b9383f50 100644 --- a/modules/brk-client/docs/type-aliases/StoredF64.md +++ b/modules/brk-client/docs/type-aliases/StoredF64.md @@ -8,6 +8,6 @@ > **StoredF64**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:410](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L410) +Defined in: [Developer/brk/modules/brk-client/index.js:611](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L611) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredI16.md b/modules/brk-client/docs/type-aliases/StoredI16.md index 0863e60f5..ca859b4ed 100644 --- a/modules/brk-client/docs/type-aliases/StoredI16.md +++ b/modules/brk-client/docs/type-aliases/StoredI16.md @@ -8,6 +8,6 @@ > **StoredI16**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:411](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L411) +Defined in: [Developer/brk/modules/brk-client/index.js:613](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L613) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredU16.md b/modules/brk-client/docs/type-aliases/StoredU16.md index 5883c0d79..641ef30e3 100644 --- a/modules/brk-client/docs/type-aliases/StoredU16.md +++ b/modules/brk-client/docs/type-aliases/StoredU16.md @@ -8,6 +8,6 @@ > **StoredU16**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:412](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L412) +Defined in: [Developer/brk/modules/brk-client/index.js:614](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L614) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredU32.md b/modules/brk-client/docs/type-aliases/StoredU32.md index 4b9450f72..268ce2cf5 100644 --- a/modules/brk-client/docs/type-aliases/StoredU32.md +++ b/modules/brk-client/docs/type-aliases/StoredU32.md @@ -8,6 +8,6 @@ > **StoredU32**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:413](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L413) +Defined in: [Developer/brk/modules/brk-client/index.js:618](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L618) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/StoredU64.md b/modules/brk-client/docs/type-aliases/StoredU64.md index 6b07fb3c2..236137a13 100644 --- a/modules/brk-client/docs/type-aliases/StoredU64.md +++ b/modules/brk-client/docs/type-aliases/StoredU64.md @@ -8,6 +8,6 @@ > **StoredU64**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:414](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L414) +Defined in: [Developer/brk/modules/brk-client/index.js:623](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L623) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Thenable.md b/modules/brk-client/docs/type-aliases/Thenable.md new file mode 100644 index 000000000..3455e5156 --- /dev/null +++ b/modules/brk-client/docs/type-aliases/Thenable.md @@ -0,0 +1,31 @@ +[**brk-client**](../README.md) + +*** + +[brk-client](../globals.md) / Thenable + +# Type Alias: Thenable()\ + +> **Thenable**\<`T`\> = (`onfulfilled?`, `onrejected?`) => `Promise`\<[`MetricData`](../interfaces/MetricData.md)\<`T`\>\> + +Defined in: [Developer/brk/modules/brk-client/index.js:842](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L842) + +## Type Parameters + +### T + +`T` + +## Parameters + +### onfulfilled? + +(`value`) => [`MetricData`](../interfaces/MetricData.md)\<`T`\> + +### onrejected? + +(`reason`) => `never` + +## Returns + +`Promise`\<[`MetricData`](../interfaces/MetricData.md)\<`T`\>\> diff --git a/modules/brk-client/docs/type-aliases/TimePeriod.md b/modules/brk-client/docs/type-aliases/TimePeriod.md index bebaf4bbb..b7b9e49b3 100644 --- a/modules/brk-client/docs/type-aliases/TimePeriod.md +++ b/modules/brk-client/docs/type-aliases/TimePeriod.md @@ -8,6 +8,6 @@ > **TimePeriod**\<\> = `"24h"` \| `"3d"` \| `"1w"` \| `"1m"` \| `"3m"` \| `"6m"` \| `"1y"` \| `"2y"` \| `"3y"` -Defined in: [Developer/brk/modules/brk-client/index.js:420](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L420) +Defined in: [Developer/brk/modules/brk-client/index.js:648](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L648) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Timestamp.md b/modules/brk-client/docs/type-aliases/Timestamp.md index 5760aea9c..250b61971 100644 --- a/modules/brk-client/docs/type-aliases/Timestamp.md +++ b/modules/brk-client/docs/type-aliases/Timestamp.md @@ -8,6 +8,6 @@ > **Timestamp**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:425](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L425) +Defined in: [Developer/brk/modules/brk-client/index.js:657](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L657) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TreeNode.md b/modules/brk-client/docs/type-aliases/TreeNode.md index 3375ee370..b69bf1fbc 100644 --- a/modules/brk-client/docs/type-aliases/TreeNode.md +++ b/modules/brk-client/docs/type-aliases/TreeNode.md @@ -8,6 +8,6 @@ > **TreeNode**\<\> = \{\[`key`: `string`\]: `TreeNode`; \} \| [`MetricLeafWithSchema`](../interfaces/MetricLeafWithSchema.md) -Defined in: [Developer/brk/modules/brk-client/index.js:444](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L444) +Defined in: [Developer/brk/modules/brk-client/index.js:682](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L682) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TxInIndex.md b/modules/brk-client/docs/type-aliases/TxInIndex.md index fedbaac7b..e3e277c08 100644 --- a/modules/brk-client/docs/type-aliases/TxInIndex.md +++ b/modules/brk-client/docs/type-aliases/TxInIndex.md @@ -8,6 +8,6 @@ > **TxInIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:456](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L456) +Defined in: [Developer/brk/modules/brk-client/index.js:697](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L697) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TxIndex.md b/modules/brk-client/docs/type-aliases/TxIndex.md index 6ca581d6d..275ad8a66 100644 --- a/modules/brk-client/docs/type-aliases/TxIndex.md +++ b/modules/brk-client/docs/type-aliases/TxIndex.md @@ -8,6 +8,6 @@ > **TxIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:457](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L457) +Defined in: [Developer/brk/modules/brk-client/index.js:698](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L698) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TxOutIndex.md b/modules/brk-client/docs/type-aliases/TxOutIndex.md index 58fd3695f..72566ccfb 100644 --- a/modules/brk-client/docs/type-aliases/TxOutIndex.md +++ b/modules/brk-client/docs/type-aliases/TxOutIndex.md @@ -8,6 +8,6 @@ > **TxOutIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:463](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L463) +Defined in: [Developer/brk/modules/brk-client/index.js:706](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L706) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TxVersion.md b/modules/brk-client/docs/type-aliases/TxVersion.md index f8b1b6d34..4831a5543 100644 --- a/modules/brk-client/docs/type-aliases/TxVersion.md +++ b/modules/brk-client/docs/type-aliases/TxVersion.md @@ -8,6 +8,6 @@ > **TxVersion**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:478](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L478) +Defined in: [Developer/brk/modules/brk-client/index.js:728](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L728) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Txid.md b/modules/brk-client/docs/type-aliases/Txid.md index 0bf5ccef8..9b8ec87c7 100644 --- a/modules/brk-client/docs/type-aliases/Txid.md +++ b/modules/brk-client/docs/type-aliases/Txid.md @@ -8,6 +8,6 @@ > **Txid**\<\> = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:479](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L479) +Defined in: [Developer/brk/modules/brk-client/index.js:733](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L733) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/TypeIndex.md b/modules/brk-client/docs/type-aliases/TypeIndex.md index cb027e359..63c12fecd 100644 --- a/modules/brk-client/docs/type-aliases/TypeIndex.md +++ b/modules/brk-client/docs/type-aliases/TypeIndex.md @@ -8,6 +8,6 @@ > **TypeIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:489](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L489) +Defined in: [Developer/brk/modules/brk-client/index.js:749](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L749) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/U8x2.md b/modules/brk-client/docs/type-aliases/U8x2.md index 300cbfb99..00e490f58 100644 --- a/modules/brk-client/docs/type-aliases/U8x2.md +++ b/modules/brk-client/docs/type-aliases/U8x2.md @@ -8,6 +8,6 @@ > **U8x2**\<\> = `number`[] -Defined in: [Developer/brk/modules/brk-client/index.js:490](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L490) +Defined in: [Developer/brk/modules/brk-client/index.js:751](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L751) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/U8x20.md b/modules/brk-client/docs/type-aliases/U8x20.md index 3d7d9c67f..ea1997a03 100644 --- a/modules/brk-client/docs/type-aliases/U8x20.md +++ b/modules/brk-client/docs/type-aliases/U8x20.md @@ -8,6 +8,6 @@ > **U8x20**\<\> = `number`[] -Defined in: [Developer/brk/modules/brk-client/index.js:491](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L491) +Defined in: [Developer/brk/modules/brk-client/index.js:752](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L752) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/U8x32.md b/modules/brk-client/docs/type-aliases/U8x32.md index 7f7abfc52..a09acb578 100644 --- a/modules/brk-client/docs/type-aliases/U8x32.md +++ b/modules/brk-client/docs/type-aliases/U8x32.md @@ -8,6 +8,6 @@ > **U8x32**\<\> = `number`[] -Defined in: [Developer/brk/modules/brk-client/index.js:492](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L492) +Defined in: [Developer/brk/modules/brk-client/index.js:753](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L753) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/U8x33.md b/modules/brk-client/docs/type-aliases/U8x33.md index 203ec7614..cc9218d48 100644 --- a/modules/brk-client/docs/type-aliases/U8x33.md +++ b/modules/brk-client/docs/type-aliases/U8x33.md @@ -8,6 +8,6 @@ > **U8x33**\<\> = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:493](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L493) +Defined in: [Developer/brk/modules/brk-client/index.js:754](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L754) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/U8x65.md b/modules/brk-client/docs/type-aliases/U8x65.md index c7289351a..8a5247bf4 100644 --- a/modules/brk-client/docs/type-aliases/U8x65.md +++ b/modules/brk-client/docs/type-aliases/U8x65.md @@ -8,6 +8,6 @@ > **U8x65**\<\> = `string` -Defined in: [Developer/brk/modules/brk-client/index.js:494](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L494) +Defined in: [Developer/brk/modules/brk-client/index.js:755](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L755) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/UnknownOutputIndex.md b/modules/brk-client/docs/type-aliases/UnknownOutputIndex.md index 50a5f3463..176529fd8 100644 --- a/modules/brk-client/docs/type-aliases/UnknownOutputIndex.md +++ b/modules/brk-client/docs/type-aliases/UnknownOutputIndex.md @@ -8,6 +8,6 @@ > **UnknownOutputIndex**\<\> = [`TypeIndex`](TypeIndex.md) -Defined in: [Developer/brk/modules/brk-client/index.js:495](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L495) +Defined in: [Developer/brk/modules/brk-client/index.js:756](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L756) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/VSize.md b/modules/brk-client/docs/type-aliases/VSize.md index 1d914b554..a8716664e 100644 --- a/modules/brk-client/docs/type-aliases/VSize.md +++ b/modules/brk-client/docs/type-aliases/VSize.md @@ -8,6 +8,6 @@ > **VSize**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:503](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L503) +Defined in: [Developer/brk/modules/brk-client/index.js:769](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L769) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Vin.md b/modules/brk-client/docs/type-aliases/Vin.md index e0e77243d..213ba15d0 100644 --- a/modules/brk-client/docs/type-aliases/Vin.md +++ b/modules/brk-client/docs/type-aliases/Vin.md @@ -8,6 +8,6 @@ > **Vin**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:508](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L508) +Defined in: [Developer/brk/modules/brk-client/index.js:778](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L778) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Vout.md b/modules/brk-client/docs/type-aliases/Vout.md index c3abc4a5a..9e02002b0 100644 --- a/modules/brk-client/docs/type-aliases/Vout.md +++ b/modules/brk-client/docs/type-aliases/Vout.md @@ -8,6 +8,6 @@ > **Vout**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:509](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L509) +Defined in: [Developer/brk/modules/brk-client/index.js:783](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L783) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/WeekIndex.md b/modules/brk-client/docs/type-aliases/WeekIndex.md index e0236786c..b95fbcc58 100644 --- a/modules/brk-client/docs/type-aliases/WeekIndex.md +++ b/modules/brk-client/docs/type-aliases/WeekIndex.md @@ -8,6 +8,6 @@ > **WeekIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:510](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L510) +Defined in: [Developer/brk/modules/brk-client/index.js:785](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L785) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/Weight.md b/modules/brk-client/docs/type-aliases/Weight.md index ae1df151b..37e67e6b9 100644 --- a/modules/brk-client/docs/type-aliases/Weight.md +++ b/modules/brk-client/docs/type-aliases/Weight.md @@ -8,6 +8,6 @@ > **Weight**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:511](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L511) +Defined in: [Developer/brk/modules/brk-client/index.js:789](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L789) ## Type Parameters diff --git a/modules/brk-client/docs/type-aliases/YearIndex.md b/modules/brk-client/docs/type-aliases/YearIndex.md index d87476020..ef5b6a943 100644 --- a/modules/brk-client/docs/type-aliases/YearIndex.md +++ b/modules/brk-client/docs/type-aliases/YearIndex.md @@ -8,6 +8,6 @@ > **YearIndex**\<\> = `number` -Defined in: [Developer/brk/modules/brk-client/index.js:512](https://github.com/bitcoinresearchkit/brk/blob/6f45ec13f3a9e84728abdaed03e8c5432df5ffa3/modules/brk-client/index.js#L512) +Defined in: [Developer/brk/modules/brk-client/index.js:791](https://github.com/bitcoinresearchkit/brk/blob/8a938c00f6edf1f447532c02f94f3a13fd7da30e/modules/brk-client/index.js#L791) ## Type Parameters diff --git a/modules/brk-client/package.json b/modules/brk-client/package.json index 3e30d64ed..9ae66d295 100644 --- a/modules/brk-client/package.json +++ b/modules/brk-client/package.json @@ -3,7 +3,8 @@ "url": "https://github.com/bitcoinresearchkit/brk/issues" }, "scripts": { - "test": "node tests/basic.js", + "test": "node tests/basic.js && node tests/tree.js", + "test:basic": "node tests/basic.js", "test:tree": "node tests/tree.js" }, "description": "BRK JavaScript client", diff --git a/modules/brk-client/scripts/docs.sh b/modules/brk-client/scripts/docs.sh deleted file mode 100755 index 54e4bd864..000000000 --- a/modules/brk-client/scripts/docs.sh +++ /dev/null @@ -1 +0,0 @@ -npx -p typedoc -p typedoc-plugin-markdown typedoc index.js --plugin typedoc-plugin-markdown --out docs --excludeNotDocumented diff --git a/packages/brk_client/DOCS.md b/packages/brk_client/DOCS.md index b5a0d925a..bf38c3e35 100644 --- a/packages/brk_client/DOCS.md +++ b/packages/brk_client/DOCS.md @@ -3,7 +3,6 @@ * [brk\_client](#brk_client) * [BrkError](#brk_client.BrkError) * [MetricData](#brk_client.MetricData) - * [MetricEndpoint](#brk_client.MetricEndpoint) * [BrkClient](#brk_client.BrkClient) * [VERSION](#brk_client.BrkClient.VERSION) * [INDEXES](#brk_client.BrkClient.INDEXES) @@ -19,51 +18,55 @@ * [GE\_AMOUNT\_NAMES](#brk_client.BrkClient.GE_AMOUNT_NAMES) * [LT\_AMOUNT\_NAMES](#brk_client.BrkClient.LT_AMOUNT_NAMES) * [\_\_init\_\_](#brk_client.BrkClient.__init__) + * [metric](#brk_client.BrkClient.metric) * [get\_address](#brk_client.BrkClient.get_address) * [get\_address\_txs](#brk_client.BrkClient.get_address_txs) - * [get\_address\_txs\_chain](#brk_client.BrkClient.get_address_txs_chain) - * [get\_address\_txs\_mempool](#brk_client.BrkClient.get_address_txs_mempool) - * [get\_address\_utxo](#brk_client.BrkClient.get_address_utxo) - * [get\_block\_height](#brk_client.BrkClient.get_block_height) - * [get\_block\_by\_hash](#brk_client.BrkClient.get_block_by_hash) - * [get\_block\_by\_hash\_raw](#brk_client.BrkClient.get_block_by_hash_raw) - * [get\_block\_by\_hash\_status](#brk_client.BrkClient.get_block_by_hash_status) - * [get\_block\_by\_hash\_txid\_by\_index](#brk_client.BrkClient.get_block_by_hash_txid_by_index) - * [get\_block\_by\_hash\_txids](#brk_client.BrkClient.get_block_by_hash_txids) - * [get\_block\_by\_hash\_txs\_by\_start\_index](#brk_client.BrkClient.get_block_by_hash_txs_by_start_index) + * [get\_address\_confirmed\_txs](#brk_client.BrkClient.get_address_confirmed_txs) + * [get\_address\_mempool\_txs](#brk_client.BrkClient.get_address_mempool_txs) + * [get\_address\_utxos](#brk_client.BrkClient.get_address_utxos) + * [get\_block\_by\_height](#brk_client.BrkClient.get_block_by_height) + * [get\_block](#brk_client.BrkClient.get_block) + * [get\_block\_raw](#brk_client.BrkClient.get_block_raw) + * [get\_block\_status](#brk_client.BrkClient.get_block_status) + * [get\_block\_txid](#brk_client.BrkClient.get_block_txid) + * [get\_block\_txids](#brk_client.BrkClient.get_block_txids) + * [get\_block\_txs](#brk_client.BrkClient.get_block_txs) * [get\_blocks](#brk_client.BrkClient.get_blocks) - * [get\_blocks\_by\_height](#brk_client.BrkClient.get_blocks_by_height) - * [get\_mempool\_info](#brk_client.BrkClient.get_mempool_info) + * [get\_blocks\_from\_height](#brk_client.BrkClient.get_blocks_from_height) + * [get\_mempool](#brk_client.BrkClient.get_mempool) * [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\_metric\_by\_index](#brk_client.BrkClient.get_metric_by_index) - * [get\_metrics\_bulk](#brk_client.BrkClient.get_metrics_bulk) - * [get\_metrics\_catalog](#brk_client.BrkClient.get_metrics_catalog) + * [get\_metrics\_tree](#brk_client.BrkClient.get_metrics_tree) + * [get\_metrics](#brk_client.BrkClient.get_metrics) * [get\_metrics\_count](#brk_client.BrkClient.get_metrics_count) - * [get\_metrics\_indexes](#brk_client.BrkClient.get_metrics_indexes) - * [get\_metrics\_list](#brk_client.BrkClient.get_metrics_list) - * [get\_metrics\_search\_by\_metric](#brk_client.BrkClient.get_metrics_search_by_metric) - * [get\_tx\_by\_txid](#brk_client.BrkClient.get_tx_by_txid) - * [get\_tx\_by\_txid\_hex](#brk_client.BrkClient.get_tx_by_txid_hex) - * [get\_tx\_by\_txid\_outspend\_by\_vout](#brk_client.BrkClient.get_tx_by_txid_outspend_by_vout) - * [get\_tx\_by\_txid\_outspends](#brk_client.BrkClient.get_tx_by_txid_outspends) - * [get\_tx\_by\_txid\_status](#brk_client.BrkClient.get_tx_by_txid_status) - * [get\_v1\_difficulty\_adjustment](#brk_client.BrkClient.get_v1_difficulty_adjustment) - * [get\_v1\_fees\_mempool\_blocks](#brk_client.BrkClient.get_v1_fees_mempool_blocks) - * [get\_v1\_fees\_recommended](#brk_client.BrkClient.get_v1_fees_recommended) - * [get\_v1\_mining\_blocks\_fees\_by\_time\_period](#brk_client.BrkClient.get_v1_mining_blocks_fees_by_time_period) - * [get\_v1\_mining\_blocks\_rewards\_by\_time\_period](#brk_client.BrkClient.get_v1_mining_blocks_rewards_by_time_period) - * [get\_v1\_mining\_blocks\_sizes\_weights\_by\_time\_period](#brk_client.BrkClient.get_v1_mining_blocks_sizes_weights_by_time_period) - * [get\_v1\_mining\_blocks\_timestamp](#brk_client.BrkClient.get_v1_mining_blocks_timestamp) - * [get\_v1\_mining\_difficulty\_adjustments](#brk_client.BrkClient.get_v1_mining_difficulty_adjustments) - * [get\_v1\_mining\_difficulty\_adjustments\_by\_time\_period](#brk_client.BrkClient.get_v1_mining_difficulty_adjustments_by_time_period) - * [get\_v1\_mining\_hashrate](#brk_client.BrkClient.get_v1_mining_hashrate) - * [get\_v1\_mining\_hashrate\_by\_time\_period](#brk_client.BrkClient.get_v1_mining_hashrate_by_time_period) - * [get\_v1\_mining\_pool\_by\_slug](#brk_client.BrkClient.get_v1_mining_pool_by_slug) - * [get\_v1\_mining\_pools](#brk_client.BrkClient.get_v1_mining_pools) - * [get\_v1\_mining\_pools\_by\_time\_period](#brk_client.BrkClient.get_v1_mining_pools_by_time_period) - * [get\_v1\_mining\_reward\_stats\_by\_block\_count](#brk_client.BrkClient.get_v1_mining_reward_stats_by_block_count) - * [get\_v1\_validate\_address](#brk_client.BrkClient.get_v1_validate_address) + * [get\_indexes](#brk_client.BrkClient.get_indexes) + * [list\_metrics](#brk_client.BrkClient.list_metrics) + * [search\_metrics](#brk_client.BrkClient.search_metrics) + * [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) + * [get\_tx\_hex](#brk_client.BrkClient.get_tx_hex) + * [get\_tx\_outspend](#brk_client.BrkClient.get_tx_outspend) + * [get\_tx\_outspends](#brk_client.BrkClient.get_tx_outspends) + * [get\_tx\_status](#brk_client.BrkClient.get_tx_status) + * [get\_difficulty\_adjustment](#brk_client.BrkClient.get_difficulty_adjustment) + * [get\_mempool\_blocks](#brk_client.BrkClient.get_mempool_blocks) + * [get\_recommended\_fees](#brk_client.BrkClient.get_recommended_fees) + * [get\_block\_fee\_rates](#brk_client.BrkClient.get_block_fee_rates) + * [get\_block\_fees](#brk_client.BrkClient.get_block_fees) + * [get\_block\_rewards](#brk_client.BrkClient.get_block_rewards) + * [get\_block\_sizes\_weights](#brk_client.BrkClient.get_block_sizes_weights) + * [get\_block\_by\_timestamp](#brk_client.BrkClient.get_block_by_timestamp) + * [get\_difficulty\_adjustments](#brk_client.BrkClient.get_difficulty_adjustments) + * [get\_difficulty\_adjustments\_by\_period](#brk_client.BrkClient.get_difficulty_adjustments_by_period) + * [get\_hashrate](#brk_client.BrkClient.get_hashrate) + * [get\_hashrate\_by\_period](#brk_client.BrkClient.get_hashrate_by_period) + * [get\_pool](#brk_client.BrkClient.get_pool) + * [get\_pools](#brk_client.BrkClient.get_pools) + * [get\_pool\_stats](#brk_client.BrkClient.get_pool_stats) + * [get\_reward\_stats](#brk_client.BrkClient.get_reward_stats) + * [validate\_address](#brk_client.BrkClient.validate_address) * [get\_health](#brk_client.BrkClient.get_health) * [get\_version](#brk_client.BrkClient.get_version) @@ -91,16 +94,6 @@ class MetricData(TypedDict, Generic[T]) Metric data with range information. - - -## MetricEndpoint Objects - -```python -class MetricEndpoint(Generic[T]) -``` - -An endpoint for a specific metric + index combination. - ## BrkClient Objects @@ -109,7 +102,7 @@ An endpoint for a specific metric + index combination. class BrkClient(BrkClientBase) ``` -Main BRK client with catalog tree and API methods. +Main BRK client with metrics tree and API methods. @@ -168,9 +161,22 @@ Main BRK client with catalog tree and API methods. #### \_\_init\_\_ ```python -def __init__(base_url: str = 'http://localhost:3000', timeout: float = 30.0) +def __init__(base_url: str = "http://localhost:3000", timeout: float = 30.0) ``` + + +#### metric + +```python +def metric(metric: str, index: Index) -> MetricEndpointBuilder[Any] +``` + +Create a dynamic metric endpoint builder for any metric/index combination. + +Use this for programmatic access when the metric name is determined at runtime. +For type-safe access, use the `metrics` tree instead. + #### get\_address @@ -181,7 +187,11 @@ def get_address(address: Address) -> AddressStats Address information. -Retrieve comprehensive information about a Bitcoin address including balance, transaction history, UTXOs, and estimated investment metrics. Supports all standard Bitcoin address types (P2PKH, P2SH, P2WPKH, P2WSH, P2TR, etc.). +Retrieve address information including balance and transaction counts. Supports all standard Bitcoin address types (P2PKH, P2SH, P2WPKH, P2WSH, P2TR). + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address)* + +Endpoint: `GET /api/address/{address}` @@ -190,136 +200,179 @@ Retrieve comprehensive information about a Bitcoin address including balance, tr ```python def get_address_txs(address: Address, after_txid: Optional[str] = None, - limit: Optional[int] = None) -> List[Txid] + limit: Optional[float] = None) -> List[Txid] ``` Address transaction IDs. Get transaction IDs for an address, newest first. Use after_txid for pagination. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions)* -#### get\_address\_txs\_chain +Endpoint: `GET /api/address/{address}/txs` + + + +#### get\_address\_confirmed\_txs ```python -def get_address_txs_chain(address: Address, - after_txid: Optional[str] = None, - limit: Optional[int] = None) -> List[Txid] +def get_address_confirmed_txs(address: Address, + after_txid: Optional[str] = None, + limit: Optional[float] = None) -> List[Txid] ``` Address confirmed transactions. Get confirmed transaction IDs for an address, 25 per page. Use ?after_txid= for pagination. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions-chain)* -#### get\_address\_txs\_mempool +Endpoint: `GET /api/address/{address}/txs/chain` + + + +#### get\_address\_mempool\_txs ```python -def get_address_txs_mempool(address: Address) -> List[Txid] +def get_address_mempool_txs(address: Address) -> List[Txid] ``` Address mempool transactions. Get unconfirmed transaction IDs for an address from the mempool (up to 50). - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions-mempool)* -#### get\_address\_utxo +Endpoint: `GET /api/address/{address}/txs/mempool` + + + +#### get\_address\_utxos ```python -def get_address_utxo(address: Address) -> List[Utxo] +def get_address_utxos(address: Address) -> List[Utxo] ``` Address UTXOs. -Get unspent transaction outputs for an address. +Get unspent transaction outputs (UTXOs) for an address. Returns txid, vout, value, and confirmation status for each UTXO. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-utxo)* -#### get\_block\_height +Endpoint: `GET /api/address/{address}/utxo` + + + +#### get\_block\_by\_height ```python -def get_block_height(height: Height) -> BlockInfo +def get_block_by_height(height: Height) -> BlockInfo ``` Block by height. Retrieve block information by block height. Returns block metadata including hash, timestamp, difficulty, size, weight, and transaction count. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-height)* -#### get\_block\_by\_hash +Endpoint: `GET /api/block-height/{height}` + + + +#### get\_block ```python -def get_block_by_hash(hash: BlockHash) -> BlockInfo +def get_block(hash: BlockHash) -> BlockInfo ``` Block information. Retrieve block information by block hash. Returns block metadata including height, timestamp, difficulty, size, weight, and transaction count. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block)* -#### get\_block\_by\_hash\_raw +Endpoint: `GET /api/block/{hash}` + + + +#### get\_block\_raw ```python -def get_block_by_hash_raw(hash: BlockHash) -> List[int] +def get_block_raw(hash: BlockHash) -> List[float] ``` Raw block. Returns the raw block data in binary format. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-raw)* -#### get\_block\_by\_hash\_status +Endpoint: `GET /api/block/{hash}/raw` + + + +#### get\_block\_status ```python -def get_block_by_hash_status(hash: BlockHash) -> BlockStatus +def get_block_status(hash: BlockHash) -> BlockStatus ``` Block status. Retrieve the status of a block. Returns whether the block is in the best chain and, if so, its height and the hash of the next block. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-status)* -#### get\_block\_by\_hash\_txid\_by\_index +Endpoint: `GET /api/block/{hash}/status` + + + +#### get\_block\_txid ```python -def get_block_by_hash_txid_by_index(hash: BlockHash, index: TxIndex) -> Txid +def get_block_txid(hash: BlockHash, index: TxIndex) -> Txid ``` Transaction ID at index. Retrieve a single transaction ID at a specific index within a block. Returns plain text txid. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-transaction-id)* -#### get\_block\_by\_hash\_txids +Endpoint: `GET /api/block/{hash}/txid/{index}` + + + +#### get\_block\_txids ```python -def get_block_by_hash_txids(hash: BlockHash) -> List[Txid] +def get_block_txids(hash: BlockHash) -> List[Txid] ``` Block transaction IDs. -Retrieve all transaction IDs in a block by block hash. +Retrieve all transaction IDs in a block. Returns an array of txids in block order. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-transaction-ids)* -#### get\_block\_by\_hash\_txs\_by\_start\_index +Endpoint: `GET /api/block/{hash}/txids` + + + +#### get\_block\_txs ```python -def get_block_by_hash_txs_by_start_index( - hash: BlockHash, start_index: TxIndex) -> List[Transaction] +def get_block_txs(hash: BlockHash, start_index: TxIndex) -> List[Transaction] ``` Block transactions (paginated). Retrieve transactions in a block by block hash, starting from the specified index. Returns up to 25 transactions at a time. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-transactions)* + +Endpoint: `GET /api/block/{hash}/txs/{start_index}` + #### get\_blocks @@ -332,30 +385,42 @@ Recent blocks. Retrieve the last 10 blocks. Returns block metadata for each block. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-blocks)* -#### get\_blocks\_by\_height +Endpoint: `GET /api/blocks` + + + +#### get\_blocks\_from\_height ```python -def get_blocks_by_height(height: Height) -> List[BlockInfo] +def get_blocks_from_height(height: Height) -> List[BlockInfo] ``` Blocks from height. Retrieve up to 10 blocks going backwards from the given height. For example, height=100 returns blocks 100, 99, 98, ..., 91. Height=0 returns only block 0. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-blocks)* -#### get\_mempool\_info +Endpoint: `GET /api/blocks/{height}` + + + +#### get\_mempool ```python -def get_mempool_info() -> MempoolInfo +def get_mempool() -> MempoolInfo ``` Mempool statistics. Get current mempool statistics including transaction count, total vsize, and total fees. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool)* + +Endpoint: `GET /api/mempool/info` + #### get\_mempool\_txids @@ -368,63 +433,76 @@ Mempool transaction IDs. Get all transaction IDs currently in the mempool. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool-transaction-ids)* + +Endpoint: `GET /api/mempool/txids` + + + +#### get\_metric\_info + +```python +def get_metric_info(metric: Metric) -> List[Index] +``` + +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}` + #### get\_metric ```python -def get_metric(metric: Metric) -> List[Index] -``` - -Get supported indexes for a metric. - -Returns the list of indexes are supported by the specified metric. For example, `realized_price` might be available on dateindex, weekindex, and monthindex. - - - -#### get\_metric\_by\_index - -```python -def get_metric_by_index(index: Index, - metric: Metric, - count: Optional[Any] = None, - format: Optional[Format] = None, - from_: Optional[Any] = None, - to: Optional[Any] = None) -> AnyMetricData +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\_bulk + + +#### get\_metrics\_tree ```python -def get_metrics_bulk(index: Index, - metrics: Metrics, - count: Optional[Any] = None, - format: Optional[Format] = None, - from_: Optional[Any] = None, - to: Optional[Any] = None) -> List[AnyMetricData] -``` - -Bulk metric data. - -Fetch multiple metrics in a single request. Supports filtering by index and date range. Returns an array of MetricData objects. - - - -#### get\_metrics\_catalog - -```python -def get_metrics_catalog() -> TreeNode +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. Best viewed in an interactive JSON viewer (e.g., Firefox's built-in JSON viewer) for easy navigation of the nested structure. +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, + index: Index, + start: Optional[float] = None, + end: Optional[float] = None, + limit: Optional[str] = None, + format: Optional[Format] = None) -> Union[List[AnyMetricData], str] +``` + +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` @@ -436,304 +514,434 @@ def get_metrics_count() -> List[MetricCount] Metric count. -Current metric count +Returns the number of metrics available per index type. - +Endpoint: `GET /api/metrics/count` -#### get\_metrics\_indexes + + +#### get\_indexes ```python -def get_metrics_indexes() -> List[IndexInfo] +def get_indexes() -> List[IndexInfo] ``` List available indexes. Returns all available indexes with their accepted query aliases. Use any alias when querying metrics. - +Endpoint: `GET /api/metrics/indexes` -#### get\_metrics\_list + + +#### list\_metrics ```python -def get_metrics_list(page: Optional[Any] = None) -> PaginatedMetrics +def list_metrics(page: Optional[float] = None) -> PaginatedMetrics ``` Metrics list. -Paginated list of available metrics +Paginated flat list of all available metric names. Use `page` query param for pagination. - +Endpoint: `GET /api/metrics/list` -#### get\_metrics\_search\_by\_metric + + +#### search\_metrics ```python -def get_metrics_search_by_metric(metric: Metric, - limit: Optional[Limit] = None - ) -> List[Metric] +def search_metrics(metric: Metric, + limit: Optional[Limit] = None) -> List[Metric] ``` Search metrics. Fuzzy search for metrics by name. Supports partial matches and typos. - +Endpoint: `GET /api/metrics/search/{metric}` -#### get\_tx\_by\_txid + + +#### get\_disk\_usage ```python -def get_tx_by_txid(txid: Txid) -> Transaction +def get_disk_usage() -> DiskUsage +``` + +Disk usage. + +Returns the disk space used by BRK and Bitcoin data. + +Endpoint: `GET /api/server/disk` + + + +#### get\_sync\_status + +```python +def get_sync_status() -> SyncStatus +``` + +Sync status. + +Returns the sync status of the indexer, including indexed height, tip height, blocks behind, and last indexed timestamp. + +Endpoint: `GET /api/server/sync` + + + +#### get\_tx + +```python +def get_tx(txid: Txid) -> Transaction ``` Transaction information. -Retrieve complete transaction data by transaction ID (txid). Returns the full transaction details including inputs, outputs, and metadata. The transaction data is read directly from the blockchain data files. +Retrieve complete transaction data by transaction ID (txid). Returns inputs, outputs, fee, size, and confirmation status. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction)* -#### get\_tx\_by\_txid\_hex +Endpoint: `GET /api/tx/{txid}` + + + +#### get\_tx\_hex ```python -def get_tx_by_txid_hex(txid: Txid) -> Hex +def get_tx_hex(txid: Txid) -> Hex ``` Transaction hex. Retrieve the raw transaction as a hex-encoded string. Returns the serialized transaction in hexadecimal format. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-hex)* -#### get\_tx\_by\_txid\_outspend\_by\_vout +Endpoint: `GET /api/tx/{txid}/hex` + + + +#### get\_tx\_outspend ```python -def get_tx_by_txid_outspend_by_vout(txid: Txid, vout: Vout) -> TxOutspend +def get_tx_outspend(txid: Txid, vout: Vout) -> TxOutspend ``` Output spend status. Get the spending status of a transaction output. Returns whether the output has been spent and, if so, the spending transaction details. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-outspend)* -#### get\_tx\_by\_txid\_outspends +Endpoint: `GET /api/tx/{txid}/outspend/{vout}` + + + +#### get\_tx\_outspends ```python -def get_tx_by_txid_outspends(txid: Txid) -> List[TxOutspend] +def get_tx_outspends(txid: Txid) -> List[TxOutspend] ``` All output spend statuses. Get the spending status of all outputs in a transaction. Returns an array with the spend status for each output. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-outspends)* -#### get\_tx\_by\_txid\_status +Endpoint: `GET /api/tx/{txid}/outspends` + + + +#### get\_tx\_status ```python -def get_tx_by_txid_status(txid: Txid) -> TxStatus +def get_tx_status(txid: Txid) -> TxStatus ``` Transaction status. Retrieve the confirmation status of a transaction. Returns whether the transaction is confirmed and, if so, the block height, hash, and timestamp. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-status)* -#### get\_v1\_difficulty\_adjustment +Endpoint: `GET /api/tx/{txid}/status` + + + +#### get\_difficulty\_adjustment ```python -def get_v1_difficulty_adjustment() -> DifficultyAdjustment +def get_difficulty_adjustment() -> DifficultyAdjustment ``` Difficulty adjustment. Get current difficulty adjustment information including progress through the current epoch, estimated retarget date, and difficulty change prediction. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-difficulty-adjustment)* -#### get\_v1\_fees\_mempool\_blocks +Endpoint: `GET /api/v1/difficulty-adjustment` + + + +#### get\_mempool\_blocks ```python -def get_v1_fees_mempool_blocks() -> List[MempoolBlock] +def get_mempool_blocks() -> List[MempoolBlock] ``` Projected mempool blocks. Get projected blocks from the mempool for fee estimation. Each block contains statistics about transactions that would be included if a block were mined now. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool-blocks-fees)* -#### get\_v1\_fees\_recommended +Endpoint: `GET /api/v1/fees/mempool-blocks` + + + +#### get\_recommended\_fees ```python -def get_v1_fees_recommended() -> RecommendedFees +def get_recommended_fees() -> RecommendedFees ``` Recommended fees. Get recommended fee rates for different confirmation targets based on current mempool state. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-recommended-fees)* -#### get\_v1\_mining\_blocks\_fees\_by\_time\_period +Endpoint: `GET /api/v1/fees/recommended` + + + +#### get\_block\_fee\_rates ```python -def get_v1_mining_blocks_fees_by_time_period( - time_period: TimePeriod) -> List[BlockFeesEntry] +def get_block_fee_rates(time_period: TimePeriod) -> Any +``` + +Block fee rates (WIP). + +**Work in progress.** Get block fee rate percentiles (min, 10th, 25th, median, 75th, 90th, max) for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y + +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-feerates)* + +Endpoint: `GET /api/v1/mining/blocks/fee-rates/{time_period}` + + + +#### get\_block\_fees + +```python +def get_block_fees(time_period: TimePeriod) -> List[BlockFeesEntry] ``` Block fees. Get average block fees for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-fees)* -#### get\_v1\_mining\_blocks\_rewards\_by\_time\_period +Endpoint: `GET /api/v1/mining/blocks/fees/{time_period}` + + + +#### get\_block\_rewards ```python -def get_v1_mining_blocks_rewards_by_time_period( - time_period: TimePeriod) -> List[BlockRewardsEntry] +def get_block_rewards(time_period: TimePeriod) -> List[BlockRewardsEntry] ``` Block rewards. Get average block rewards (coinbase = subsidy + fees) for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-rewards)* -#### get\_v1\_mining\_blocks\_sizes\_weights\_by\_time\_period +Endpoint: `GET /api/v1/mining/blocks/rewards/{time_period}` + + + +#### get\_block\_sizes\_weights ```python -def get_v1_mining_blocks_sizes_weights_by_time_period( - time_period: TimePeriod) -> BlockSizesWeights +def get_block_sizes_weights(time_period: TimePeriod) -> BlockSizesWeights ``` Block sizes and weights. Get average block sizes and weights for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-sizes-weights)* -#### get\_v1\_mining\_blocks\_timestamp +Endpoint: `GET /api/v1/mining/blocks/sizes-weights/{time_period}` + + + +#### get\_block\_by\_timestamp ```python -def get_v1_mining_blocks_timestamp(timestamp: Timestamp) -> BlockTimestamp +def get_block_by_timestamp(timestamp: Timestamp) -> BlockTimestamp ``` Block by timestamp. Find the block closest to a given UNIX timestamp. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-timestamp)* -#### get\_v1\_mining\_difficulty\_adjustments +Endpoint: `GET /api/v1/mining/blocks/timestamp/{timestamp}` + + + +#### get\_difficulty\_adjustments ```python -def get_v1_mining_difficulty_adjustments() -> List[DifficultyAdjustmentEntry] +def get_difficulty_adjustments() -> List[DifficultyAdjustmentEntry] ``` Difficulty adjustments (all time). -Get historical difficulty adjustments. Returns array of [timestamp, height, difficulty, change_percent]. +Get historical difficulty adjustments including timestamp, block height, difficulty value, and percentage change. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-difficulty-adjustments)* -#### get\_v1\_mining\_difficulty\_adjustments\_by\_time\_period +Endpoint: `GET /api/v1/mining/difficulty-adjustments` + + + +#### get\_difficulty\_adjustments\_by\_period ```python -def get_v1_mining_difficulty_adjustments_by_time_period( +def get_difficulty_adjustments_by_period( time_period: TimePeriod) -> List[DifficultyAdjustmentEntry] ``` Difficulty adjustments. -Get historical difficulty adjustments for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y. Returns array of [timestamp, height, difficulty, change_percent]. +Get historical difficulty adjustments for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-difficulty-adjustments)* -#### get\_v1\_mining\_hashrate +Endpoint: `GET /api/v1/mining/difficulty-adjustments/{time_period}` + + + +#### get\_hashrate ```python -def get_v1_mining_hashrate() -> HashrateSummary +def get_hashrate() -> HashrateSummary ``` Network hashrate (all time). Get network hashrate and difficulty data for all time. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-hashrate)* -#### get\_v1\_mining\_hashrate\_by\_time\_period +Endpoint: `GET /api/v1/mining/hashrate` + + + +#### get\_hashrate\_by\_period ```python -def get_v1_mining_hashrate_by_time_period( - time_period: TimePeriod) -> HashrateSummary +def get_hashrate_by_period(time_period: TimePeriod) -> HashrateSummary ``` Network hashrate. Get network hashrate and difficulty data for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-hashrate)* -#### get\_v1\_mining\_pool\_by\_slug +Endpoint: `GET /api/v1/mining/hashrate/{time_period}` + + + +#### get\_pool ```python -def get_v1_mining_pool_by_slug(slug: PoolSlug) -> PoolDetail +def get_pool(slug: PoolSlug) -> PoolDetail ``` Mining pool details. Get detailed information about a specific mining pool including block counts and shares for different time periods. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mining-pool)* -#### get\_v1\_mining\_pools +Endpoint: `GET /api/v1/mining/pool/{slug}` + + + +#### get\_pools ```python -def get_v1_mining_pools() -> List[PoolInfo] +def get_pools() -> List[PoolInfo] ``` List all mining pools. Get list of all known mining pools with their identifiers. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mining-pools)* -#### get\_v1\_mining\_pools\_by\_time\_period +Endpoint: `GET /api/v1/mining/pools` + + + +#### get\_pool\_stats ```python -def get_v1_mining_pools_by_time_period( - time_period: TimePeriod) -> PoolsSummary +def get_pool_stats(time_period: TimePeriod) -> PoolsSummary ``` Mining pool statistics. Get mining pool statistics for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-mining-pools)* -#### get\_v1\_mining\_reward\_stats\_by\_block\_count +Endpoint: `GET /api/v1/mining/pools/{time_period}` + + + +#### get\_reward\_stats ```python -def get_v1_mining_reward_stats_by_block_count(block_count: int) -> RewardStats +def get_reward_stats(block_count: float) -> RewardStats ``` Mining reward statistics. Get mining reward statistics for the last N blocks including total rewards, fees, and transaction count. - +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-reward-stats)* -#### get\_v1\_validate\_address +Endpoint: `GET /api/v1/mining/reward-stats/{block_count}` + + + +#### validate\_address ```python -def get_v1_validate_address(address: str) -> AddressValidation +def validate_address(address: str) -> AddressValidation ``` Validate address. Validate a Bitcoin address and get information about its type and scriptPubKey. +*[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-validate)* + +Endpoint: `GET /api/v1/validate-address/{address}` + #### get\_health @@ -744,7 +952,9 @@ def get_health() -> Health Health check. -Returns the health status of the API server +Returns the health status of the API server, including uptime information. + +Endpoint: `GET /health` @@ -758,3 +968,5 @@ API version. Returns the current version of the API server +Endpoint: `GET /version` + diff --git a/packages/brk_client/README.md b/packages/brk_client/README.md index 7443bb281..bb2895c46 100644 --- a/packages/brk_client/README.md +++ b/packages/brk_client/README.md @@ -8,6 +8,8 @@ Python client for the [Bitcoin Research Kit](https://github.com/bitcoinresearchk ```bash pip install brk-client +# or +uv add brk-client ``` ## Quick Start @@ -15,7 +17,8 @@ pip install brk-client ```python from brk_client import BrkClient -client = BrkClient("http://localhost:3110") +# Use the free public API or your own instance +client = BrkClient("https://bitview.space") # Blockchain data (mempool.space compatible) block = client.get_block_by_height(800000) @@ -25,14 +28,24 @@ address = client.get_address("bc1q...") # Metrics API - typed, chainable prices = client.metrics.price.usd.split.close \ .by.dateindex() \ - .range(-30) # Last 30 days + .tail(30) \ + .fetch() # Last 30 items # Generic metric fetching data = client.get_metric("price_close", "dateindex", -30) ``` +## API + +```python +# Range methods +.head(n) # First n items +.tail(n) # Last n items +.fetch() # Execute the request +``` + ## Configuration ```python -client = BrkClient("http://localhost:3110", timeout=60.0) +client = BrkClient("https://bitview.space", timeout=60.0) ``` diff --git a/packages/brk_client/brk_client/__init__.py b/packages/brk_client/brk_client/__init__.py index d4664f887..5cfa8aa83 100644 --- a/packages/brk_client/brk_client/__init__.py +++ b/packages/brk_client/brk_client/__init__.py @@ -1,12 +1,23 @@ # Auto-generated BRK Python client # Do not edit manually -from typing import TypeVar, Generic, Any, Optional, List, Literal, TypedDict, Union, Protocol, overload -from http.client import HTTPSConnection, HTTPConnection -from urllib.parse import urlparse import json +from http.client import HTTPConnection, HTTPSConnection +from typing import ( + Any, + Generic, + List, + Literal, + Optional, + Protocol, + TypedDict, + TypeVar, + Union, + overload, +) +from urllib.parse import urlparse -T = TypeVar('T') +T = TypeVar("T") # Type definitions @@ -71,7 +82,20 @@ Open = Cents OpReturnIndex = TypeIndex OutPoint = int # Type (P2PKH, P2WPKH, P2SH, P2TR, etc.) -OutputType = Literal["p2pk65", "p2pk33", "p2pkh", "p2ms", "p2sh", "opreturn", "p2wpkh", "p2wsh", "p2tr", "p2a", "empty", "unknown"] +OutputType = Literal[ + "p2pk65", + "p2pk33", + "p2pkh", + "p2ms", + "p2sh", + "opreturn", + "p2wpkh", + "p2wsh", + "p2tr", + "p2a", + "empty", + "unknown", +] P2AAddressIndex = TypeIndex U8x2 = List[int] P2ABytes = U8x2 @@ -94,7 +118,166 @@ P2WPKHAddressIndex = TypeIndex P2WPKHBytes = U8x20 P2WSHAddressIndex = TypeIndex P2WSHBytes = U8x32 -PoolSlug = Literal["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 = Literal[ + "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", +] QuarterIndex = int # Transaction locktime RawLockTime = int @@ -112,7 +295,7 @@ StoredU32 = int # Fixed-size 64-bit unsigned integer optimized for on-disk storage StoredU64 = int # Time period for mining statistics. -# +# # Used to specify the lookback window for pool statistics, hashrate calculations, # and other time-based mining metrics. TimePeriod = Literal["24h", "3d", "1w", "1m", "3m", "6m", "1y", "2y", "3y"] @@ -129,13 +312,43 @@ WeekIndex = int YearIndex = int # Aggregation dimension for querying metrics. Includes time-based (date, week, month, year), # block-based (height, txindex), and address/output type indexes. -Index = Literal["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", "loadedaddressindex", "emptyaddressindex"] +Index = Literal[ + "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", + "loadedaddressindex", + "emptyaddressindex", +] # Hierarchical tree node for organizing metrics into categories TreeNode = Union[dict[str, "TreeNode"], "MetricLeafWithSchema"] + + class AddressChainStats(TypedDict): """ Address statistics on the blockchain (confirmed transactions only) - + Based on mempool.space's format with type_index extension. Attributes: @@ -146,6 +359,7 @@ class AddressChainStats(TypedDict): tx_count: Total number of confirmed transactions involving this address type_index: Index of this address within its type on the blockchain """ + funded_txo_count: int funded_txo_sum: Sats spent_txo_count: int @@ -153,10 +367,11 @@ class AddressChainStats(TypedDict): tx_count: int type_index: TypeIndex + class AddressMempoolStats(TypedDict): """ Address statistics in the mempool (unconfirmed transactions only) - + Based on mempool.space's format. Attributes: @@ -166,15 +381,18 @@ class AddressMempoolStats(TypedDict): spent_txo_sum: Total amount in satoshis being spent in unconfirmed transactions tx_count: Number of unconfirmed transactions involving this address """ + funded_txo_count: int funded_txo_sum: Sats spent_txo_count: int spent_txo_sum: Sats tx_count: int + class AddressParam(TypedDict): address: Address + class AddressStats(TypedDict): """ Address information compatible with mempool.space API format @@ -184,19 +402,23 @@ class AddressStats(TypedDict): chain_stats: Statistics for confirmed transactions on the blockchain mempool_stats: Statistics for unconfirmed transactions in the mempool """ + address: Address chain_stats: AddressChainStats mempool_stats: Union[AddressMempoolStats, None] + class AddressTxidsParam(TypedDict): """ Attributes: after_txid: Txid to paginate from (return transactions before this one) limit: Maximum number of results to return. Defaults to 25 if not specified. """ + after_txid: Union[Txid, None] limit: int + class AddressValidation(TypedDict): """ Address validation result @@ -210,6 +432,7 @@ class AddressValidation(TypedDict): witness_version: Witness version (0 for P2WPKH/P2WSH, 1 for P2TR) witness_program: Witness program in hex """ + isvalid: bool address: Optional[str] scriptPubKey: Optional[str] @@ -218,42 +441,52 @@ class AddressValidation(TypedDict): witness_version: Optional[int] witness_program: Optional[str] + class BlockCountParam(TypedDict): """ Attributes: block_count: Number of recent blocks to include """ + block_count: int + class BlockFeesEntry(TypedDict): """ A single block fees data point. """ + avgHeight: Height timestamp: Timestamp avgFees: Sats + class BlockHashParam(TypedDict): hash: BlockHash + class BlockHashStartIndex(TypedDict): """ Attributes: hash: Bitcoin block hash start_index: Starting transaction index within the block (0-based) """ + hash: BlockHash start_index: TxIndex + class BlockHashTxIndex(TypedDict): """ Attributes: hash: Bitcoin block hash index: Transaction index within the block (0-based) """ + hash: BlockHash index: TxIndex + class BlockInfo(TypedDict): """ Block information returned by the API @@ -267,6 +500,7 @@ class BlockInfo(TypedDict): timestamp: Block timestamp (Unix time) difficulty: Block difficulty as a floating point number """ + id: BlockHash height: Height tx_count: int @@ -275,37 +509,46 @@ class BlockInfo(TypedDict): timestamp: Timestamp difficulty: float + class BlockRewardsEntry(TypedDict): """ A single block rewards data point. """ + avgHeight: int timestamp: int avgRewards: int + class BlockSizeEntry(TypedDict): """ A single block size data point. """ + avgHeight: int timestamp: int avgSize: int + class BlockWeightEntry(TypedDict): """ A single block weight data point. """ + avgHeight: int timestamp: int avgWeight: int + class BlockSizesWeights(TypedDict): """ Combined block sizes and weights response. """ + sizes: List[BlockSizeEntry] weights: List[BlockWeightEntry] + class BlockStatus(TypedDict): """ Block status indicating whether block is in the best chain @@ -315,10 +558,12 @@ class BlockStatus(TypedDict): height: Block height (only if in best chain) next_best: Hash of the next block in the best chain (only if in best chain and not tip) """ + in_best_chain: bool height: Union[Height, None] next_best: Union[BlockHash, None] + class BlockTimestamp(TypedDict): """ Block information returned for timestamp queries @@ -328,10 +573,12 @@ class BlockTimestamp(TypedDict): hash: Block hash timestamp: Block timestamp in ISO 8601 format """ + height: Height hash: BlockHash timestamp: str + class DataRangeFormat(TypedDict): """ Data range with output format for API query parameters @@ -342,11 +589,13 @@ class DataRangeFormat(TypedDict): limit: Maximum number of values to return (ignored if `end` is set) format: Format of the output """ + start: Optional[int] end: Optional[int] limit: Union[Limit, None] format: Format + class DifficultyAdjustment(TypedDict): """ Difficulty adjustment information. @@ -363,6 +612,7 @@ class DifficultyAdjustment(TypedDict): adjustedTimeAvg: Time-adjusted average (accounting for timestamp manipulation) timeOffset: Time offset from expected schedule (seconds) """ + progressPercent: float difficultyChange: float estimatedRetargetDate: int @@ -374,16 +624,19 @@ class DifficultyAdjustment(TypedDict): adjustedTimeAvg: int timeOffset: int + class DifficultyAdjustmentEntry(TypedDict): """ A single difficulty adjustment entry. Serializes as array: [timestamp, height, difficulty, change_percent] """ + timestamp: Timestamp height: Height difficulty: float change_percent: float + class DifficultyEntry(TypedDict): """ A single difficulty data point. @@ -393,10 +646,12 @@ class DifficultyEntry(TypedDict): difficulty: Difficulty value. height: Block height of the adjustment. """ + timestamp: Timestamp difficulty: float height: Height + class DiskUsage(TypedDict): """ Disk usage of the indexed data @@ -408,12 +663,14 @@ class DiskUsage(TypedDict): bitcoin_bytes: Bitcoin blocks directory size in bytes ratio: brk as percentage of Bitcoin data """ + brk: str brk_bytes: int bitcoin: str bitcoin_bytes: int ratio: float + class EmptyAddressData(TypedDict): """ Data of an empty address @@ -423,10 +680,12 @@ class EmptyAddressData(TypedDict): funded_txo_count: Total funded/spent transaction output count (equal since address is empty) transfered: Total satoshis transferred """ + tx_count: int funded_txo_count: int transfered: Sats + class HashrateEntry(TypedDict): """ A single hashrate data point. @@ -435,9 +694,11 @@ class HashrateEntry(TypedDict): timestamp: Unix timestamp. avgHashrate: Average hashrate (H/s). """ + timestamp: Timestamp avgHashrate: int + class HashrateSummary(TypedDict): """ Summary of network hashrate and difficulty data. @@ -448,11 +709,13 @@ class HashrateSummary(TypedDict): currentHashrate: Current network hashrate (H/s). currentDifficulty: Current network difficulty. """ + hashrates: List[HashrateEntry] difficulty: List[DifficultyEntry] currentHashrate: int currentDifficulty: float + class Health(TypedDict): """ Server health status @@ -461,15 +724,18 @@ class Health(TypedDict): started_at: Server start time (ISO 8601) uptime_seconds: Uptime in seconds """ + status: str service: str timestamp: str started_at: str uptime_seconds: int + class HeightParam(TypedDict): height: Height + class IndexInfo(TypedDict): """ Information about an available index and its query aliases @@ -478,12 +744,15 @@ class IndexInfo(TypedDict): index: The canonical index name aliases: All Accepted query aliases """ + index: Index aliases: List[str] + class LimitParam(TypedDict): limit: Limit + class LoadedAddressData(TypedDict): """ Data for a loaded (non-empty) address with current balance @@ -496,6 +765,7 @@ class LoadedAddressData(TypedDict): sent: Satoshis sent by this address realized_cap: The realized capitalization of this address """ + tx_count: int funded_txo_count: int spent_txo_count: int @@ -503,6 +773,7 @@ class LoadedAddressData(TypedDict): sent: Sats realized_cap: Dollars + class MempoolBlock(TypedDict): """ Block info in a mempool.space like format for fee estimation. @@ -515,6 +786,7 @@ class MempoolBlock(TypedDict): medianFee: Median fee rate in sat/vB feeRange: Fee rate range: [min, 10%, 25%, 50%, 75%, 90%, max] """ + blockSize: int blockVSize: float nTx: int @@ -522,6 +794,7 @@ class MempoolBlock(TypedDict): medianFee: FeeRate feeRange: List[FeeRate] + class MempoolInfo(TypedDict): """ Mempool statistics @@ -531,10 +804,12 @@ class MempoolInfo(TypedDict): vsize: Total virtual size of all transactions in the mempool (vbytes) total_fee: Total fees of all transactions in the mempool (satoshis) """ + count: int vsize: VSize total_fee: Sats + class MetricCount(TypedDict): """ Metric count statistics - distinct metrics and total metric-index combinations @@ -545,14 +820,17 @@ class MetricCount(TypedDict): lazy_endpoints: Number of lazy (computed on-the-fly) metric-index combinations stored_endpoints: Number of eager (stored on disk) metric-index combinations """ + distinct_metrics: int total_endpoints: int lazy_endpoints: int stored_endpoints: int + class MetricParam(TypedDict): metric: Metric + class MetricSelection(TypedDict): """ Selection of metrics to query @@ -565,6 +843,7 @@ class MetricSelection(TypedDict): limit: Maximum number of values to return (ignored if `end` is set) format: Format of the output """ + metrics: Metrics index: Index start: Optional[int] @@ -572,6 +851,7 @@ class MetricSelection(TypedDict): limit: Union[Limit, None] format: Format + class MetricSelectionLegacy(TypedDict): """ Legacy metric selection parameters (deprecated) @@ -582,6 +862,7 @@ class MetricSelectionLegacy(TypedDict): limit: Maximum number of values to return (ignored if `end` is set) format: Format of the output """ + index: Index ids: Metrics start: Optional[int] @@ -589,42 +870,51 @@ class MetricSelectionLegacy(TypedDict): limit: Union[Limit, None] format: Format + class MetricWithIndex(TypedDict): """ Attributes: metric: Metric name index: Aggregation index """ + metric: Metric index: Index + class OHLCCents(TypedDict): """ OHLC (Open, High, Low, Close) data in cents """ + open: Open high: High low: Low close: Close + class OHLCDollars(TypedDict): """ OHLC (Open, High, Low, Close) data in dollars """ + open: Open high: High low: Low close: Close + class OHLCSats(TypedDict): """ OHLC (Open, High, Low, Close) data in satoshis """ + open: Open high: High low: Low close: Close + class PaginatedMetrics(TypedDict): """ A paginated list of available metric names (1000 per page) @@ -634,10 +924,12 @@ class PaginatedMetrics(TypedDict): max_page: Maximum valid page index (0-indexed) metrics: List of metric names (max 1000 per page) """ + current_page: int max_page: int metrics: List[str] + class Pagination(TypedDict): """ Pagination parameters for paginated API endpoints @@ -645,8 +937,10 @@ class Pagination(TypedDict): Attributes: page: Pagination index """ + page: Optional[int] + class PoolBlockCounts(TypedDict): """ Block counts for different time periods @@ -656,10 +950,12 @@ class PoolBlockCounts(TypedDict): _24h: Blocks mined in last 24 hours _1w: Blocks mined in last week """ + all: int _24h: int _1w: int + class PoolBlockShares(TypedDict): """ Pool's share of total blocks for different time periods @@ -669,10 +965,12 @@ class PoolBlockShares(TypedDict): _24h: Share of blocks in last 24 hours _1w: Share of blocks in last week """ + all: float _24h: float _1w: float + class PoolDetailInfo(TypedDict): """ Pool information for detail view @@ -685,6 +983,7 @@ class PoolDetailInfo(TypedDict): regexes: Coinbase tag patterns (regexes) slug: URL-friendly pool identifier """ + id: int name: str link: str @@ -692,6 +991,7 @@ class PoolDetailInfo(TypedDict): regexes: List[str] slug: PoolSlug + class PoolDetail(TypedDict): """ Detailed pool information with statistics across time periods @@ -703,12 +1003,14 @@ class PoolDetail(TypedDict): estimatedHashrate: Estimated hashrate based on blocks mined reportedHashrate: Self-reported hashrate (if available) """ + pool: PoolDetailInfo blockCount: PoolBlockCounts blockShare: PoolBlockShares estimatedHashrate: int reportedHashrate: Optional[int] + class PoolInfo(TypedDict): """ Basic pool information for listing all pools @@ -718,13 +1020,16 @@ class PoolInfo(TypedDict): slug: URL-friendly pool identifier unique_id: Unique numeric pool identifier """ + name: str slug: PoolSlug unique_id: int + class PoolSlugParam(TypedDict): slug: PoolSlug + class PoolStats(TypedDict): """ Mining pool with block statistics for a time period @@ -739,6 +1044,7 @@ class PoolStats(TypedDict): slug: URL-friendly pool identifier share: Pool's share of total blocks (0.0 - 1.0) """ + poolId: int name: str link: str @@ -748,6 +1054,7 @@ class PoolStats(TypedDict): slug: PoolSlug share: float + class PoolsSummary(TypedDict): """ Mining pools response for a time period @@ -757,10 +1064,12 @@ class PoolsSummary(TypedDict): blockCount: Total blocks in the time period lastEstimatedHashrate: Estimated network hashrate (hashes per second) """ + pools: List[PoolStats] blockCount: int lastEstimatedHashrate: int + class RecommendedFees(TypedDict): """ Recommended fee rates in sat/vB @@ -772,12 +1081,14 @@ class RecommendedFees(TypedDict): economyFee: Fee rate for economical confirmation minimumFee: Minimum relay fee rate """ + fastestFee: FeeRate halfHourFee: FeeRate hourFee: FeeRate economyFee: FeeRate minimumFee: FeeRate + class RewardStats(TypedDict): """ Block reward statistics over a range of blocks @@ -786,12 +1097,14 @@ class RewardStats(TypedDict): startBlock: First block in the range endBlock: Last block in the range """ + startBlock: Height endBlock: Height totalReward: Sats totalFee: Sats totalTx: int + class SupplyState(TypedDict): """ Current supply state tracking UTXO count and total value @@ -800,9 +1113,11 @@ class SupplyState(TypedDict): utxo_count: Number of unspent transaction outputs value: Total value in satoshis """ + utxo_count: int value: Sats + class SyncStatus(TypedDict): """ Sync status of the indexer @@ -814,18 +1129,22 @@ class SyncStatus(TypedDict): last_indexed_at: Human-readable timestamp of the last indexed block (ISO 8601) last_indexed_at_unix: Unix timestamp of the last indexed block """ + indexed_height: Height tip_height: Height blocks_behind: Height last_indexed_at: str last_indexed_at_unix: Timestamp + class TimePeriodParam(TypedDict): time_period: TimePeriod + class TimestampParam(TypedDict): timestamp: Timestamp + class TxOut(TypedDict): """ Transaction output @@ -834,9 +1153,11 @@ class TxOut(TypedDict): scriptpubkey: Script pubkey (locking script) value: Value of the output in satoshis """ + scriptpubkey: str value: Sats + class TxIn(TypedDict): """ Transaction input @@ -850,6 +1171,7 @@ class TxIn(TypedDict): sequence: Input sequence number inner_redeemscript_asm: Inner redeemscript in assembly format (for P2SH-wrapped SegWit) """ + txid: Txid vout: Vout prevout: Union[TxOut, None] @@ -859,6 +1181,7 @@ class TxIn(TypedDict): sequence: int inner_redeemscript_asm: Optional[str] + class TxStatus(TypedDict): """ Transaction confirmation status @@ -869,11 +1192,13 @@ class TxStatus(TypedDict): block_hash: Block hash (only present if confirmed) block_time: Block timestamp (only present if confirmed) """ + confirmed: bool block_height: Union[Height, None] block_hash: Union[BlockHash, None] block_time: Union[Timestamp, None] + class Transaction(TypedDict): """ Transaction information compatible with mempool.space API format @@ -886,6 +1211,7 @@ class Transaction(TypedDict): vin: Transaction inputs vout: Transaction outputs """ + index: Union[TxIndex, None] txid: Txid version: TxVersion @@ -898,6 +1224,7 @@ class Transaction(TypedDict): vout: List[TxOut] status: TxStatus + class TxOutspend(TypedDict): """ Status of an output indicating whether it has been spent @@ -908,14 +1235,17 @@ class TxOutspend(TypedDict): vin: Input index in the spending transaction (only present if spent) status: Status of the spending transaction (only present if spent) """ + spent: bool txid: Union[Txid, None] vin: Union[Vin, None] status: Union[TxStatus, None] + class TxidParam(TypedDict): txid: Txid + class TxidVout(TypedDict): """ Transaction output reference (txid + output index) @@ -924,25 +1254,31 @@ class TxidVout(TypedDict): txid: Transaction ID vout: Output index """ + txid: Txid vout: Vout + class Utxo(TypedDict): """ Unspent transaction output """ + txid: Txid vout: Vout status: TxStatus value: Sats + class ValidateAddressParam(TypedDict): """ Attributes: address: Bitcoin address to validate (can be any string) """ + address: str + class MetricLeafWithSchema(TypedDict): """ MetricLeaf with JSON Schema for client generation @@ -953,6 +1289,7 @@ class MetricLeafWithSchema(TypedDict): indexes: Available indexes for this metric type: JSON Schema type (e.g., "integer", "number", "string", "boolean", "array", "object") """ + name: str kind: str indexes: List[Index] @@ -973,7 +1310,7 @@ class BrkClientBase: def __init__(self, base_url: str, timeout: float = 30.0): parsed = urlparse(base_url) self._host = parsed.netloc - self._secure = parsed.scheme == 'https' + self._secure = parsed.scheme == "https" self._timeout = timeout self._conn: Optional[Union[HTTPSConnection, HTTPConnection]] = None @@ -1023,7 +1360,8 @@ class BrkClientBase: def _m(acc: str, s: str) -> str: """Build metric name with suffix.""" - if not s: return acc + if not s: + return acc return f"{acc}_{s}" if acc else s @@ -1034,6 +1372,7 @@ def _p(prefix: str, acc: str) -> str: class MetricData(TypedDict, Generic[T]): """Metric data with range information.""" + total: int start: int end: int @@ -1046,14 +1385,21 @@ AnyMetricData = MetricData[Any] class _EndpointConfig: """Shared endpoint configuration.""" + client: BrkClientBase name: str index: Index start: Optional[int] end: Optional[int] - def __init__(self, client: BrkClientBase, name: str, index: Index, - start: Optional[int] = None, end: Optional[int] = None): + def __init__( + self, + client: BrkClientBase, + name: str, + index: Index, + start: Optional[int] = None, + end: Optional[int] = None, + ): self.client = client self.name = name self.index = index @@ -1079,7 +1425,7 @@ class _EndpointConfig: return self.client.get_json(self._build_path()) def get_csv(self) -> str: - return self.client.get_text(self._build_path(format='csv')) + return self.client.get_text(self._build_path(format="csv")) class RangeBuilder(Generic[T]): @@ -1121,10 +1467,15 @@ class SkippedBuilder(Generic[T]): def take(self, n: int) -> RangeBuilder[T]: """Take n items after the skipped position.""" start = self._config.start or 0 - return RangeBuilder(_EndpointConfig( - self._config.client, self._config.name, self._config.index, - start, start + n - )) + return RangeBuilder( + _EndpointConfig( + self._config.client, + self._config.name, + self._config.index, + start, + start + n, + ) + ) def fetch(self) -> MetricData[T]: """Fetch from skipped position to end.""" @@ -1169,7 +1520,9 @@ class MetricEndpointBuilder(Generic[T]): @overload def __getitem__(self, key: slice) -> RangeBuilder[T]: ... - def __getitem__(self, key: Union[int, slice]) -> Union[SingleItemBuilder[T], RangeBuilder[T]]: + def __getitem__( + self, key: Union[int, slice] + ) -> Union[SingleItemBuilder[T], RangeBuilder[T]]: """Access single item or slice. Examples: @@ -1179,36 +1532,49 @@ class MetricEndpointBuilder(Generic[T]): endpoint[100:110] # Range 100-109 """ if isinstance(key, int): - return SingleItemBuilder(_EndpointConfig( - self._config.client, self._config.name, self._config.index, - key, key + 1 - )) - return RangeBuilder(_EndpointConfig( - self._config.client, self._config.name, self._config.index, - key.start, key.stop - )) + return SingleItemBuilder( + _EndpointConfig( + self._config.client, + self._config.name, + self._config.index, + key, + key + 1, + ) + ) + return RangeBuilder( + _EndpointConfig( + self._config.client, + self._config.name, + self._config.index, + key.start, + key.stop, + ) + ) def head(self, n: int = 10) -> RangeBuilder[T]: """Get the first n items (pandas-style).""" - return RangeBuilder(_EndpointConfig( - self._config.client, self._config.name, self._config.index, - None, n - )) + return RangeBuilder( + _EndpointConfig( + self._config.client, self._config.name, self._config.index, None, n + ) + ) def tail(self, n: int = 10) -> RangeBuilder[T]: """Get the last n items (pandas-style).""" start, end = (None, 0) if n == 0 else (-n, None) - return RangeBuilder(_EndpointConfig( - self._config.client, self._config.name, self._config.index, - start, end - )) + return RangeBuilder( + _EndpointConfig( + self._config.client, self._config.name, self._config.index, start, end + ) + ) def skip(self, n: int) -> SkippedBuilder[T]: """Skip the first n items. Chain with take() to get a range.""" - return SkippedBuilder(_EndpointConfig( - self._config.client, self._config.name, self._config.index, - n, None - )) + return SkippedBuilder( + _EndpointConfig( + self._config.client, self._config.name, self._config.index, n, None + ) + ) def fetch(self) -> MetricData[T]: """Fetch all data as parsed JSON.""" @@ -1245,2587 +1611,4600 @@ class MetricPattern(Protocol[T]): # Static index tuples -_i1 = ('dateindex', 'decadeindex', 'difficultyepoch', 'height', 'monthindex', 'quarterindex', 'semesterindex', 'weekindex', 'yearindex') -_i2 = ('dateindex', 'decadeindex', 'difficultyepoch', 'monthindex', 'quarterindex', 'semesterindex', 'weekindex', 'yearindex') -_i3 = ('dateindex', 'decadeindex', 'height', 'monthindex', 'quarterindex', 'semesterindex', 'weekindex', 'yearindex') -_i4 = ('dateindex', 'decadeindex', 'monthindex', 'quarterindex', 'semesterindex', 'weekindex', 'yearindex') -_i5 = ('dateindex', 'height') -_i6 = ('dateindex',) -_i7 = ('decadeindex',) -_i8 = ('difficultyepoch',) -_i9 = ('emptyoutputindex',) -_i10 = ('halvingepoch',) -_i11 = ('height',) -_i12 = ('txinindex',) -_i13 = ('monthindex',) -_i14 = ('opreturnindex',) -_i15 = ('txoutindex',) -_i16 = ('p2aaddressindex',) -_i17 = ('p2msoutputindex',) -_i18 = ('p2pk33addressindex',) -_i19 = ('p2pk65addressindex',) -_i20 = ('p2pkhaddressindex',) -_i21 = ('p2shaddressindex',) -_i22 = ('p2traddressindex',) -_i23 = ('p2wpkhaddressindex',) -_i24 = ('p2wshaddressindex',) -_i25 = ('quarterindex',) -_i26 = ('semesterindex',) -_i27 = ('txindex',) -_i28 = ('unknownoutputindex',) -_i29 = ('weekindex',) -_i30 = ('yearindex',) -_i31 = ('loadedaddressindex',) -_i32 = ('emptyaddressindex',) +_i1 = ( + "dateindex", + "decadeindex", + "difficultyepoch", + "height", + "monthindex", + "quarterindex", + "semesterindex", + "weekindex", + "yearindex", +) +_i2 = ( + "dateindex", + "decadeindex", + "difficultyepoch", + "monthindex", + "quarterindex", + "semesterindex", + "weekindex", + "yearindex", +) +_i3 = ( + "dateindex", + "decadeindex", + "height", + "monthindex", + "quarterindex", + "semesterindex", + "weekindex", + "yearindex", +) +_i4 = ( + "dateindex", + "decadeindex", + "monthindex", + "quarterindex", + "semesterindex", + "weekindex", + "yearindex", +) +_i5 = ("dateindex", "height") +_i6 = ("dateindex",) +_i7 = ("decadeindex",) +_i8 = ("difficultyepoch",) +_i9 = ("emptyoutputindex",) +_i10 = ("halvingepoch",) +_i11 = ("height",) +_i12 = ("txinindex",) +_i13 = ("monthindex",) +_i14 = ("opreturnindex",) +_i15 = ("txoutindex",) +_i16 = ("p2aaddressindex",) +_i17 = ("p2msoutputindex",) +_i18 = ("p2pk33addressindex",) +_i19 = ("p2pk65addressindex",) +_i20 = ("p2pkhaddressindex",) +_i21 = ("p2shaddressindex",) +_i22 = ("p2traddressindex",) +_i23 = ("p2wpkhaddressindex",) +_i24 = ("p2wshaddressindex",) +_i25 = ("quarterindex",) +_i26 = ("semesterindex",) +_i27 = ("txindex",) +_i28 = ("unknownoutputindex",) +_i29 = ("weekindex",) +_i30 = ("yearindex",) +_i31 = ("loadedaddressindex",) +_i32 = ("emptyaddressindex",) + def _ep(c: BrkClientBase, n: str, i: Index) -> MetricEndpointBuilder: return MetricEndpointBuilder(c, n, i) + # Index accessor classes + class _MetricPattern1By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def dateindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'dateindex') - def decadeindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'decadeindex') - def difficultyepoch(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'difficultyepoch') - def height(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'height') - def monthindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'monthindex') - def quarterindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'quarterindex') - def semesterindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'semesterindex') - def weekindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'weekindex') - def yearindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'yearindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def dateindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "dateindex") + + def decadeindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "decadeindex") + + def difficultyepoch(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "difficultyepoch") + + def height(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "height") + + def monthindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "monthindex") + + def quarterindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "quarterindex") + + def semesterindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "semesterindex") + + def weekindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "weekindex") + + def yearindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "yearindex") + class MetricPattern1(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern1By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern1By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i1) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i1 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i1) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i1 else None + class _MetricPattern2By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def dateindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'dateindex') - def decadeindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'decadeindex') - def difficultyepoch(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'difficultyepoch') - def monthindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'monthindex') - def quarterindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'quarterindex') - def semesterindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'semesterindex') - def weekindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'weekindex') - def yearindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'yearindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def dateindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "dateindex") + + def decadeindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "decadeindex") + + def difficultyepoch(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "difficultyepoch") + + def monthindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "monthindex") + + def quarterindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "quarterindex") + + def semesterindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "semesterindex") + + def weekindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "weekindex") + + def yearindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "yearindex") + class MetricPattern2(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern2By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern2By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i2) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i2 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i2) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i2 else None + class _MetricPattern3By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def dateindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'dateindex') - def decadeindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'decadeindex') - def height(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'height') - def monthindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'monthindex') - def quarterindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'quarterindex') - def semesterindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'semesterindex') - def weekindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'weekindex') - def yearindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'yearindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def dateindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "dateindex") + + def decadeindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "decadeindex") + + def height(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "height") + + def monthindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "monthindex") + + def quarterindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "quarterindex") + + def semesterindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "semesterindex") + + def weekindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "weekindex") + + def yearindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "yearindex") + class MetricPattern3(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern3By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern3By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i3) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i3 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i3) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i3 else None + class _MetricPattern4By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def dateindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'dateindex') - def decadeindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'decadeindex') - def monthindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'monthindex') - def quarterindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'quarterindex') - def semesterindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'semesterindex') - def weekindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'weekindex') - def yearindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'yearindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def dateindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "dateindex") + + def decadeindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "decadeindex") + + def monthindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "monthindex") + + def quarterindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "quarterindex") + + def semesterindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "semesterindex") + + def weekindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "weekindex") + + def yearindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "yearindex") + class MetricPattern4(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern4By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern4By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i4) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i4 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i4) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i4 else None + class _MetricPattern5By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def dateindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'dateindex') - def height(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'height') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def dateindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "dateindex") + + def height(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "height") + class MetricPattern5(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern5By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern5By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i5) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i5 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i5) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i5 else None + class _MetricPattern6By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def dateindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'dateindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def dateindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "dateindex") + class MetricPattern6(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern6By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern6By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i6) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i6 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i6) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i6 else None + class _MetricPattern7By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def decadeindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'decadeindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def decadeindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "decadeindex") + class MetricPattern7(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern7By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern7By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i7) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i7 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i7) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i7 else None + class _MetricPattern8By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def difficultyepoch(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'difficultyepoch') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def difficultyepoch(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "difficultyepoch") + class MetricPattern8(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern8By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern8By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i8) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i8 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i8) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i8 else None + class _MetricPattern9By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def emptyoutputindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'emptyoutputindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def emptyoutputindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "emptyoutputindex") + class MetricPattern9(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern9By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern9By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i9) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i9 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i9) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i9 else None + class _MetricPattern10By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def halvingepoch(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'halvingepoch') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def halvingepoch(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "halvingepoch") + class MetricPattern10(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern10By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern10By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i10) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i10 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i10) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i10 else None + class _MetricPattern11By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def height(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'height') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def height(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "height") + class MetricPattern11(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern11By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern11By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i11) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i11 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i11) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i11 else None + class _MetricPattern12By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def txinindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'txinindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def txinindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "txinindex") + class MetricPattern12(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern12By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern12By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i12) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i12 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i12) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i12 else None + class _MetricPattern13By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def monthindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'monthindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def monthindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "monthindex") + class MetricPattern13(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern13By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern13By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i13) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i13 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i13) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i13 else None + class _MetricPattern14By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def opreturnindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'opreturnindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def opreturnindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "opreturnindex") + class MetricPattern14(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern14By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern14By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i14) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i14 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i14) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i14 else None + class _MetricPattern15By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def txoutindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'txoutindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def txoutindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "txoutindex") + class MetricPattern15(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern15By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern15By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i15) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i15 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i15) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i15 else None + class _MetricPattern16By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def p2aaddressindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'p2aaddressindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def p2aaddressindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "p2aaddressindex") + class MetricPattern16(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern16By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern16By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i16) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i16 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i16) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i16 else None + class _MetricPattern17By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def p2msoutputindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'p2msoutputindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def p2msoutputindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "p2msoutputindex") + class MetricPattern17(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern17By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern17By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i17) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i17 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i17) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i17 else None + class _MetricPattern18By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def p2pk33addressindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'p2pk33addressindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def p2pk33addressindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "p2pk33addressindex") + class MetricPattern18(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern18By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern18By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i18) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i18 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i18) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i18 else None + class _MetricPattern19By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def p2pk65addressindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'p2pk65addressindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def p2pk65addressindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "p2pk65addressindex") + class MetricPattern19(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern19By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern19By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i19) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i19 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i19) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i19 else None + class _MetricPattern20By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def p2pkhaddressindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'p2pkhaddressindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def p2pkhaddressindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "p2pkhaddressindex") + class MetricPattern20(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern20By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern20By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i20) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i20 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i20) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i20 else None + class _MetricPattern21By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def p2shaddressindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'p2shaddressindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def p2shaddressindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "p2shaddressindex") + class MetricPattern21(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern21By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern21By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i21) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i21 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i21) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i21 else None + class _MetricPattern22By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def p2traddressindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'p2traddressindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def p2traddressindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "p2traddressindex") + class MetricPattern22(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern22By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern22By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i22) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i22 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i22) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i22 else None + class _MetricPattern23By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def p2wpkhaddressindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'p2wpkhaddressindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def p2wpkhaddressindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "p2wpkhaddressindex") + class MetricPattern23(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern23By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern23By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i23) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i23 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i23) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i23 else None + class _MetricPattern24By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def p2wshaddressindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'p2wshaddressindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def p2wshaddressindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "p2wshaddressindex") + class MetricPattern24(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern24By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern24By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i24) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i24 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i24) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i24 else None + class _MetricPattern25By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def quarterindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'quarterindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def quarterindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "quarterindex") + class MetricPattern25(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern25By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern25By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i25) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i25 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i25) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i25 else None + class _MetricPattern26By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def semesterindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'semesterindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def semesterindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "semesterindex") + class MetricPattern26(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern26By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern26By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i26) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i26 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i26) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i26 else None + class _MetricPattern27By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def txindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'txindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def txindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "txindex") + class MetricPattern27(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern27By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern27By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i27) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i27 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i27) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i27 else None + class _MetricPattern28By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def unknownoutputindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'unknownoutputindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def unknownoutputindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "unknownoutputindex") + class MetricPattern28(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern28By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern28By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i28) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i28 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i28) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i28 else None + class _MetricPattern29By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def weekindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'weekindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def weekindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "weekindex") + class MetricPattern29(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern29By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern29By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i29) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i29 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i29) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i29 else None + class _MetricPattern30By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def yearindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'yearindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def yearindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "yearindex") + class MetricPattern30(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern30By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern30By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i30) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i30 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i30) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i30 else None + class _MetricPattern31By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def loadedaddressindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'loadedaddressindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def loadedaddressindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "loadedaddressindex") + class MetricPattern31(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern31By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern31By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i31) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i31 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i31) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i31 else None + class _MetricPattern32By(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._c, self._n = c, n - def emptyaddressindex(self) -> MetricEndpointBuilder[T]: return _ep(self._c, self._n, 'emptyaddressindex') + def __init__(self, c: BrkClientBase, n: str): + self._c, self._n = c, n + + def emptyaddressindex(self) -> MetricEndpointBuilder[T]: + return _ep(self._c, self._n, "emptyaddressindex") + class MetricPattern32(Generic[T]): - def __init__(self, c: BrkClientBase, n: str): self._n, self.by = n, _MetricPattern32By(c, n) + def __init__(self, c: BrkClientBase, n: str): + self._n, self.by = n, _MetricPattern32By(c, n) + @property - def name(self) -> str: return self._n - def indexes(self) -> List[str]: return list(_i32) - def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: return _ep(self.by._c, self._n, index) if index in _i32 else None + def name(self) -> str: + return self._n + + def indexes(self) -> List[str]: + return list(_i32) + + def get(self, index: Index) -> Optional[MetricEndpointBuilder[T]]: + return _ep(self.by._c, self._n, index) if index in _i32 else None + # Reusable structural pattern classes + class RealizedPattern3: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.adjusted_sopr: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'adjusted_sopr')) - self.adjusted_sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'adjusted_sopr_30d_ema')) - self.adjusted_sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'adjusted_sopr_7d_ema')) - self.adjusted_value_created: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'adjusted_value_created')) - self.adjusted_value_destroyed: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'adjusted_value_destroyed')) - self.mvrv: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'mvrv')) - self.neg_realized_loss: BitcoinPattern2[Dollars] = BitcoinPattern2(client, _m(acc, 'neg_realized_loss')) - self.net_realized_pnl: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'net_realized_pnl')) - self.net_realized_pnl_cumulative_30d_delta: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta')) - self.net_realized_pnl_cumulative_30d_delta_rel_to_market_cap: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta_rel_to_market_cap')) - self.net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap')) - self.net_realized_pnl_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'net_realized_pnl_rel_to_realized_cap')) - self.realized_cap: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_cap')) - self.realized_cap_30d_delta: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'realized_cap_30d_delta')) - self.realized_cap_rel_to_own_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'realized_cap_rel_to_own_market_cap')) - self.realized_loss: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'realized_loss')) - self.realized_loss_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'realized_loss_rel_to_realized_cap')) - self.realized_price: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_price')) - self.realized_price_extra: ActivePriceRatioPattern = ActivePriceRatioPattern(client, _m(acc, 'realized_price_ratio')) - self.realized_profit: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'realized_profit')) - self.realized_profit_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'realized_profit_rel_to_realized_cap')) - self.realized_profit_to_loss_ratio: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'realized_profit_to_loss_ratio')) - self.realized_value: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_value')) - self.sell_side_risk_ratio: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio')) - self.sell_side_risk_ratio_30d_ema: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio_30d_ema')) - self.sell_side_risk_ratio_7d_ema: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio_7d_ema')) - self.sopr: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr')) - self.sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr_30d_ema')) - self.sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr_7d_ema')) - self.total_realized_pnl: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'total_realized_pnl')) - self.value_created: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'value_created')) - self.value_destroyed: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'value_destroyed')) + self.adjusted_sopr: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "adjusted_sopr") + ) + self.adjusted_sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "adjusted_sopr_30d_ema") + ) + self.adjusted_sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "adjusted_sopr_7d_ema") + ) + self.adjusted_value_created: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "adjusted_value_created") + ) + self.adjusted_value_destroyed: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "adjusted_value_destroyed") + ) + self.mvrv: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "mvrv")) + self.neg_realized_loss: BitcoinPattern2[Dollars] = BitcoinPattern2( + client, _m(acc, "neg_realized_loss") + ) + self.net_realized_pnl: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "net_realized_pnl") + ) + self.net_realized_pnl_cumulative_30d_delta: MetricPattern4[Dollars] = ( + MetricPattern4(client, _m(acc, "net_realized_pnl_cumulative_30d_delta")) + ) + self.net_realized_pnl_cumulative_30d_delta_rel_to_market_cap: MetricPattern4[ + StoredF32 + ] = MetricPattern4( + client, _m(acc, "net_realized_pnl_cumulative_30d_delta_rel_to_market_cap") + ) + self.net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap: MetricPattern4[ + StoredF32 + ] = MetricPattern4( + client, _m(acc, "net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap") + ) + self.net_realized_pnl_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "net_realized_pnl_rel_to_realized_cap")) + ) + self.realized_cap: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_cap") + ) + self.realized_cap_30d_delta: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "realized_cap_30d_delta") + ) + self.realized_cap_rel_to_own_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "realized_cap_rel_to_own_market_cap")) + ) + self.realized_loss: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "realized_loss") + ) + self.realized_loss_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "realized_loss_rel_to_realized_cap")) + ) + self.realized_price: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_price") + ) + self.realized_price_extra: ActivePriceRatioPattern = ActivePriceRatioPattern( + client, _m(acc, "realized_price_ratio") + ) + self.realized_profit: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "realized_profit") + ) + self.realized_profit_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "realized_profit_rel_to_realized_cap")) + ) + self.realized_profit_to_loss_ratio: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "realized_profit_to_loss_ratio") + ) + self.realized_value: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_value") + ) + self.sell_side_risk_ratio: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio") + ) + self.sell_side_risk_ratio_30d_ema: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio_30d_ema") + ) + self.sell_side_risk_ratio_7d_ema: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio_7d_ema") + ) + self.sopr: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, "sopr")) + self.sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "sopr_30d_ema") + ) + self.sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "sopr_7d_ema") + ) + self.total_realized_pnl: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "total_realized_pnl") + ) + self.value_created: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "value_created") + ) + self.value_destroyed: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "value_destroyed") + ) + class RealizedPattern4: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.adjusted_sopr: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'adjusted_sopr')) - self.adjusted_sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'adjusted_sopr_30d_ema')) - self.adjusted_sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'adjusted_sopr_7d_ema')) - self.adjusted_value_created: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'adjusted_value_created')) - self.adjusted_value_destroyed: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'adjusted_value_destroyed')) - self.mvrv: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'mvrv')) - self.neg_realized_loss: BitcoinPattern2[Dollars] = BitcoinPattern2(client, _m(acc, 'neg_realized_loss')) - self.net_realized_pnl: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'net_realized_pnl')) - self.net_realized_pnl_cumulative_30d_delta: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta')) - self.net_realized_pnl_cumulative_30d_delta_rel_to_market_cap: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta_rel_to_market_cap')) - self.net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap')) - self.net_realized_pnl_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'net_realized_pnl_rel_to_realized_cap')) - self.realized_cap: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_cap')) - self.realized_cap_30d_delta: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'realized_cap_30d_delta')) - self.realized_loss: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'realized_loss')) - self.realized_loss_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'realized_loss_rel_to_realized_cap')) - self.realized_price: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_price')) - self.realized_price_extra: RealizedPriceExtraPattern = RealizedPriceExtraPattern(client, _m(acc, 'realized_price_ratio')) - self.realized_profit: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'realized_profit')) - self.realized_profit_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'realized_profit_rel_to_realized_cap')) - self.realized_value: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_value')) - self.sell_side_risk_ratio: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio')) - self.sell_side_risk_ratio_30d_ema: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio_30d_ema')) - self.sell_side_risk_ratio_7d_ema: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio_7d_ema')) - self.sopr: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr')) - self.sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr_30d_ema')) - self.sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr_7d_ema')) - self.total_realized_pnl: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'total_realized_pnl')) - self.value_created: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'value_created')) - self.value_destroyed: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'value_destroyed')) + self.adjusted_sopr: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "adjusted_sopr") + ) + self.adjusted_sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "adjusted_sopr_30d_ema") + ) + self.adjusted_sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "adjusted_sopr_7d_ema") + ) + self.adjusted_value_created: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "adjusted_value_created") + ) + self.adjusted_value_destroyed: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "adjusted_value_destroyed") + ) + self.mvrv: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "mvrv")) + self.neg_realized_loss: BitcoinPattern2[Dollars] = BitcoinPattern2( + client, _m(acc, "neg_realized_loss") + ) + self.net_realized_pnl: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "net_realized_pnl") + ) + self.net_realized_pnl_cumulative_30d_delta: MetricPattern4[Dollars] = ( + MetricPattern4(client, _m(acc, "net_realized_pnl_cumulative_30d_delta")) + ) + self.net_realized_pnl_cumulative_30d_delta_rel_to_market_cap: MetricPattern4[ + StoredF32 + ] = MetricPattern4( + client, _m(acc, "net_realized_pnl_cumulative_30d_delta_rel_to_market_cap") + ) + self.net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap: MetricPattern4[ + StoredF32 + ] = MetricPattern4( + client, _m(acc, "net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap") + ) + self.net_realized_pnl_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "net_realized_pnl_rel_to_realized_cap")) + ) + self.realized_cap: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_cap") + ) + self.realized_cap_30d_delta: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "realized_cap_30d_delta") + ) + self.realized_loss: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "realized_loss") + ) + self.realized_loss_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "realized_loss_rel_to_realized_cap")) + ) + self.realized_price: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_price") + ) + self.realized_price_extra: RealizedPriceExtraPattern = ( + RealizedPriceExtraPattern(client, _m(acc, "realized_price_ratio")) + ) + self.realized_profit: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "realized_profit") + ) + self.realized_profit_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "realized_profit_rel_to_realized_cap")) + ) + self.realized_value: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_value") + ) + self.sell_side_risk_ratio: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio") + ) + self.sell_side_risk_ratio_30d_ema: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio_30d_ema") + ) + self.sell_side_risk_ratio_7d_ema: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio_7d_ema") + ) + self.sopr: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, "sopr")) + self.sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "sopr_30d_ema") + ) + self.sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "sopr_7d_ema") + ) + self.total_realized_pnl: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "total_realized_pnl") + ) + self.value_created: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "value_created") + ) + self.value_destroyed: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "value_destroyed") + ) + class Ratio1ySdPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self._0sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, '0sd_usd')) - self.m0_5sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'm0_5sd')) - self.m0_5sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'm0_5sd_usd')) - self.m1_5sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'm1_5sd')) - self.m1_5sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'm1_5sd_usd')) - self.m1sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'm1sd')) - self.m1sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'm1sd_usd')) - self.m2_5sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'm2_5sd')) - self.m2_5sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'm2_5sd_usd')) - self.m2sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'm2sd')) - self.m2sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'm2sd_usd')) - self.m3sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'm3sd')) - self.m3sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'm3sd_usd')) - self.p0_5sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'p0_5sd')) - self.p0_5sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'p0_5sd_usd')) - self.p1_5sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'p1_5sd')) - self.p1_5sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'p1_5sd_usd')) - self.p1sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'p1sd')) - self.p1sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'p1sd_usd')) - self.p2_5sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'p2_5sd')) - self.p2_5sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'p2_5sd_usd')) - self.p2sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'p2sd')) - self.p2sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'p2sd_usd')) - self.p3sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'p3sd')) - self.p3sd_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'p3sd_usd')) - self.sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'sd')) - self.sma: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'sma')) - self.zscore: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'zscore')) + self._0sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "0sd_usd") + ) + self.m0_5sd: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "m0_5sd") + ) + self.m0_5sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "m0_5sd_usd") + ) + self.m1_5sd: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "m1_5sd") + ) + self.m1_5sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "m1_5sd_usd") + ) + self.m1sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "m1sd")) + self.m1sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "m1sd_usd") + ) + self.m2_5sd: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "m2_5sd") + ) + self.m2_5sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "m2_5sd_usd") + ) + self.m2sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "m2sd")) + self.m2sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "m2sd_usd") + ) + self.m3sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "m3sd")) + self.m3sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "m3sd_usd") + ) + self.p0_5sd: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "p0_5sd") + ) + self.p0_5sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "p0_5sd_usd") + ) + self.p1_5sd: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "p1_5sd") + ) + self.p1_5sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "p1_5sd_usd") + ) + self.p1sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "p1sd")) + self.p1sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "p1sd_usd") + ) + self.p2_5sd: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "p2_5sd") + ) + self.p2_5sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "p2_5sd_usd") + ) + self.p2sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "p2sd")) + self.p2sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "p2sd_usd") + ) + self.p3sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "p3sd")) + self.p3sd_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "p3sd_usd") + ) + self.sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "sd")) + self.sma: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "sma")) + self.zscore: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "zscore") + ) + class RealizedPattern2: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.mvrv: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'mvrv')) - self.neg_realized_loss: BitcoinPattern2[Dollars] = BitcoinPattern2(client, _m(acc, 'neg_realized_loss')) - self.net_realized_pnl: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'net_realized_pnl')) - self.net_realized_pnl_cumulative_30d_delta: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta')) - self.net_realized_pnl_cumulative_30d_delta_rel_to_market_cap: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta_rel_to_market_cap')) - self.net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap')) - self.net_realized_pnl_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'net_realized_pnl_rel_to_realized_cap')) - self.realized_cap: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_cap')) - self.realized_cap_30d_delta: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'realized_cap_30d_delta')) - self.realized_cap_rel_to_own_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'realized_cap_rel_to_own_market_cap')) - self.realized_loss: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'realized_loss')) - self.realized_loss_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'realized_loss_rel_to_realized_cap')) - self.realized_price: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_price')) - self.realized_price_extra: ActivePriceRatioPattern = ActivePriceRatioPattern(client, _m(acc, 'realized_price_ratio')) - self.realized_profit: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'realized_profit')) - self.realized_profit_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'realized_profit_rel_to_realized_cap')) - self.realized_profit_to_loss_ratio: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'realized_profit_to_loss_ratio')) - self.realized_value: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_value')) - self.sell_side_risk_ratio: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio')) - self.sell_side_risk_ratio_30d_ema: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio_30d_ema')) - self.sell_side_risk_ratio_7d_ema: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio_7d_ema')) - self.sopr: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr')) - self.sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr_30d_ema')) - self.sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr_7d_ema')) - self.total_realized_pnl: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'total_realized_pnl')) - self.value_created: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'value_created')) - self.value_destroyed: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'value_destroyed')) + self.mvrv: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "mvrv")) + self.neg_realized_loss: BitcoinPattern2[Dollars] = BitcoinPattern2( + client, _m(acc, "neg_realized_loss") + ) + self.net_realized_pnl: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "net_realized_pnl") + ) + self.net_realized_pnl_cumulative_30d_delta: MetricPattern4[Dollars] = ( + MetricPattern4(client, _m(acc, "net_realized_pnl_cumulative_30d_delta")) + ) + self.net_realized_pnl_cumulative_30d_delta_rel_to_market_cap: MetricPattern4[ + StoredF32 + ] = MetricPattern4( + client, _m(acc, "net_realized_pnl_cumulative_30d_delta_rel_to_market_cap") + ) + self.net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap: MetricPattern4[ + StoredF32 + ] = MetricPattern4( + client, _m(acc, "net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap") + ) + self.net_realized_pnl_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "net_realized_pnl_rel_to_realized_cap")) + ) + self.realized_cap: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_cap") + ) + self.realized_cap_30d_delta: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "realized_cap_30d_delta") + ) + self.realized_cap_rel_to_own_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "realized_cap_rel_to_own_market_cap")) + ) + self.realized_loss: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "realized_loss") + ) + self.realized_loss_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "realized_loss_rel_to_realized_cap")) + ) + self.realized_price: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_price") + ) + self.realized_price_extra: ActivePriceRatioPattern = ActivePriceRatioPattern( + client, _m(acc, "realized_price_ratio") + ) + self.realized_profit: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "realized_profit") + ) + self.realized_profit_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "realized_profit_rel_to_realized_cap")) + ) + self.realized_profit_to_loss_ratio: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "realized_profit_to_loss_ratio") + ) + self.realized_value: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_value") + ) + self.sell_side_risk_ratio: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio") + ) + self.sell_side_risk_ratio_30d_ema: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio_30d_ema") + ) + self.sell_side_risk_ratio_7d_ema: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio_7d_ema") + ) + self.sopr: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, "sopr")) + self.sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "sopr_30d_ema") + ) + self.sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "sopr_7d_ema") + ) + self.total_realized_pnl: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "total_realized_pnl") + ) + self.value_created: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "value_created") + ) + self.value_destroyed: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "value_destroyed") + ) + class RealizedPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.mvrv: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'mvrv')) - self.neg_realized_loss: BitcoinPattern2[Dollars] = BitcoinPattern2(client, _m(acc, 'neg_realized_loss')) - self.net_realized_pnl: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'net_realized_pnl')) - self.net_realized_pnl_cumulative_30d_delta: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta')) - self.net_realized_pnl_cumulative_30d_delta_rel_to_market_cap: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta_rel_to_market_cap')) - self.net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap')) - self.net_realized_pnl_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'net_realized_pnl_rel_to_realized_cap')) - self.realized_cap: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_cap')) - self.realized_cap_30d_delta: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'realized_cap_30d_delta')) - self.realized_loss: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'realized_loss')) - self.realized_loss_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'realized_loss_rel_to_realized_cap')) - self.realized_price: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_price')) - self.realized_price_extra: RealizedPriceExtraPattern = RealizedPriceExtraPattern(client, _m(acc, 'realized_price_ratio')) - self.realized_profit: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'realized_profit')) - self.realized_profit_rel_to_realized_cap: BlockCountPattern[StoredF32] = BlockCountPattern(client, _m(acc, 'realized_profit_rel_to_realized_cap')) - self.realized_value: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'realized_value')) - self.sell_side_risk_ratio: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio')) - self.sell_side_risk_ratio_30d_ema: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio_30d_ema')) - self.sell_side_risk_ratio_7d_ema: MetricPattern6[StoredF32] = MetricPattern6(client, _m(acc, 'sell_side_risk_ratio_7d_ema')) - self.sopr: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr')) - self.sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr_30d_ema')) - self.sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, 'sopr_7d_ema')) - self.total_realized_pnl: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'total_realized_pnl')) - self.value_created: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'value_created')) - self.value_destroyed: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'value_destroyed')) + self.mvrv: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "mvrv")) + self.neg_realized_loss: BitcoinPattern2[Dollars] = BitcoinPattern2( + client, _m(acc, "neg_realized_loss") + ) + self.net_realized_pnl: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "net_realized_pnl") + ) + self.net_realized_pnl_cumulative_30d_delta: MetricPattern4[Dollars] = ( + MetricPattern4(client, _m(acc, "net_realized_pnl_cumulative_30d_delta")) + ) + self.net_realized_pnl_cumulative_30d_delta_rel_to_market_cap: MetricPattern4[ + StoredF32 + ] = MetricPattern4( + client, _m(acc, "net_realized_pnl_cumulative_30d_delta_rel_to_market_cap") + ) + self.net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap: MetricPattern4[ + StoredF32 + ] = MetricPattern4( + client, _m(acc, "net_realized_pnl_cumulative_30d_delta_rel_to_realized_cap") + ) + self.net_realized_pnl_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "net_realized_pnl_rel_to_realized_cap")) + ) + self.realized_cap: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_cap") + ) + self.realized_cap_30d_delta: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "realized_cap_30d_delta") + ) + self.realized_loss: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "realized_loss") + ) + self.realized_loss_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "realized_loss_rel_to_realized_cap")) + ) + self.realized_price: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_price") + ) + self.realized_price_extra: RealizedPriceExtraPattern = ( + RealizedPriceExtraPattern(client, _m(acc, "realized_price_ratio")) + ) + self.realized_profit: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "realized_profit") + ) + self.realized_profit_rel_to_realized_cap: BlockCountPattern[StoredF32] = ( + BlockCountPattern(client, _m(acc, "realized_profit_rel_to_realized_cap")) + ) + self.realized_value: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "realized_value") + ) + self.sell_side_risk_ratio: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio") + ) + self.sell_side_risk_ratio_30d_ema: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio_30d_ema") + ) + self.sell_side_risk_ratio_7d_ema: MetricPattern6[StoredF32] = MetricPattern6( + client, _m(acc, "sell_side_risk_ratio_7d_ema") + ) + self.sopr: MetricPattern6[StoredF64] = MetricPattern6(client, _m(acc, "sopr")) + self.sopr_30d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "sopr_30d_ema") + ) + self.sopr_7d_ema: MetricPattern6[StoredF64] = MetricPattern6( + client, _m(acc, "sopr_7d_ema") + ) + self.total_realized_pnl: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "total_realized_pnl") + ) + self.value_created: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "value_created") + ) + self.value_destroyed: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "value_destroyed") + ) + class Price111dSmaPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.price: MetricPattern4[Dollars] = MetricPattern4(client, acc) - self.ratio: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'ratio')) - self.ratio_1m_sma: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'ratio_1m_sma')) - self.ratio_1w_sma: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'ratio_1w_sma')) - self.ratio_1y_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, 'ratio_1y')) - self.ratio_2y_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, 'ratio_2y')) - self.ratio_4y_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, 'ratio_4y')) - self.ratio_pct1: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'ratio_pct1')) - self.ratio_pct1_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'ratio_pct1_usd')) - self.ratio_pct2: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'ratio_pct2')) - self.ratio_pct2_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'ratio_pct2_usd')) - self.ratio_pct5: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'ratio_pct5')) - self.ratio_pct5_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'ratio_pct5_usd')) - self.ratio_pct95: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'ratio_pct95')) - self.ratio_pct95_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'ratio_pct95_usd')) - self.ratio_pct98: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'ratio_pct98')) - self.ratio_pct98_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'ratio_pct98_usd')) - self.ratio_pct99: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'ratio_pct99')) - self.ratio_pct99_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'ratio_pct99_usd')) - self.ratio_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, 'ratio')) + self.ratio: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "ratio")) + self.ratio_1m_sma: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "ratio_1m_sma") + ) + self.ratio_1w_sma: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "ratio_1w_sma") + ) + self.ratio_1y_sd: Ratio1ySdPattern = Ratio1ySdPattern( + client, _m(acc, "ratio_1y") + ) + self.ratio_2y_sd: Ratio1ySdPattern = Ratio1ySdPattern( + client, _m(acc, "ratio_2y") + ) + self.ratio_4y_sd: Ratio1ySdPattern = Ratio1ySdPattern( + client, _m(acc, "ratio_4y") + ) + self.ratio_pct1: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "ratio_pct1") + ) + self.ratio_pct1_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "ratio_pct1_usd") + ) + self.ratio_pct2: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "ratio_pct2") + ) + self.ratio_pct2_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "ratio_pct2_usd") + ) + self.ratio_pct5: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "ratio_pct5") + ) + self.ratio_pct5_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "ratio_pct5_usd") + ) + self.ratio_pct95: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "ratio_pct95") + ) + self.ratio_pct95_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "ratio_pct95_usd") + ) + self.ratio_pct98: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "ratio_pct98") + ) + self.ratio_pct98_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "ratio_pct98_usd") + ) + self.ratio_pct99: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "ratio_pct99") + ) + self.ratio_pct99_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "ratio_pct99_usd") + ) + self.ratio_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, "ratio")) + class ActivePriceRatioPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.ratio: MetricPattern4[StoredF32] = MetricPattern4(client, acc) - self.ratio_1m_sma: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, '1m_sma')) - self.ratio_1w_sma: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, '1w_sma')) - self.ratio_1y_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, '1y')) - self.ratio_2y_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, '2y')) - self.ratio_4y_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, '4y')) - self.ratio_pct1: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'pct1')) - self.ratio_pct1_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct1_usd')) - self.ratio_pct2: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'pct2')) - self.ratio_pct2_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct2_usd')) - self.ratio_pct5: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'pct5')) - self.ratio_pct5_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct5_usd')) - self.ratio_pct95: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'pct95')) - self.ratio_pct95_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct95_usd')) - self.ratio_pct98: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'pct98')) - self.ratio_pct98_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct98_usd')) - self.ratio_pct99: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'pct99')) - self.ratio_pct99_usd: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct99_usd')) + self.ratio_1m_sma: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "1m_sma") + ) + self.ratio_1w_sma: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "1w_sma") + ) + self.ratio_1y_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, "1y")) + self.ratio_2y_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, "2y")) + self.ratio_4y_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, _m(acc, "4y")) + self.ratio_pct1: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "pct1") + ) + self.ratio_pct1_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "pct1_usd") + ) + self.ratio_pct2: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "pct2") + ) + self.ratio_pct2_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "pct2_usd") + ) + self.ratio_pct5: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "pct5") + ) + self.ratio_pct5_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "pct5_usd") + ) + self.ratio_pct95: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "pct95") + ) + self.ratio_pct95_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "pct95_usd") + ) + self.ratio_pct98: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "pct98") + ) + self.ratio_pct98_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "pct98_usd") + ) + self.ratio_pct99: MetricPattern4[StoredF32] = MetricPattern4( + client, _m(acc, "pct99") + ) + self.ratio_pct99_usd: MetricPattern4[Dollars] = MetricPattern4( + client, _m(acc, "pct99_usd") + ) self.ratio_sd: Ratio1ySdPattern = Ratio1ySdPattern(client, acc) + class PercentilesPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.pct05: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct05')) - self.pct10: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct10')) - self.pct15: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct15')) - self.pct20: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct20')) - self.pct25: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct25')) - self.pct30: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct30')) - self.pct35: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct35')) - self.pct40: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct40')) - self.pct45: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct45')) - self.pct50: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct50')) - self.pct55: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct55')) - self.pct60: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct60')) - self.pct65: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct65')) - self.pct70: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct70')) - self.pct75: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct75')) - self.pct80: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct80')) - self.pct85: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct85')) - self.pct90: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct90')) - self.pct95: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'pct95')) + self.pct05: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct05")) + self.pct10: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct10")) + self.pct15: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct15")) + self.pct20: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct20")) + self.pct25: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct25")) + self.pct30: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct30")) + self.pct35: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct35")) + self.pct40: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct40")) + self.pct45: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct45")) + self.pct50: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct50")) + self.pct55: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct55")) + self.pct60: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct60")) + self.pct65: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct65")) + self.pct70: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct70")) + self.pct75: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct75")) + self.pct80: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct80")) + self.pct85: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct85")) + self.pct90: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct90")) + self.pct95: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "pct95")) + class RelativePattern5: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.neg_unrealized_loss_rel_to_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'neg_unrealized_loss_rel_to_market_cap')) - self.neg_unrealized_loss_rel_to_own_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'neg_unrealized_loss_rel_to_own_market_cap')) - self.neg_unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'neg_unrealized_loss_rel_to_own_total_unrealized_pnl')) - self.net_unrealized_pnl_rel_to_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'net_unrealized_pnl_rel_to_market_cap')) - self.net_unrealized_pnl_rel_to_own_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'net_unrealized_pnl_rel_to_own_market_cap')) - self.net_unrealized_pnl_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'net_unrealized_pnl_rel_to_own_total_unrealized_pnl')) - self.nupl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'nupl')) - self.supply_in_loss_rel_to_circulating_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'supply_in_loss_rel_to_circulating_supply')) - self.supply_in_loss_rel_to_own_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'supply_in_loss_rel_to_own_supply')) - self.supply_in_profit_rel_to_circulating_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'supply_in_profit_rel_to_circulating_supply')) - self.supply_in_profit_rel_to_own_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'supply_in_profit_rel_to_own_supply')) - self.supply_rel_to_circulating_supply: MetricPattern4[StoredF64] = MetricPattern4(client, _m(acc, 'supply_rel_to_circulating_supply')) - self.unrealized_loss_rel_to_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_loss_rel_to_market_cap')) - self.unrealized_loss_rel_to_own_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_loss_rel_to_own_market_cap')) - self.unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_loss_rel_to_own_total_unrealized_pnl')) - self.unrealized_profit_rel_to_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_profit_rel_to_market_cap')) - self.unrealized_profit_rel_to_own_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_profit_rel_to_own_market_cap')) - self.unrealized_profit_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_profit_rel_to_own_total_unrealized_pnl')) + self.neg_unrealized_loss_rel_to_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "neg_unrealized_loss_rel_to_market_cap")) + ) + self.neg_unrealized_loss_rel_to_own_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "neg_unrealized_loss_rel_to_own_market_cap")) + ) + self.neg_unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1( + client, _m(acc, "neg_unrealized_loss_rel_to_own_total_unrealized_pnl") + ) + self.net_unrealized_pnl_rel_to_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "net_unrealized_pnl_rel_to_market_cap")) + ) + self.net_unrealized_pnl_rel_to_own_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "net_unrealized_pnl_rel_to_own_market_cap")) + ) + self.net_unrealized_pnl_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1( + client, _m(acc, "net_unrealized_pnl_rel_to_own_total_unrealized_pnl") + ) + self.nupl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, "nupl")) + self.supply_in_loss_rel_to_circulating_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, _m(acc, "supply_in_loss_rel_to_circulating_supply")) + ) + self.supply_in_loss_rel_to_own_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, _m(acc, "supply_in_loss_rel_to_own_supply")) + ) + self.supply_in_profit_rel_to_circulating_supply: MetricPattern1[StoredF64] = ( + MetricPattern1( + client, _m(acc, "supply_in_profit_rel_to_circulating_supply") + ) + ) + self.supply_in_profit_rel_to_own_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, _m(acc, "supply_in_profit_rel_to_own_supply")) + ) + self.supply_rel_to_circulating_supply: MetricPattern4[StoredF64] = ( + MetricPattern4(client, _m(acc, "supply_rel_to_circulating_supply")) + ) + self.unrealized_loss_rel_to_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "unrealized_loss_rel_to_market_cap")) + ) + self.unrealized_loss_rel_to_own_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "unrealized_loss_rel_to_own_market_cap")) + ) + self.unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1( + client, _m(acc, "unrealized_loss_rel_to_own_total_unrealized_pnl") + ) + self.unrealized_profit_rel_to_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "unrealized_profit_rel_to_market_cap")) + ) + self.unrealized_profit_rel_to_own_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "unrealized_profit_rel_to_own_market_cap")) + ) + self.unrealized_profit_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1( + client, _m(acc, "unrealized_profit_rel_to_own_total_unrealized_pnl") + ) + class AaopoolPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self._1m_blocks_mined: MetricPattern1[StoredU32] = MetricPattern1(client, _m(acc, '1m_blocks_mined')) - self._1m_dominance: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, '1m_dominance')) - self._1w_blocks_mined: MetricPattern1[StoredU32] = MetricPattern1(client, _m(acc, '1w_blocks_mined')) - self._1w_dominance: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, '1w_dominance')) - self._1y_blocks_mined: MetricPattern1[StoredU32] = MetricPattern1(client, _m(acc, '1y_blocks_mined')) - self._1y_dominance: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, '1y_dominance')) - self._24h_blocks_mined: MetricPattern1[StoredU32] = MetricPattern1(client, _m(acc, '24h_blocks_mined')) - self._24h_dominance: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, '24h_dominance')) - self.blocks_mined: BlockCountPattern[StoredU32] = BlockCountPattern(client, _m(acc, 'blocks_mined')) - self.coinbase: CoinbasePattern2 = CoinbasePattern2(client, _m(acc, 'coinbase')) - self.days_since_block: MetricPattern4[StoredU16] = MetricPattern4(client, _m(acc, 'days_since_block')) - self.dominance: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'dominance')) - self.fee: UnclaimedRewardsPattern = UnclaimedRewardsPattern(client, _m(acc, 'fee')) - self.subsidy: UnclaimedRewardsPattern = UnclaimedRewardsPattern(client, _m(acc, 'subsidy')) + self._1m_blocks_mined: MetricPattern1[StoredU32] = MetricPattern1( + client, _m(acc, "1m_blocks_mined") + ) + self._1m_dominance: MetricPattern1[StoredF32] = MetricPattern1( + client, _m(acc, "1m_dominance") + ) + self._1w_blocks_mined: MetricPattern1[StoredU32] = MetricPattern1( + client, _m(acc, "1w_blocks_mined") + ) + self._1w_dominance: MetricPattern1[StoredF32] = MetricPattern1( + client, _m(acc, "1w_dominance") + ) + self._1y_blocks_mined: MetricPattern1[StoredU32] = MetricPattern1( + client, _m(acc, "1y_blocks_mined") + ) + self._1y_dominance: MetricPattern1[StoredF32] = MetricPattern1( + client, _m(acc, "1y_dominance") + ) + self._24h_blocks_mined: MetricPattern1[StoredU32] = MetricPattern1( + client, _m(acc, "24h_blocks_mined") + ) + self._24h_dominance: MetricPattern1[StoredF32] = MetricPattern1( + client, _m(acc, "24h_dominance") + ) + self.blocks_mined: BlockCountPattern[StoredU32] = BlockCountPattern( + client, _m(acc, "blocks_mined") + ) + self.coinbase: CoinbasePattern2 = CoinbasePattern2(client, _m(acc, "coinbase")) + self.days_since_block: MetricPattern4[StoredU16] = MetricPattern4( + client, _m(acc, "days_since_block") + ) + self.dominance: MetricPattern1[StoredF32] = MetricPattern1( + client, _m(acc, "dominance") + ) + self.fee: UnclaimedRewardsPattern = UnclaimedRewardsPattern( + client, _m(acc, "fee") + ) + self.subsidy: UnclaimedRewardsPattern = UnclaimedRewardsPattern( + client, _m(acc, "subsidy") + ) + class LookbackPattern(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self._10y: MetricPattern4[T] = MetricPattern4(client, _m(acc, '10y_ago')) - self._1d: MetricPattern4[T] = MetricPattern4(client, _m(acc, '1d_ago')) - self._1m: MetricPattern4[T] = MetricPattern4(client, _m(acc, '1m_ago')) - self._1w: MetricPattern4[T] = MetricPattern4(client, _m(acc, '1w_ago')) - self._1y: MetricPattern4[T] = MetricPattern4(client, _m(acc, '1y_ago')) - self._2y: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2y_ago')) - self._3m: MetricPattern4[T] = MetricPattern4(client, _m(acc, '3m_ago')) - self._3y: MetricPattern4[T] = MetricPattern4(client, _m(acc, '3y_ago')) - self._4y: MetricPattern4[T] = MetricPattern4(client, _m(acc, '4y_ago')) - self._5y: MetricPattern4[T] = MetricPattern4(client, _m(acc, '5y_ago')) - self._6m: MetricPattern4[T] = MetricPattern4(client, _m(acc, '6m_ago')) - self._6y: MetricPattern4[T] = MetricPattern4(client, _m(acc, '6y_ago')) - self._8y: MetricPattern4[T] = MetricPattern4(client, _m(acc, '8y_ago')) + self._10y: MetricPattern4[T] = MetricPattern4(client, _m(acc, "10y_ago")) + self._1d: MetricPattern4[T] = MetricPattern4(client, _m(acc, "1d_ago")) + self._1m: MetricPattern4[T] = MetricPattern4(client, _m(acc, "1m_ago")) + self._1w: MetricPattern4[T] = MetricPattern4(client, _m(acc, "1w_ago")) + self._1y: MetricPattern4[T] = MetricPattern4(client, _m(acc, "1y_ago")) + self._2y: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2y_ago")) + self._3m: MetricPattern4[T] = MetricPattern4(client, _m(acc, "3m_ago")) + self._3y: MetricPattern4[T] = MetricPattern4(client, _m(acc, "3y_ago")) + self._4y: MetricPattern4[T] = MetricPattern4(client, _m(acc, "4y_ago")) + self._5y: MetricPattern4[T] = MetricPattern4(client, _m(acc, "5y_ago")) + self._6m: MetricPattern4[T] = MetricPattern4(client, _m(acc, "6m_ago")) + self._6y: MetricPattern4[T] = MetricPattern4(client, _m(acc, "6y_ago")) + self._8y: MetricPattern4[T] = MetricPattern4(client, _m(acc, "8y_ago")) + class PeriodLumpSumStackPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self._10y: _2015Pattern = _2015Pattern(client, _p('10y', acc)) - self._1m: _2015Pattern = _2015Pattern(client, _p('1m', acc)) - self._1w: _2015Pattern = _2015Pattern(client, _p('1w', acc)) - self._1y: _2015Pattern = _2015Pattern(client, _p('1y', acc)) - self._2y: _2015Pattern = _2015Pattern(client, _p('2y', acc)) - self._3m: _2015Pattern = _2015Pattern(client, _p('3m', acc)) - self._3y: _2015Pattern = _2015Pattern(client, _p('3y', acc)) - self._4y: _2015Pattern = _2015Pattern(client, _p('4y', acc)) - self._5y: _2015Pattern = _2015Pattern(client, _p('5y', acc)) - self._6m: _2015Pattern = _2015Pattern(client, _p('6m', acc)) - self._6y: _2015Pattern = _2015Pattern(client, _p('6y', acc)) - self._8y: _2015Pattern = _2015Pattern(client, _p('8y', acc)) + self._10y: _2015Pattern = _2015Pattern(client, _p("10y", acc)) + self._1m: _2015Pattern = _2015Pattern(client, _p("1m", acc)) + self._1w: _2015Pattern = _2015Pattern(client, _p("1w", acc)) + self._1y: _2015Pattern = _2015Pattern(client, _p("1y", acc)) + self._2y: _2015Pattern = _2015Pattern(client, _p("2y", acc)) + self._3m: _2015Pattern = _2015Pattern(client, _p("3m", acc)) + self._3y: _2015Pattern = _2015Pattern(client, _p("3y", acc)) + self._4y: _2015Pattern = _2015Pattern(client, _p("4y", acc)) + self._5y: _2015Pattern = _2015Pattern(client, _p("5y", acc)) + self._6m: _2015Pattern = _2015Pattern(client, _p("6m", acc)) + self._6y: _2015Pattern = _2015Pattern(client, _p("6y", acc)) + self._8y: _2015Pattern = _2015Pattern(client, _p("8y", acc)) + class PeriodAveragePricePattern(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self._10y: MetricPattern4[T] = MetricPattern4(client, _p('10y', acc)) - self._1m: MetricPattern4[T] = MetricPattern4(client, _p('1m', acc)) - self._1w: MetricPattern4[T] = MetricPattern4(client, _p('1w', acc)) - self._1y: MetricPattern4[T] = MetricPattern4(client, _p('1y', acc)) - self._2y: MetricPattern4[T] = MetricPattern4(client, _p('2y', acc)) - self._3m: MetricPattern4[T] = MetricPattern4(client, _p('3m', acc)) - self._3y: MetricPattern4[T] = MetricPattern4(client, _p('3y', acc)) - self._4y: MetricPattern4[T] = MetricPattern4(client, _p('4y', acc)) - self._5y: MetricPattern4[T] = MetricPattern4(client, _p('5y', acc)) - self._6m: MetricPattern4[T] = MetricPattern4(client, _p('6m', acc)) - self._6y: MetricPattern4[T] = MetricPattern4(client, _p('6y', acc)) - self._8y: MetricPattern4[T] = MetricPattern4(client, _p('8y', acc)) + self._10y: MetricPattern4[T] = MetricPattern4(client, _p("10y", acc)) + self._1m: MetricPattern4[T] = MetricPattern4(client, _p("1m", acc)) + self._1w: MetricPattern4[T] = MetricPattern4(client, _p("1w", acc)) + self._1y: MetricPattern4[T] = MetricPattern4(client, _p("1y", acc)) + self._2y: MetricPattern4[T] = MetricPattern4(client, _p("2y", acc)) + self._3m: MetricPattern4[T] = MetricPattern4(client, _p("3m", acc)) + self._3y: MetricPattern4[T] = MetricPattern4(client, _p("3y", acc)) + self._4y: MetricPattern4[T] = MetricPattern4(client, _p("4y", acc)) + self._5y: MetricPattern4[T] = MetricPattern4(client, _p("5y", acc)) + self._6m: MetricPattern4[T] = MetricPattern4(client, _p("6m", acc)) + self._6y: MetricPattern4[T] = MetricPattern4(client, _p("6y", acc)) + self._8y: MetricPattern4[T] = MetricPattern4(client, _p("8y", acc)) + class BitcoinPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.average: MetricPattern2[Bitcoin] = MetricPattern2(client, _m(acc, 'average')) + self.average: MetricPattern2[Bitcoin] = MetricPattern2( + client, _m(acc, "average") + ) self.base: MetricPattern11[Bitcoin] = MetricPattern11(client, acc) - self.cumulative: MetricPattern2[Bitcoin] = MetricPattern2(client, _m(acc, 'cumulative')) - self.max: MetricPattern2[Bitcoin] = MetricPattern2(client, _m(acc, 'max')) - self.median: MetricPattern6[Bitcoin] = MetricPattern6(client, _m(acc, 'median')) - self.min: MetricPattern2[Bitcoin] = MetricPattern2(client, _m(acc, 'min')) - self.pct10: MetricPattern6[Bitcoin] = MetricPattern6(client, _m(acc, 'pct10')) - self.pct25: MetricPattern6[Bitcoin] = MetricPattern6(client, _m(acc, 'pct25')) - self.pct75: MetricPattern6[Bitcoin] = MetricPattern6(client, _m(acc, 'pct75')) - self.pct90: MetricPattern6[Bitcoin] = MetricPattern6(client, _m(acc, 'pct90')) - self.sum: MetricPattern2[Bitcoin] = MetricPattern2(client, _m(acc, 'sum')) + self.cumulative: MetricPattern2[Bitcoin] = MetricPattern2( + client, _m(acc, "cumulative") + ) + self.max: MetricPattern2[Bitcoin] = MetricPattern2(client, _m(acc, "max")) + self.median: MetricPattern6[Bitcoin] = MetricPattern6(client, _m(acc, "median")) + self.min: MetricPattern2[Bitcoin] = MetricPattern2(client, _m(acc, "min")) + self.pct10: MetricPattern6[Bitcoin] = MetricPattern6(client, _m(acc, "pct10")) + self.pct25: MetricPattern6[Bitcoin] = MetricPattern6(client, _m(acc, "pct25")) + self.pct75: MetricPattern6[Bitcoin] = MetricPattern6(client, _m(acc, "pct75")) + self.pct90: MetricPattern6[Bitcoin] = MetricPattern6(client, _m(acc, "pct90")) + self.sum: MetricPattern2[Bitcoin] = MetricPattern2(client, _m(acc, "sum")) + class ClassAveragePricePattern(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self._2015: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2015_returns')) - self._2016: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2016_returns')) - self._2017: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2017_returns')) - self._2018: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2018_returns')) - self._2019: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2019_returns')) - self._2020: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2020_returns')) - self._2021: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2021_returns')) - self._2022: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2022_returns')) - self._2023: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2023_returns')) - self._2024: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2024_returns')) - self._2025: MetricPattern4[T] = MetricPattern4(client, _m(acc, '2025_returns')) + self._2015: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2015_returns")) + self._2016: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2016_returns")) + self._2017: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2017_returns")) + self._2018: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2018_returns")) + self._2019: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2019_returns")) + self._2020: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2020_returns")) + self._2021: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2021_returns")) + self._2022: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2022_returns")) + self._2023: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2023_returns")) + self._2024: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2024_returns")) + self._2025: MetricPattern4[T] = MetricPattern4(client, _m(acc, "2025_returns")) + class DollarsPattern(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.average: MetricPattern2[T] = MetricPattern2(client, _m(acc, 'average')) + self.average: MetricPattern2[T] = MetricPattern2(client, _m(acc, "average")) self.base: MetricPattern11[T] = MetricPattern11(client, acc) - self.cumulative: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'cumulative')) - self.max: MetricPattern2[T] = MetricPattern2(client, _m(acc, 'max')) - self.median: MetricPattern6[T] = MetricPattern6(client, _m(acc, 'median')) - self.min: MetricPattern2[T] = MetricPattern2(client, _m(acc, 'min')) - self.pct10: MetricPattern6[T] = MetricPattern6(client, _m(acc, 'pct10')) - self.pct25: MetricPattern6[T] = MetricPattern6(client, _m(acc, 'pct25')) - self.pct75: MetricPattern6[T] = MetricPattern6(client, _m(acc, 'pct75')) - self.pct90: MetricPattern6[T] = MetricPattern6(client, _m(acc, 'pct90')) - self.sum: MetricPattern2[T] = MetricPattern2(client, _m(acc, 'sum')) + self.cumulative: MetricPattern1[T] = MetricPattern1( + client, _m(acc, "cumulative") + ) + self.max: MetricPattern2[T] = MetricPattern2(client, _m(acc, "max")) + self.median: MetricPattern6[T] = MetricPattern6(client, _m(acc, "median")) + self.min: MetricPattern2[T] = MetricPattern2(client, _m(acc, "min")) + self.pct10: MetricPattern6[T] = MetricPattern6(client, _m(acc, "pct10")) + self.pct25: MetricPattern6[T] = MetricPattern6(client, _m(acc, "pct25")) + self.pct75: MetricPattern6[T] = MetricPattern6(client, _m(acc, "pct75")) + self.pct90: MetricPattern6[T] = MetricPattern6(client, _m(acc, "pct90")) + self.sum: MetricPattern2[T] = MetricPattern2(client, _m(acc, "sum")) + class RelativePattern2: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.neg_unrealized_loss_rel_to_own_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'neg_unrealized_loss_rel_to_own_market_cap')) - self.neg_unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'neg_unrealized_loss_rel_to_own_total_unrealized_pnl')) - self.net_unrealized_pnl_rel_to_own_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'net_unrealized_pnl_rel_to_own_market_cap')) - self.net_unrealized_pnl_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'net_unrealized_pnl_rel_to_own_total_unrealized_pnl')) - self.supply_in_loss_rel_to_own_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'supply_in_loss_rel_to_own_supply')) - self.supply_in_profit_rel_to_own_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'supply_in_profit_rel_to_own_supply')) - self.unrealized_loss_rel_to_own_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_loss_rel_to_own_market_cap')) - self.unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_loss_rel_to_own_total_unrealized_pnl')) - self.unrealized_profit_rel_to_own_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_profit_rel_to_own_market_cap')) - self.unrealized_profit_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_profit_rel_to_own_total_unrealized_pnl')) + self.neg_unrealized_loss_rel_to_own_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "neg_unrealized_loss_rel_to_own_market_cap")) + ) + self.neg_unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1( + client, _m(acc, "neg_unrealized_loss_rel_to_own_total_unrealized_pnl") + ) + self.net_unrealized_pnl_rel_to_own_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "net_unrealized_pnl_rel_to_own_market_cap")) + ) + self.net_unrealized_pnl_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1( + client, _m(acc, "net_unrealized_pnl_rel_to_own_total_unrealized_pnl") + ) + self.supply_in_loss_rel_to_own_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, _m(acc, "supply_in_loss_rel_to_own_supply")) + ) + self.supply_in_profit_rel_to_own_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, _m(acc, "supply_in_profit_rel_to_own_supply")) + ) + self.unrealized_loss_rel_to_own_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "unrealized_loss_rel_to_own_market_cap")) + ) + self.unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1( + client, _m(acc, "unrealized_loss_rel_to_own_total_unrealized_pnl") + ) + self.unrealized_profit_rel_to_own_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "unrealized_profit_rel_to_own_market_cap")) + ) + self.unrealized_profit_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1( + client, _m(acc, "unrealized_profit_rel_to_own_total_unrealized_pnl") + ) + class RelativePattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.neg_unrealized_loss_rel_to_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'neg_unrealized_loss_rel_to_market_cap')) - self.net_unrealized_pnl_rel_to_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'net_unrealized_pnl_rel_to_market_cap')) - self.nupl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'nupl')) - self.supply_in_loss_rel_to_circulating_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'supply_in_loss_rel_to_circulating_supply')) - self.supply_in_loss_rel_to_own_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'supply_in_loss_rel_to_own_supply')) - self.supply_in_profit_rel_to_circulating_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'supply_in_profit_rel_to_circulating_supply')) - self.supply_in_profit_rel_to_own_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'supply_in_profit_rel_to_own_supply')) - self.supply_rel_to_circulating_supply: MetricPattern4[StoredF64] = MetricPattern4(client, _m(acc, 'supply_rel_to_circulating_supply')) - self.unrealized_loss_rel_to_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_loss_rel_to_market_cap')) - self.unrealized_profit_rel_to_market_cap: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, 'unrealized_profit_rel_to_market_cap')) + self.neg_unrealized_loss_rel_to_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "neg_unrealized_loss_rel_to_market_cap")) + ) + self.net_unrealized_pnl_rel_to_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "net_unrealized_pnl_rel_to_market_cap")) + ) + self.nupl: MetricPattern1[StoredF32] = MetricPattern1(client, _m(acc, "nupl")) + self.supply_in_loss_rel_to_circulating_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, _m(acc, "supply_in_loss_rel_to_circulating_supply")) + ) + self.supply_in_loss_rel_to_own_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, _m(acc, "supply_in_loss_rel_to_own_supply")) + ) + self.supply_in_profit_rel_to_circulating_supply: MetricPattern1[StoredF64] = ( + MetricPattern1( + client, _m(acc, "supply_in_profit_rel_to_circulating_supply") + ) + ) + self.supply_in_profit_rel_to_own_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, _m(acc, "supply_in_profit_rel_to_own_supply")) + ) + self.supply_rel_to_circulating_supply: MetricPattern4[StoredF64] = ( + MetricPattern4(client, _m(acc, "supply_rel_to_circulating_supply")) + ) + self.unrealized_loss_rel_to_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "unrealized_loss_rel_to_market_cap")) + ) + self.unrealized_profit_rel_to_market_cap: MetricPattern1[StoredF32] = ( + MetricPattern1(client, _m(acc, "unrealized_profit_rel_to_market_cap")) + ) + class CountPattern2(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.average: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'average')) - self.cumulative: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'cumulative')) - self.max: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'max')) - self.median: MetricPattern11[T] = MetricPattern11(client, _m(acc, 'median')) - self.min: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'min')) - self.pct10: MetricPattern11[T] = MetricPattern11(client, _m(acc, 'pct10')) - self.pct25: MetricPattern11[T] = MetricPattern11(client, _m(acc, 'pct25')) - self.pct75: MetricPattern11[T] = MetricPattern11(client, _m(acc, 'pct75')) - self.pct90: MetricPattern11[T] = MetricPattern11(client, _m(acc, 'pct90')) - self.sum: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'sum')) + self.average: MetricPattern1[T] = MetricPattern1(client, _m(acc, "average")) + self.cumulative: MetricPattern1[T] = MetricPattern1( + client, _m(acc, "cumulative") + ) + self.max: MetricPattern1[T] = MetricPattern1(client, _m(acc, "max")) + self.median: MetricPattern11[T] = MetricPattern11(client, _m(acc, "median")) + self.min: MetricPattern1[T] = MetricPattern1(client, _m(acc, "min")) + self.pct10: MetricPattern11[T] = MetricPattern11(client, _m(acc, "pct10")) + self.pct25: MetricPattern11[T] = MetricPattern11(client, _m(acc, "pct25")) + self.pct75: MetricPattern11[T] = MetricPattern11(client, _m(acc, "pct75")) + self.pct90: MetricPattern11[T] = MetricPattern11(client, _m(acc, "pct90")) + self.sum: MetricPattern1[T] = MetricPattern1(client, _m(acc, "sum")) + class AddrCountPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.all: MetricPattern1[StoredU64] = MetricPattern1(client, acc) - self.p2a: MetricPattern1[StoredU64] = MetricPattern1(client, _p('p2a', acc)) - self.p2pk33: MetricPattern1[StoredU64] = MetricPattern1(client, _p('p2pk33', acc)) - self.p2pk65: MetricPattern1[StoredU64] = MetricPattern1(client, _p('p2pk65', acc)) - self.p2pkh: MetricPattern1[StoredU64] = MetricPattern1(client, _p('p2pkh', acc)) - self.p2sh: MetricPattern1[StoredU64] = MetricPattern1(client, _p('p2sh', acc)) - self.p2tr: MetricPattern1[StoredU64] = MetricPattern1(client, _p('p2tr', acc)) - self.p2wpkh: MetricPattern1[StoredU64] = MetricPattern1(client, _p('p2wpkh', acc)) - self.p2wsh: MetricPattern1[StoredU64] = MetricPattern1(client, _p('p2wsh', acc)) + self.p2a: MetricPattern1[StoredU64] = MetricPattern1(client, _p("p2a", acc)) + self.p2pk33: MetricPattern1[StoredU64] = MetricPattern1( + client, _p("p2pk33", acc) + ) + self.p2pk65: MetricPattern1[StoredU64] = MetricPattern1( + client, _p("p2pk65", acc) + ) + self.p2pkh: MetricPattern1[StoredU64] = MetricPattern1(client, _p("p2pkh", acc)) + self.p2sh: MetricPattern1[StoredU64] = MetricPattern1(client, _p("p2sh", acc)) + self.p2tr: MetricPattern1[StoredU64] = MetricPattern1(client, _p("p2tr", acc)) + self.p2wpkh: MetricPattern1[StoredU64] = MetricPattern1( + client, _p("p2wpkh", acc) + ) + self.p2wsh: MetricPattern1[StoredU64] = MetricPattern1(client, _p("p2wsh", acc)) + class FullnessPattern(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.average: MetricPattern2[T] = MetricPattern2(client, _m(acc, 'average')) + self.average: MetricPattern2[T] = MetricPattern2(client, _m(acc, "average")) self.base: MetricPattern11[T] = MetricPattern11(client, acc) - self.max: MetricPattern2[T] = MetricPattern2(client, _m(acc, 'max')) - self.median: MetricPattern6[T] = MetricPattern6(client, _m(acc, 'median')) - self.min: MetricPattern2[T] = MetricPattern2(client, _m(acc, 'min')) - self.pct10: MetricPattern6[T] = MetricPattern6(client, _m(acc, 'pct10')) - self.pct25: MetricPattern6[T] = MetricPattern6(client, _m(acc, 'pct25')) - self.pct75: MetricPattern6[T] = MetricPattern6(client, _m(acc, 'pct75')) - self.pct90: MetricPattern6[T] = MetricPattern6(client, _m(acc, 'pct90')) + self.max: MetricPattern2[T] = MetricPattern2(client, _m(acc, "max")) + self.median: MetricPattern6[T] = MetricPattern6(client, _m(acc, "median")) + self.min: MetricPattern2[T] = MetricPattern2(client, _m(acc, "min")) + self.pct10: MetricPattern6[T] = MetricPattern6(client, _m(acc, "pct10")) + self.pct25: MetricPattern6[T] = MetricPattern6(client, _m(acc, "pct25")) + self.pct75: MetricPattern6[T] = MetricPattern6(client, _m(acc, "pct75")) + self.pct90: MetricPattern6[T] = MetricPattern6(client, _m(acc, "pct90")) + class FeeRatePattern(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.average: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'average')) - self.max: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'max')) - self.median: MetricPattern11[T] = MetricPattern11(client, _m(acc, 'median')) - self.min: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'min')) - self.pct10: MetricPattern11[T] = MetricPattern11(client, _m(acc, 'pct10')) - self.pct25: MetricPattern11[T] = MetricPattern11(client, _m(acc, 'pct25')) - self.pct75: MetricPattern11[T] = MetricPattern11(client, _m(acc, 'pct75')) - self.pct90: MetricPattern11[T] = MetricPattern11(client, _m(acc, 'pct90')) + self.average: MetricPattern1[T] = MetricPattern1(client, _m(acc, "average")) + self.max: MetricPattern1[T] = MetricPattern1(client, _m(acc, "max")) + self.median: MetricPattern11[T] = MetricPattern11(client, _m(acc, "median")) + self.min: MetricPattern1[T] = MetricPattern1(client, _m(acc, "min")) + self.pct10: MetricPattern11[T] = MetricPattern11(client, _m(acc, "pct10")) + self.pct25: MetricPattern11[T] = MetricPattern11(client, _m(acc, "pct25")) + self.pct75: MetricPattern11[T] = MetricPattern11(client, _m(acc, "pct75")) + self.pct90: MetricPattern11[T] = MetricPattern11(client, _m(acc, "pct90")) self.txindex: MetricPattern27[T] = MetricPattern27(client, acc) + class _0satsPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.activity: ActivityPattern2 = ActivityPattern2(client, acc) - self.addr_count: MetricPattern1[StoredU64] = MetricPattern1(client, _m(acc, 'addr_count')) + self.addr_count: MetricPattern1[StoredU64] = MetricPattern1( + client, _m(acc, "addr_count") + ) self.cost_basis: CostBasisPattern = CostBasisPattern(client, acc) - self.outputs: OutputsPattern = OutputsPattern(client, _m(acc, 'utxo_count')) + self.outputs: OutputsPattern = OutputsPattern(client, _m(acc, "utxo_count")) self.realized: RealizedPattern = RealizedPattern(client, acc) self.relative: RelativePattern = RelativePattern(client, acc) - self.supply: SupplyPattern2 = SupplyPattern2(client, _m(acc, 'supply')) + self.supply: SupplyPattern2 = SupplyPattern2(client, _m(acc, "supply")) self.unrealized: UnrealizedPattern = UnrealizedPattern(client, acc) + class _100btcPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.activity: ActivityPattern2 = ActivityPattern2(client, acc) self.cost_basis: CostBasisPattern = CostBasisPattern(client, acc) - self.outputs: OutputsPattern = OutputsPattern(client, _m(acc, 'utxo_count')) + self.outputs: OutputsPattern = OutputsPattern(client, _m(acc, "utxo_count")) self.realized: RealizedPattern = RealizedPattern(client, acc) self.relative: RelativePattern = RelativePattern(client, acc) - self.supply: SupplyPattern2 = SupplyPattern2(client, _m(acc, 'supply')) + self.supply: SupplyPattern2 = SupplyPattern2(client, _m(acc, "supply")) self.unrealized: UnrealizedPattern = UnrealizedPattern(client, acc) + class PeriodCagrPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self._10y: MetricPattern4[StoredF32] = MetricPattern4(client, _p('10y', acc)) - self._2y: MetricPattern4[StoredF32] = MetricPattern4(client, _p('2y', acc)) - self._3y: MetricPattern4[StoredF32] = MetricPattern4(client, _p('3y', acc)) - self._4y: MetricPattern4[StoredF32] = MetricPattern4(client, _p('4y', acc)) - self._5y: MetricPattern4[StoredF32] = MetricPattern4(client, _p('5y', acc)) - self._6y: MetricPattern4[StoredF32] = MetricPattern4(client, _p('6y', acc)) - self._8y: MetricPattern4[StoredF32] = MetricPattern4(client, _p('8y', acc)) + self._10y: MetricPattern4[StoredF32] = MetricPattern4(client, _p("10y", acc)) + self._2y: MetricPattern4[StoredF32] = MetricPattern4(client, _p("2y", acc)) + self._3y: MetricPattern4[StoredF32] = MetricPattern4(client, _p("3y", acc)) + self._4y: MetricPattern4[StoredF32] = MetricPattern4(client, _p("4y", acc)) + self._5y: MetricPattern4[StoredF32] = MetricPattern4(client, _p("5y", acc)) + self._6y: MetricPattern4[StoredF32] = MetricPattern4(client, _p("6y", acc)) + self._8y: MetricPattern4[StoredF32] = MetricPattern4(client, _p("8y", acc)) + class UnrealizedPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.neg_unrealized_loss: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'neg_unrealized_loss')) - self.net_unrealized_pnl: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'net_unrealized_pnl')) - self.supply_in_loss: ActiveSupplyPattern = ActiveSupplyPattern(client, _m(acc, 'supply_in_loss')) - self.supply_in_profit: ActiveSupplyPattern = ActiveSupplyPattern(client, _m(acc, 'supply_in_profit')) - self.total_unrealized_pnl: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'total_unrealized_pnl')) - self.unrealized_loss: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'unrealized_loss')) - self.unrealized_profit: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'unrealized_profit')) + self.neg_unrealized_loss: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "neg_unrealized_loss") + ) + self.net_unrealized_pnl: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "net_unrealized_pnl") + ) + self.supply_in_loss: ActiveSupplyPattern = ActiveSupplyPattern( + client, _m(acc, "supply_in_loss") + ) + self.supply_in_profit: ActiveSupplyPattern = ActiveSupplyPattern( + client, _m(acc, "supply_in_profit") + ) + self.total_unrealized_pnl: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "total_unrealized_pnl") + ) + self.unrealized_loss: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "unrealized_loss") + ) + self.unrealized_profit: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "unrealized_profit") + ) + class _10yTo12yPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.activity: ActivityPattern2 = ActivityPattern2(client, acc) self.cost_basis: CostBasisPattern2 = CostBasisPattern2(client, acc) - self.outputs: OutputsPattern = OutputsPattern(client, _m(acc, 'utxo_count')) + self.outputs: OutputsPattern = OutputsPattern(client, _m(acc, "utxo_count")) self.realized: RealizedPattern2 = RealizedPattern2(client, acc) self.relative: RelativePattern2 = RelativePattern2(client, acc) - self.supply: SupplyPattern2 = SupplyPattern2(client, _m(acc, 'supply')) + self.supply: SupplyPattern2 = SupplyPattern2(client, _m(acc, "supply")) self.unrealized: UnrealizedPattern = UnrealizedPattern(client, acc) + class _0satsPattern2: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.activity: ActivityPattern2 = ActivityPattern2(client, acc) self.cost_basis: CostBasisPattern = CostBasisPattern(client, acc) - self.outputs: OutputsPattern = OutputsPattern(client, _m(acc, 'utxo_count')) + self.outputs: OutputsPattern = OutputsPattern(client, _m(acc, "utxo_count")) self.realized: RealizedPattern = RealizedPattern(client, acc) - self.relative: RelativePattern4 = RelativePattern4(client, _m(acc, 'supply_in')) - self.supply: SupplyPattern2 = SupplyPattern2(client, _m(acc, 'supply')) + self.relative: RelativePattern4 = RelativePattern4(client, _m(acc, "supply_in")) + self.supply: SupplyPattern2 = SupplyPattern2(client, _m(acc, "supply")) self.unrealized: UnrealizedPattern = UnrealizedPattern(client, acc) + class _10yPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.activity: ActivityPattern2 = ActivityPattern2(client, acc) self.cost_basis: CostBasisPattern = CostBasisPattern(client, acc) - self.outputs: OutputsPattern = OutputsPattern(client, _m(acc, 'utxo_count')) + self.outputs: OutputsPattern = OutputsPattern(client, _m(acc, "utxo_count")) self.realized: RealizedPattern4 = RealizedPattern4(client, acc) self.relative: RelativePattern = RelativePattern(client, acc) - self.supply: SupplyPattern2 = SupplyPattern2(client, _m(acc, 'supply')) + self.supply: SupplyPattern2 = SupplyPattern2(client, _m(acc, "supply")) self.unrealized: UnrealizedPattern = UnrealizedPattern(client, acc) + class ActivityPattern2: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.coinblocks_destroyed: BlockCountPattern[StoredF64] = BlockCountPattern(client, _m(acc, 'coinblocks_destroyed')) - self.coindays_destroyed: BlockCountPattern[StoredF64] = BlockCountPattern(client, _m(acc, 'coindays_destroyed')) - self.satblocks_destroyed: MetricPattern11[Sats] = MetricPattern11(client, _m(acc, 'satblocks_destroyed')) - self.satdays_destroyed: MetricPattern11[Sats] = MetricPattern11(client, _m(acc, 'satdays_destroyed')) - self.sent: UnclaimedRewardsPattern = UnclaimedRewardsPattern(client, _m(acc, 'sent')) + self.coinblocks_destroyed: BlockCountPattern[StoredF64] = BlockCountPattern( + client, _m(acc, "coinblocks_destroyed") + ) + self.coindays_destroyed: BlockCountPattern[StoredF64] = BlockCountPattern( + client, _m(acc, "coindays_destroyed") + ) + self.satblocks_destroyed: MetricPattern11[Sats] = MetricPattern11( + client, _m(acc, "satblocks_destroyed") + ) + self.satdays_destroyed: MetricPattern11[Sats] = MetricPattern11( + client, _m(acc, "satdays_destroyed") + ) + self.sent: UnclaimedRewardsPattern = UnclaimedRewardsPattern( + client, _m(acc, "sent") + ) + class SplitPattern2(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.close: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'close')) - self.high: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'high')) - self.low: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'low')) - self.open: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'open')) + self.close: MetricPattern1[T] = MetricPattern1(client, _m(acc, "close")) + self.high: MetricPattern1[T] = MetricPattern1(client, _m(acc, "high")) + self.low: MetricPattern1[T] = MetricPattern1(client, _m(acc, "low")) + self.open: MetricPattern1[T] = MetricPattern1(client, _m(acc, "open")) + class _2015Pattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.bitcoin: MetricPattern4[Bitcoin] = MetricPattern4(client, _m(acc, 'btc')) - self.dollars: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, 'usd')) + self.bitcoin: MetricPattern4[Bitcoin] = MetricPattern4(client, _m(acc, "btc")) + self.dollars: MetricPattern4[Dollars] = MetricPattern4(client, _m(acc, "usd")) self.sats: MetricPattern4[Sats] = MetricPattern4(client, acc) + class CoinbasePattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.bitcoin: BitcoinPattern = BitcoinPattern(client, _m(acc, 'btc')) - self.dollars: DollarsPattern[Dollars] = DollarsPattern(client, _m(acc, 'usd')) + self.bitcoin: BitcoinPattern = BitcoinPattern(client, _m(acc, "btc")) + self.dollars: DollarsPattern[Dollars] = DollarsPattern(client, _m(acc, "usd")) self.sats: DollarsPattern[Sats] = DollarsPattern(client, acc) + class CoinbasePattern2: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.bitcoin: BlockCountPattern[Bitcoin] = BlockCountPattern(client, _m(acc, 'btc')) - self.dollars: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'usd')) + self.bitcoin: BlockCountPattern[Bitcoin] = BlockCountPattern( + client, _m(acc, "btc") + ) + self.dollars: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "usd") + ) self.sats: BlockCountPattern[Sats] = BlockCountPattern(client, acc) + class SegwitAdoptionPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.base: MetricPattern11[StoredF32] = MetricPattern11(client, acc) - self.cumulative: MetricPattern2[StoredF32] = MetricPattern2(client, _m(acc, 'cumulative')) - self.sum: MetricPattern2[StoredF32] = MetricPattern2(client, _m(acc, 'sum')) + self.cumulative: MetricPattern2[StoredF32] = MetricPattern2( + client, _m(acc, "cumulative") + ) + self.sum: MetricPattern2[StoredF32] = MetricPattern2(client, _m(acc, "sum")) + class CostBasisPattern2: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.max: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'max_cost_basis')) - self.min: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'min_cost_basis')) - self.percentiles: PercentilesPattern = PercentilesPattern(client, _m(acc, 'cost_basis')) + self.max: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "max_cost_basis") + ) + self.min: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "min_cost_basis") + ) + self.percentiles: PercentilesPattern = PercentilesPattern( + client, _m(acc, "cost_basis") + ) + class ActiveSupplyPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.bitcoin: MetricPattern1[Bitcoin] = MetricPattern1(client, _m(acc, 'btc')) - self.dollars: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'usd')) + self.bitcoin: MetricPattern1[Bitcoin] = MetricPattern1(client, _m(acc, "btc")) + self.dollars: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, "usd")) self.sats: MetricPattern1[Sats] = MetricPattern1(client, acc) + class UnclaimedRewardsPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.bitcoin: BitcoinPattern2[Bitcoin] = BitcoinPattern2(client, _m(acc, 'btc')) - self.dollars: BlockCountPattern[Dollars] = BlockCountPattern(client, _m(acc, 'usd')) + self.bitcoin: BitcoinPattern2[Bitcoin] = BitcoinPattern2(client, _m(acc, "btc")) + self.dollars: BlockCountPattern[Dollars] = BlockCountPattern( + client, _m(acc, "usd") + ) self.sats: BlockCountPattern[Sats] = BlockCountPattern(client, acc) + class CostBasisPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.max: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'max_cost_basis')) - self.min: MetricPattern1[Dollars] = MetricPattern1(client, _m(acc, 'min_cost_basis')) + self.max: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "max_cost_basis") + ) + self.min: MetricPattern1[Dollars] = MetricPattern1( + client, _m(acc, "min_cost_basis") + ) + class SupplyPattern2: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.halved: ActiveSupplyPattern = ActiveSupplyPattern(client, _m(acc, 'halved')) + self.halved: ActiveSupplyPattern = ActiveSupplyPattern( + client, _m(acc, "halved") + ) self.total: ActiveSupplyPattern = ActiveSupplyPattern(client, acc) + class RelativePattern4: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.supply_in_loss_rel_to_own_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'loss_rel_to_own_supply')) - self.supply_in_profit_rel_to_own_supply: MetricPattern1[StoredF64] = MetricPattern1(client, _m(acc, 'profit_rel_to_own_supply')) + self.supply_in_loss_rel_to_own_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, _m(acc, "loss_rel_to_own_supply")) + ) + self.supply_in_profit_rel_to_own_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, _m(acc, "profit_rel_to_own_supply")) + ) + class _1dReturns1mSdPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'sd')) - self.sma: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, 'sma')) + self.sd: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "sd")) + self.sma: MetricPattern4[StoredF32] = MetricPattern4(client, _m(acc, "sma")) + class BlockCountPattern(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.cumulative: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'cumulative')) + self.cumulative: MetricPattern1[T] = MetricPattern1( + client, _m(acc, "cumulative") + ) self.sum: MetricPattern1[T] = MetricPattern1(client, acc) + class BitcoinPattern2(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.cumulative: MetricPattern2[T] = MetricPattern2(client, _m(acc, 'cumulative')) + self.cumulative: MetricPattern2[T] = MetricPattern2( + client, _m(acc, "cumulative") + ) self.sum: MetricPattern1[T] = MetricPattern1(client, acc) + class SatsPattern(Generic[T]): """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" - self.ohlc: MetricPattern1[T] = MetricPattern1(client, _m(acc, 'ohlc_sats')) - self.split: SplitPattern2[T] = SplitPattern2(client, _m(acc, 'sats')) + self.ohlc: MetricPattern1[T] = MetricPattern1(client, _m(acc, "ohlc_sats")) + self.split: SplitPattern2[T] = SplitPattern2(client, _m(acc, "sats")) + class RealizedPriceExtraPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.ratio: MetricPattern4[StoredF32] = MetricPattern4(client, acc) + class OutputsPattern: """Pattern struct for repeated tree structure.""" - + def __init__(self, client: BrkClientBase, acc: str): """Create pattern node with accumulated metric name.""" self.utxo_count: MetricPattern1[StoredU64] = MetricPattern1(client, acc) + # Metrics tree classes + class MetricsTree_Addresses: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.first_p2aaddressindex: MetricPattern11[P2AAddressIndex] = MetricPattern11(client, 'first_p2aaddressindex') - self.first_p2pk33addressindex: MetricPattern11[P2PK33AddressIndex] = MetricPattern11(client, 'first_p2pk33addressindex') - self.first_p2pk65addressindex: MetricPattern11[P2PK65AddressIndex] = MetricPattern11(client, 'first_p2pk65addressindex') - self.first_p2pkhaddressindex: MetricPattern11[P2PKHAddressIndex] = MetricPattern11(client, 'first_p2pkhaddressindex') - self.first_p2shaddressindex: MetricPattern11[P2SHAddressIndex] = MetricPattern11(client, 'first_p2shaddressindex') - self.first_p2traddressindex: MetricPattern11[P2TRAddressIndex] = MetricPattern11(client, 'first_p2traddressindex') - self.first_p2wpkhaddressindex: MetricPattern11[P2WPKHAddressIndex] = MetricPattern11(client, 'first_p2wpkhaddressindex') - self.first_p2wshaddressindex: MetricPattern11[P2WSHAddressIndex] = MetricPattern11(client, 'first_p2wshaddressindex') - self.p2abytes: MetricPattern16[P2ABytes] = MetricPattern16(client, 'p2abytes') - self.p2pk33bytes: MetricPattern18[P2PK33Bytes] = MetricPattern18(client, 'p2pk33bytes') - self.p2pk65bytes: MetricPattern19[P2PK65Bytes] = MetricPattern19(client, 'p2pk65bytes') - self.p2pkhbytes: MetricPattern20[P2PKHBytes] = MetricPattern20(client, 'p2pkhbytes') - self.p2shbytes: MetricPattern21[P2SHBytes] = MetricPattern21(client, 'p2shbytes') - self.p2trbytes: MetricPattern22[P2TRBytes] = MetricPattern22(client, 'p2trbytes') - self.p2wpkhbytes: MetricPattern23[P2WPKHBytes] = MetricPattern23(client, 'p2wpkhbytes') - self.p2wshbytes: MetricPattern24[P2WSHBytes] = MetricPattern24(client, 'p2wshbytes') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.first_p2aaddressindex: MetricPattern11[P2AAddressIndex] = MetricPattern11( + client, "first_p2aaddressindex" + ) + self.first_p2pk33addressindex: MetricPattern11[P2PK33AddressIndex] = ( + MetricPattern11(client, "first_p2pk33addressindex") + ) + self.first_p2pk65addressindex: MetricPattern11[P2PK65AddressIndex] = ( + MetricPattern11(client, "first_p2pk65addressindex") + ) + self.first_p2pkhaddressindex: MetricPattern11[P2PKHAddressIndex] = ( + MetricPattern11(client, "first_p2pkhaddressindex") + ) + self.first_p2shaddressindex: MetricPattern11[P2SHAddressIndex] = ( + MetricPattern11(client, "first_p2shaddressindex") + ) + self.first_p2traddressindex: MetricPattern11[P2TRAddressIndex] = ( + MetricPattern11(client, "first_p2traddressindex") + ) + self.first_p2wpkhaddressindex: MetricPattern11[P2WPKHAddressIndex] = ( + MetricPattern11(client, "first_p2wpkhaddressindex") + ) + self.first_p2wshaddressindex: MetricPattern11[P2WSHAddressIndex] = ( + MetricPattern11(client, "first_p2wshaddressindex") + ) + self.p2abytes: MetricPattern16[P2ABytes] = MetricPattern16(client, "p2abytes") + self.p2pk33bytes: MetricPattern18[P2PK33Bytes] = MetricPattern18( + client, "p2pk33bytes" + ) + self.p2pk65bytes: MetricPattern19[P2PK65Bytes] = MetricPattern19( + client, "p2pk65bytes" + ) + self.p2pkhbytes: MetricPattern20[P2PKHBytes] = MetricPattern20( + client, "p2pkhbytes" + ) + self.p2shbytes: MetricPattern21[P2SHBytes] = MetricPattern21( + client, "p2shbytes" + ) + self.p2trbytes: MetricPattern22[P2TRBytes] = MetricPattern22( + client, "p2trbytes" + ) + self.p2wpkhbytes: MetricPattern23[P2WPKHBytes] = MetricPattern23( + client, "p2wpkhbytes" + ) + self.p2wshbytes: MetricPattern24[P2WSHBytes] = MetricPattern24( + client, "p2wshbytes" + ) + class MetricsTree_Blocks_Count: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._1m_block_count: MetricPattern1[StoredU32] = MetricPattern1(client, '1m_block_count') - self._1m_start: MetricPattern11[Height] = MetricPattern11(client, '1m_start') - self._1w_block_count: MetricPattern1[StoredU32] = MetricPattern1(client, '1w_block_count') - self._1w_start: MetricPattern11[Height] = MetricPattern11(client, '1w_start') - self._1y_block_count: MetricPattern1[StoredU32] = MetricPattern1(client, '1y_block_count') - self._1y_start: MetricPattern11[Height] = MetricPattern11(client, '1y_start') - self._24h_block_count: MetricPattern1[StoredU32] = MetricPattern1(client, '24h_block_count') - self._24h_start: MetricPattern11[Height] = MetricPattern11(client, '24h_start') - self.block_count: BlockCountPattern[StoredU32] = BlockCountPattern(client, 'block_count') - self.block_count_target: MetricPattern4[StoredU64] = MetricPattern4(client, 'block_count_target') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._1m_block_count: MetricPattern1[StoredU32] = MetricPattern1( + client, "1m_block_count" + ) + self._1m_start: MetricPattern11[Height] = MetricPattern11(client, "1m_start") + self._1w_block_count: MetricPattern1[StoredU32] = MetricPattern1( + client, "1w_block_count" + ) + self._1w_start: MetricPattern11[Height] = MetricPattern11(client, "1w_start") + self._1y_block_count: MetricPattern1[StoredU32] = MetricPattern1( + client, "1y_block_count" + ) + self._1y_start: MetricPattern11[Height] = MetricPattern11(client, "1y_start") + self._24h_block_count: MetricPattern1[StoredU32] = MetricPattern1( + client, "24h_block_count" + ) + self._24h_start: MetricPattern11[Height] = MetricPattern11(client, "24h_start") + self.block_count: BlockCountPattern[StoredU32] = BlockCountPattern( + client, "block_count" + ) + self.block_count_target: MetricPattern4[StoredU64] = MetricPattern4( + client, "block_count_target" + ) + class MetricsTree_Blocks_Difficulty: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.adjustment: MetricPattern1[StoredF32] = MetricPattern1(client, 'difficulty_adjustment') - self.as_hash: MetricPattern1[StoredF32] = MetricPattern1(client, 'difficulty_as_hash') - self.blocks_before_next_adjustment: MetricPattern1[StoredU32] = MetricPattern1(client, 'blocks_before_next_difficulty_adjustment') - self.days_before_next_adjustment: MetricPattern1[StoredF32] = MetricPattern1(client, 'days_before_next_difficulty_adjustment') - self.epoch: MetricPattern4[DifficultyEpoch] = MetricPattern4(client, 'difficultyepoch') - self.raw: MetricPattern1[StoredF64] = MetricPattern1(client, 'difficulty') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.adjustment: MetricPattern1[StoredF32] = MetricPattern1( + client, "difficulty_adjustment" + ) + self.as_hash: MetricPattern1[StoredF32] = MetricPattern1( + client, "difficulty_as_hash" + ) + self.blocks_before_next_adjustment: MetricPattern1[StoredU32] = MetricPattern1( + client, "blocks_before_next_difficulty_adjustment" + ) + self.days_before_next_adjustment: MetricPattern1[StoredF32] = MetricPattern1( + client, "days_before_next_difficulty_adjustment" + ) + self.epoch: MetricPattern4[DifficultyEpoch] = MetricPattern4( + client, "difficultyepoch" + ) + self.raw: MetricPattern1[StoredF64] = MetricPattern1(client, "difficulty") + class MetricsTree_Blocks_Halving: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.blocks_before_next_halving: MetricPattern1[StoredU32] = MetricPattern1(client, 'blocks_before_next_halving') - self.days_before_next_halving: MetricPattern1[StoredF32] = MetricPattern1(client, 'days_before_next_halving') - self.epoch: MetricPattern4[HalvingEpoch] = MetricPattern4(client, 'halvingepoch') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.blocks_before_next_halving: MetricPattern1[StoredU32] = MetricPattern1( + client, "blocks_before_next_halving" + ) + self.days_before_next_halving: MetricPattern1[StoredF32] = MetricPattern1( + client, "days_before_next_halving" + ) + self.epoch: MetricPattern4[HalvingEpoch] = MetricPattern4( + client, "halvingepoch" + ) + class MetricsTree_Blocks_Mining: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.hash_price_phs: MetricPattern1[StoredF32] = MetricPattern1(client, 'hash_price_phs') - self.hash_price_phs_min: MetricPattern1[StoredF32] = MetricPattern1(client, 'hash_price_phs_min') - self.hash_price_rebound: MetricPattern1[StoredF32] = MetricPattern1(client, 'hash_price_rebound') - self.hash_price_ths: MetricPattern1[StoredF32] = MetricPattern1(client, 'hash_price_ths') - self.hash_price_ths_min: MetricPattern1[StoredF32] = MetricPattern1(client, 'hash_price_ths_min') - self.hash_rate: MetricPattern1[StoredF64] = MetricPattern1(client, 'hash_rate') - self.hash_rate_1m_sma: MetricPattern4[StoredF32] = MetricPattern4(client, 'hash_rate_1m_sma') - self.hash_rate_1w_sma: MetricPattern4[StoredF64] = MetricPattern4(client, 'hash_rate_1w_sma') - self.hash_rate_1y_sma: MetricPattern4[StoredF32] = MetricPattern4(client, 'hash_rate_1y_sma') - self.hash_rate_2m_sma: MetricPattern4[StoredF32] = MetricPattern4(client, 'hash_rate_2m_sma') - self.hash_value_phs: MetricPattern1[StoredF32] = MetricPattern1(client, 'hash_value_phs') - self.hash_value_phs_min: MetricPattern1[StoredF32] = MetricPattern1(client, 'hash_value_phs_min') - self.hash_value_rebound: MetricPattern1[StoredF32] = MetricPattern1(client, 'hash_value_rebound') - self.hash_value_ths: MetricPattern1[StoredF32] = MetricPattern1(client, 'hash_value_ths') - self.hash_value_ths_min: MetricPattern1[StoredF32] = MetricPattern1(client, 'hash_value_ths_min') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.hash_price_phs: MetricPattern1[StoredF32] = MetricPattern1( + client, "hash_price_phs" + ) + self.hash_price_phs_min: MetricPattern1[StoredF32] = MetricPattern1( + client, "hash_price_phs_min" + ) + self.hash_price_rebound: MetricPattern1[StoredF32] = MetricPattern1( + client, "hash_price_rebound" + ) + self.hash_price_ths: MetricPattern1[StoredF32] = MetricPattern1( + client, "hash_price_ths" + ) + self.hash_price_ths_min: MetricPattern1[StoredF32] = MetricPattern1( + client, "hash_price_ths_min" + ) + self.hash_rate: MetricPattern1[StoredF64] = MetricPattern1(client, "hash_rate") + self.hash_rate_1m_sma: MetricPattern4[StoredF32] = MetricPattern4( + client, "hash_rate_1m_sma" + ) + self.hash_rate_1w_sma: MetricPattern4[StoredF64] = MetricPattern4( + client, "hash_rate_1w_sma" + ) + self.hash_rate_1y_sma: MetricPattern4[StoredF32] = MetricPattern4( + client, "hash_rate_1y_sma" + ) + self.hash_rate_2m_sma: MetricPattern4[StoredF32] = MetricPattern4( + client, "hash_rate_2m_sma" + ) + self.hash_value_phs: MetricPattern1[StoredF32] = MetricPattern1( + client, "hash_value_phs" + ) + self.hash_value_phs_min: MetricPattern1[StoredF32] = MetricPattern1( + client, "hash_value_phs_min" + ) + self.hash_value_rebound: MetricPattern1[StoredF32] = MetricPattern1( + client, "hash_value_rebound" + ) + self.hash_value_ths: MetricPattern1[StoredF32] = MetricPattern1( + client, "hash_value_ths" + ) + self.hash_value_ths_min: MetricPattern1[StoredF32] = MetricPattern1( + client, "hash_value_ths_min" + ) + class MetricsTree_Blocks_Rewards_24hCoinbaseSum: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.bitcoin: MetricPattern11[Bitcoin] = MetricPattern11(client, '24h_coinbase_sum_btc') - self.dollars: MetricPattern11[Dollars] = MetricPattern11(client, '24h_coinbase_sum_usd') - self.sats: MetricPattern11[Sats] = MetricPattern11(client, '24h_coinbase_sum') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.bitcoin: MetricPattern11[Bitcoin] = MetricPattern11( + client, "24h_coinbase_sum_btc" + ) + self.dollars: MetricPattern11[Dollars] = MetricPattern11( + client, "24h_coinbase_sum_usd" + ) + self.sats: MetricPattern11[Sats] = MetricPattern11(client, "24h_coinbase_sum") + class MetricsTree_Blocks_Rewards: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._24h_coinbase_sum: MetricsTree_Blocks_Rewards_24hCoinbaseSum = MetricsTree_Blocks_Rewards_24hCoinbaseSum(client) - self.coinbase: CoinbasePattern = CoinbasePattern(client, 'coinbase') - self.fee_dominance: MetricPattern6[StoredF32] = MetricPattern6(client, 'fee_dominance') - self.subsidy: CoinbasePattern = CoinbasePattern(client, 'subsidy') - self.subsidy_dominance: MetricPattern6[StoredF32] = MetricPattern6(client, 'subsidy_dominance') - self.subsidy_usd_1y_sma: MetricPattern4[Dollars] = MetricPattern4(client, 'subsidy_usd_1y_sma') - self.unclaimed_rewards: UnclaimedRewardsPattern = UnclaimedRewardsPattern(client, 'unclaimed_rewards') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._24h_coinbase_sum: MetricsTree_Blocks_Rewards_24hCoinbaseSum = ( + MetricsTree_Blocks_Rewards_24hCoinbaseSum(client) + ) + self.coinbase: CoinbasePattern = CoinbasePattern(client, "coinbase") + self.fee_dominance: MetricPattern6[StoredF32] = MetricPattern6( + client, "fee_dominance" + ) + self.subsidy: CoinbasePattern = CoinbasePattern(client, "subsidy") + self.subsidy_dominance: MetricPattern6[StoredF32] = MetricPattern6( + client, "subsidy_dominance" + ) + self.subsidy_usd_1y_sma: MetricPattern4[Dollars] = MetricPattern4( + client, "subsidy_usd_1y_sma" + ) + self.unclaimed_rewards: UnclaimedRewardsPattern = UnclaimedRewardsPattern( + client, "unclaimed_rewards" + ) + class MetricsTree_Blocks_Size: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.average: MetricPattern2[StoredU64] = MetricPattern2(client, 'block_size_average') - self.cumulative: MetricPattern1[StoredU64] = MetricPattern1(client, 'block_size_cumulative') - self.max: MetricPattern2[StoredU64] = MetricPattern2(client, 'block_size_max') - self.median: MetricPattern6[StoredU64] = MetricPattern6(client, 'block_size_median') - self.min: MetricPattern2[StoredU64] = MetricPattern2(client, 'block_size_min') - self.pct10: MetricPattern6[StoredU64] = MetricPattern6(client, 'block_size_pct10') - self.pct25: MetricPattern6[StoredU64] = MetricPattern6(client, 'block_size_pct25') - self.pct75: MetricPattern6[StoredU64] = MetricPattern6(client, 'block_size_pct75') - self.pct90: MetricPattern6[StoredU64] = MetricPattern6(client, 'block_size_pct90') - self.sum: MetricPattern2[StoredU64] = MetricPattern2(client, 'block_size_sum') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.average: MetricPattern2[StoredU64] = MetricPattern2( + client, "block_size_average" + ) + self.cumulative: MetricPattern1[StoredU64] = MetricPattern1( + client, "block_size_cumulative" + ) + self.max: MetricPattern2[StoredU64] = MetricPattern2(client, "block_size_max") + self.median: MetricPattern6[StoredU64] = MetricPattern6( + client, "block_size_median" + ) + self.min: MetricPattern2[StoredU64] = MetricPattern2(client, "block_size_min") + self.pct10: MetricPattern6[StoredU64] = MetricPattern6( + client, "block_size_pct10" + ) + self.pct25: MetricPattern6[StoredU64] = MetricPattern6( + client, "block_size_pct25" + ) + self.pct75: MetricPattern6[StoredU64] = MetricPattern6( + client, "block_size_pct75" + ) + self.pct90: MetricPattern6[StoredU64] = MetricPattern6( + client, "block_size_pct90" + ) + self.sum: MetricPattern2[StoredU64] = MetricPattern2(client, "block_size_sum") + class MetricsTree_Blocks_Time: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.date: MetricPattern11[Date] = MetricPattern11(client, 'date') - self.timestamp: MetricPattern1[Timestamp] = MetricPattern1(client, 'timestamp') - self.timestamp_monotonic: MetricPattern11[Timestamp] = MetricPattern11(client, 'timestamp_monotonic') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.date: MetricPattern11[Date] = MetricPattern11(client, "date") + self.timestamp: MetricPattern1[Timestamp] = MetricPattern1(client, "timestamp") + self.timestamp_monotonic: MetricPattern11[Timestamp] = MetricPattern11( + client, "timestamp_monotonic" + ) + class MetricsTree_Blocks: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.blockhash: MetricPattern11[BlockHash] = MetricPattern11(client, 'blockhash') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.blockhash: MetricPattern11[BlockHash] = MetricPattern11( + client, "blockhash" + ) self.count: MetricsTree_Blocks_Count = MetricsTree_Blocks_Count(client) - self.difficulty: MetricsTree_Blocks_Difficulty = MetricsTree_Blocks_Difficulty(client) - self.fullness: FullnessPattern[StoredF32] = FullnessPattern(client, 'block_fullness') + self.difficulty: MetricsTree_Blocks_Difficulty = MetricsTree_Blocks_Difficulty( + client + ) + self.fullness: FullnessPattern[StoredF32] = FullnessPattern( + client, "block_fullness" + ) self.halving: MetricsTree_Blocks_Halving = MetricsTree_Blocks_Halving(client) - self.interval: FullnessPattern[Timestamp] = FullnessPattern(client, 'block_interval') + self.interval: FullnessPattern[Timestamp] = FullnessPattern( + client, "block_interval" + ) self.mining: MetricsTree_Blocks_Mining = MetricsTree_Blocks_Mining(client) self.rewards: MetricsTree_Blocks_Rewards = MetricsTree_Blocks_Rewards(client) self.size: MetricsTree_Blocks_Size = MetricsTree_Blocks_Size(client) self.time: MetricsTree_Blocks_Time = MetricsTree_Blocks_Time(client) - self.total_size: MetricPattern11[StoredU64] = MetricPattern11(client, 'total_size') - self.vbytes: DollarsPattern[StoredU64] = DollarsPattern(client, 'block_vbytes') - self.weight: DollarsPattern[Weight] = DollarsPattern(client, 'block_weight') + self.total_size: MetricPattern11[StoredU64] = MetricPattern11( + client, "total_size" + ) + self.vbytes: DollarsPattern[StoredU64] = DollarsPattern(client, "block_vbytes") + self.weight: DollarsPattern[Weight] = DollarsPattern(client, "block_weight") + class MetricsTree_Cointime_Activity: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.activity_to_vaultedness_ratio: MetricPattern1[StoredF64] = MetricPattern1(client, 'activity_to_vaultedness_ratio') - self.coinblocks_created: BlockCountPattern[StoredF64] = BlockCountPattern(client, 'coinblocks_created') - self.coinblocks_stored: BlockCountPattern[StoredF64] = BlockCountPattern(client, 'coinblocks_stored') - self.liveliness: MetricPattern1[StoredF64] = MetricPattern1(client, 'liveliness') - self.vaultedness: MetricPattern1[StoredF64] = MetricPattern1(client, 'vaultedness') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.activity_to_vaultedness_ratio: MetricPattern1[StoredF64] = MetricPattern1( + client, "activity_to_vaultedness_ratio" + ) + self.coinblocks_created: BlockCountPattern[StoredF64] = BlockCountPattern( + client, "coinblocks_created" + ) + self.coinblocks_stored: BlockCountPattern[StoredF64] = BlockCountPattern( + client, "coinblocks_stored" + ) + self.liveliness: MetricPattern1[StoredF64] = MetricPattern1( + client, "liveliness" + ) + self.vaultedness: MetricPattern1[StoredF64] = MetricPattern1( + client, "vaultedness" + ) + class MetricsTree_Cointime_Adjusted: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.cointime_adj_inflation_rate: MetricPattern4[StoredF32] = MetricPattern4(client, 'cointime_adj_inflation_rate') - self.cointime_adj_tx_btc_velocity: MetricPattern4[StoredF64] = MetricPattern4(client, 'cointime_adj_tx_btc_velocity') - self.cointime_adj_tx_usd_velocity: MetricPattern4[StoredF64] = MetricPattern4(client, 'cointime_adj_tx_usd_velocity') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.cointime_adj_inflation_rate: MetricPattern4[StoredF32] = MetricPattern4( + client, "cointime_adj_inflation_rate" + ) + self.cointime_adj_tx_btc_velocity: MetricPattern4[StoredF64] = MetricPattern4( + client, "cointime_adj_tx_btc_velocity" + ) + self.cointime_adj_tx_usd_velocity: MetricPattern4[StoredF64] = MetricPattern4( + client, "cointime_adj_tx_usd_velocity" + ) + class MetricsTree_Cointime_Cap: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.active_cap: MetricPattern1[Dollars] = MetricPattern1(client, 'active_cap') - self.cointime_cap: MetricPattern1[Dollars] = MetricPattern1(client, 'cointime_cap') - self.investor_cap: MetricPattern1[Dollars] = MetricPattern1(client, 'investor_cap') - self.thermo_cap: MetricPattern1[Dollars] = MetricPattern1(client, 'thermo_cap') - self.vaulted_cap: MetricPattern1[Dollars] = MetricPattern1(client, 'vaulted_cap') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.active_cap: MetricPattern1[Dollars] = MetricPattern1(client, "active_cap") + self.cointime_cap: MetricPattern1[Dollars] = MetricPattern1( + client, "cointime_cap" + ) + self.investor_cap: MetricPattern1[Dollars] = MetricPattern1( + client, "investor_cap" + ) + self.thermo_cap: MetricPattern1[Dollars] = MetricPattern1(client, "thermo_cap") + self.vaulted_cap: MetricPattern1[Dollars] = MetricPattern1( + client, "vaulted_cap" + ) + class MetricsTree_Cointime_Pricing: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.active_price: MetricPattern1[Dollars] = MetricPattern1(client, 'active_price') - self.active_price_ratio: ActivePriceRatioPattern = ActivePriceRatioPattern(client, 'active_price_ratio') - self.cointime_price: MetricPattern1[Dollars] = MetricPattern1(client, 'cointime_price') - self.cointime_price_ratio: ActivePriceRatioPattern = ActivePriceRatioPattern(client, 'cointime_price_ratio') - self.true_market_mean: MetricPattern1[Dollars] = MetricPattern1(client, 'true_market_mean') - self.true_market_mean_ratio: ActivePriceRatioPattern = ActivePriceRatioPattern(client, 'true_market_mean_ratio') - self.vaulted_price: MetricPattern1[Dollars] = MetricPattern1(client, 'vaulted_price') - self.vaulted_price_ratio: ActivePriceRatioPattern = ActivePriceRatioPattern(client, 'vaulted_price_ratio') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.active_price: MetricPattern1[Dollars] = MetricPattern1( + client, "active_price" + ) + self.active_price_ratio: ActivePriceRatioPattern = ActivePriceRatioPattern( + client, "active_price_ratio" + ) + self.cointime_price: MetricPattern1[Dollars] = MetricPattern1( + client, "cointime_price" + ) + self.cointime_price_ratio: ActivePriceRatioPattern = ActivePriceRatioPattern( + client, "cointime_price_ratio" + ) + self.true_market_mean: MetricPattern1[Dollars] = MetricPattern1( + client, "true_market_mean" + ) + self.true_market_mean_ratio: ActivePriceRatioPattern = ActivePriceRatioPattern( + client, "true_market_mean_ratio" + ) + self.vaulted_price: MetricPattern1[Dollars] = MetricPattern1( + client, "vaulted_price" + ) + self.vaulted_price_ratio: ActivePriceRatioPattern = ActivePriceRatioPattern( + client, "vaulted_price_ratio" + ) + class MetricsTree_Cointime_Supply: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.active_supply: ActiveSupplyPattern = ActiveSupplyPattern(client, 'active_supply') - self.vaulted_supply: ActiveSupplyPattern = ActiveSupplyPattern(client, 'vaulted_supply') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.active_supply: ActiveSupplyPattern = ActiveSupplyPattern( + client, "active_supply" + ) + self.vaulted_supply: ActiveSupplyPattern = ActiveSupplyPattern( + client, "vaulted_supply" + ) + class MetricsTree_Cointime_Value: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.cointime_value_created: BlockCountPattern[StoredF64] = BlockCountPattern(client, 'cointime_value_created') - self.cointime_value_destroyed: BlockCountPattern[StoredF64] = BlockCountPattern(client, 'cointime_value_destroyed') - self.cointime_value_stored: BlockCountPattern[StoredF64] = BlockCountPattern(client, 'cointime_value_stored') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.cointime_value_created: BlockCountPattern[StoredF64] = BlockCountPattern( + client, "cointime_value_created" + ) + self.cointime_value_destroyed: BlockCountPattern[StoredF64] = BlockCountPattern( + client, "cointime_value_destroyed" + ) + self.cointime_value_stored: BlockCountPattern[StoredF64] = BlockCountPattern( + client, "cointime_value_stored" + ) + class MetricsTree_Cointime: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.activity: MetricsTree_Cointime_Activity = MetricsTree_Cointime_Activity(client) - self.adjusted: MetricsTree_Cointime_Adjusted = MetricsTree_Cointime_Adjusted(client) + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.activity: MetricsTree_Cointime_Activity = MetricsTree_Cointime_Activity( + client + ) + self.adjusted: MetricsTree_Cointime_Adjusted = MetricsTree_Cointime_Adjusted( + client + ) self.cap: MetricsTree_Cointime_Cap = MetricsTree_Cointime_Cap(client) - self.pricing: MetricsTree_Cointime_Pricing = MetricsTree_Cointime_Pricing(client) + self.pricing: MetricsTree_Cointime_Pricing = MetricsTree_Cointime_Pricing( + client + ) self.supply: MetricsTree_Cointime_Supply = MetricsTree_Cointime_Supply(client) self.value: MetricsTree_Cointime_Value = MetricsTree_Cointime_Value(client) + class MetricsTree_Constants: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.constant_0: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_0') - self.constant_1: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_1') - self.constant_100: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_100') - self.constant_2: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_2') - self.constant_20: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_20') - self.constant_3: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_3') - self.constant_30: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_30') - self.constant_38_2: MetricPattern1[StoredF32] = MetricPattern1(client, 'constant_38_2') - self.constant_4: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_4') - self.constant_50: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_50') - self.constant_600: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_600') - self.constant_61_8: MetricPattern1[StoredF32] = MetricPattern1(client, 'constant_61_8') - self.constant_70: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_70') - self.constant_80: MetricPattern1[StoredU16] = MetricPattern1(client, 'constant_80') - self.constant_minus_1: MetricPattern1[StoredI16] = MetricPattern1(client, 'constant_minus_1') - self.constant_minus_2: MetricPattern1[StoredI16] = MetricPattern1(client, 'constant_minus_2') - self.constant_minus_3: MetricPattern1[StoredI16] = MetricPattern1(client, 'constant_minus_3') - self.constant_minus_4: MetricPattern1[StoredI16] = MetricPattern1(client, 'constant_minus_4') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.constant_0: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_0" + ) + self.constant_1: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_1" + ) + self.constant_100: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_100" + ) + self.constant_2: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_2" + ) + self.constant_20: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_20" + ) + self.constant_3: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_3" + ) + self.constant_30: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_30" + ) + self.constant_38_2: MetricPattern1[StoredF32] = MetricPattern1( + client, "constant_38_2" + ) + self.constant_4: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_4" + ) + self.constant_50: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_50" + ) + self.constant_600: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_600" + ) + self.constant_61_8: MetricPattern1[StoredF32] = MetricPattern1( + client, "constant_61_8" + ) + self.constant_70: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_70" + ) + self.constant_80: MetricPattern1[StoredU16] = MetricPattern1( + client, "constant_80" + ) + self.constant_minus_1: MetricPattern1[StoredI16] = MetricPattern1( + client, "constant_minus_1" + ) + self.constant_minus_2: MetricPattern1[StoredI16] = MetricPattern1( + client, "constant_minus_2" + ) + self.constant_minus_3: MetricPattern1[StoredI16] = MetricPattern1( + client, "constant_minus_3" + ) + self.constant_minus_4: MetricPattern1[StoredI16] = MetricPattern1( + client, "constant_minus_4" + ) + class MetricsTree_Distribution_AddressCohorts_AmountRange: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._0sats: _0satsPattern = _0satsPattern(client, 'addrs_with_0sats') - self._100btc_to_1k_btc: _0satsPattern = _0satsPattern(client, 'addrs_above_100btc_under_1k_btc') - self._100k_btc_or_more: _0satsPattern = _0satsPattern(client, 'addrs_above_100k_btc') - self._100k_sats_to_1m_sats: _0satsPattern = _0satsPattern(client, 'addrs_above_100k_sats_under_1m_sats') - self._100sats_to_1k_sats: _0satsPattern = _0satsPattern(client, 'addrs_above_100sats_under_1k_sats') - self._10btc_to_100btc: _0satsPattern = _0satsPattern(client, 'addrs_above_10btc_under_100btc') - self._10k_btc_to_100k_btc: _0satsPattern = _0satsPattern(client, 'addrs_above_10k_btc_under_100k_btc') - self._10k_sats_to_100k_sats: _0satsPattern = _0satsPattern(client, 'addrs_above_10k_sats_under_100k_sats') - self._10m_sats_to_1btc: _0satsPattern = _0satsPattern(client, 'addrs_above_10m_sats_under_1btc') - self._10sats_to_100sats: _0satsPattern = _0satsPattern(client, 'addrs_above_10sats_under_100sats') - self._1btc_to_10btc: _0satsPattern = _0satsPattern(client, 'addrs_above_1btc_under_10btc') - self._1k_btc_to_10k_btc: _0satsPattern = _0satsPattern(client, 'addrs_above_1k_btc_under_10k_btc') - self._1k_sats_to_10k_sats: _0satsPattern = _0satsPattern(client, 'addrs_above_1k_sats_under_10k_sats') - self._1m_sats_to_10m_sats: _0satsPattern = _0satsPattern(client, 'addrs_above_1m_sats_under_10m_sats') - self._1sat_to_10sats: _0satsPattern = _0satsPattern(client, 'addrs_above_1sat_under_10sats') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._0sats: _0satsPattern = _0satsPattern(client, "addrs_with_0sats") + self._100btc_to_1k_btc: _0satsPattern = _0satsPattern( + client, "addrs_above_100btc_under_1k_btc" + ) + self._100k_btc_or_more: _0satsPattern = _0satsPattern( + client, "addrs_above_100k_btc" + ) + self._100k_sats_to_1m_sats: _0satsPattern = _0satsPattern( + client, "addrs_above_100k_sats_under_1m_sats" + ) + self._100sats_to_1k_sats: _0satsPattern = _0satsPattern( + client, "addrs_above_100sats_under_1k_sats" + ) + self._10btc_to_100btc: _0satsPattern = _0satsPattern( + client, "addrs_above_10btc_under_100btc" + ) + self._10k_btc_to_100k_btc: _0satsPattern = _0satsPattern( + client, "addrs_above_10k_btc_under_100k_btc" + ) + self._10k_sats_to_100k_sats: _0satsPattern = _0satsPattern( + client, "addrs_above_10k_sats_under_100k_sats" + ) + self._10m_sats_to_1btc: _0satsPattern = _0satsPattern( + client, "addrs_above_10m_sats_under_1btc" + ) + self._10sats_to_100sats: _0satsPattern = _0satsPattern( + client, "addrs_above_10sats_under_100sats" + ) + self._1btc_to_10btc: _0satsPattern = _0satsPattern( + client, "addrs_above_1btc_under_10btc" + ) + self._1k_btc_to_10k_btc: _0satsPattern = _0satsPattern( + client, "addrs_above_1k_btc_under_10k_btc" + ) + self._1k_sats_to_10k_sats: _0satsPattern = _0satsPattern( + client, "addrs_above_1k_sats_under_10k_sats" + ) + self._1m_sats_to_10m_sats: _0satsPattern = _0satsPattern( + client, "addrs_above_1m_sats_under_10m_sats" + ) + self._1sat_to_10sats: _0satsPattern = _0satsPattern( + client, "addrs_above_1sat_under_10sats" + ) + class MetricsTree_Distribution_AddressCohorts_GeAmount: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._100btc: _0satsPattern = _0satsPattern(client, 'addrs_above_100btc') - self._100k_sats: _0satsPattern = _0satsPattern(client, 'addrs_above_100k_sats') - self._100sats: _0satsPattern = _0satsPattern(client, 'addrs_above_100sats') - self._10btc: _0satsPattern = _0satsPattern(client, 'addrs_above_10btc') - self._10k_btc: _0satsPattern = _0satsPattern(client, 'addrs_above_10k_btc') - self._10k_sats: _0satsPattern = _0satsPattern(client, 'addrs_above_10k_sats') - self._10m_sats: _0satsPattern = _0satsPattern(client, 'addrs_above_10m_sats') - self._10sats: _0satsPattern = _0satsPattern(client, 'addrs_above_10sats') - self._1btc: _0satsPattern = _0satsPattern(client, 'addrs_above_1btc') - self._1k_btc: _0satsPattern = _0satsPattern(client, 'addrs_above_1k_btc') - self._1k_sats: _0satsPattern = _0satsPattern(client, 'addrs_above_1k_sats') - self._1m_sats: _0satsPattern = _0satsPattern(client, 'addrs_above_1m_sats') - self._1sat: _0satsPattern = _0satsPattern(client, 'addrs_above_1sat') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._100btc: _0satsPattern = _0satsPattern(client, "addrs_above_100btc") + self._100k_sats: _0satsPattern = _0satsPattern(client, "addrs_above_100k_sats") + self._100sats: _0satsPattern = _0satsPattern(client, "addrs_above_100sats") + self._10btc: _0satsPattern = _0satsPattern(client, "addrs_above_10btc") + self._10k_btc: _0satsPattern = _0satsPattern(client, "addrs_above_10k_btc") + self._10k_sats: _0satsPattern = _0satsPattern(client, "addrs_above_10k_sats") + self._10m_sats: _0satsPattern = _0satsPattern(client, "addrs_above_10m_sats") + self._10sats: _0satsPattern = _0satsPattern(client, "addrs_above_10sats") + self._1btc: _0satsPattern = _0satsPattern(client, "addrs_above_1btc") + self._1k_btc: _0satsPattern = _0satsPattern(client, "addrs_above_1k_btc") + self._1k_sats: _0satsPattern = _0satsPattern(client, "addrs_above_1k_sats") + self._1m_sats: _0satsPattern = _0satsPattern(client, "addrs_above_1m_sats") + self._1sat: _0satsPattern = _0satsPattern(client, "addrs_above_1sat") + class MetricsTree_Distribution_AddressCohorts_LtAmount: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._100btc: _0satsPattern = _0satsPattern(client, 'addrs_under_100btc') - self._100k_btc: _0satsPattern = _0satsPattern(client, 'addrs_under_100k_btc') - self._100k_sats: _0satsPattern = _0satsPattern(client, 'addrs_under_100k_sats') - self._100sats: _0satsPattern = _0satsPattern(client, 'addrs_under_100sats') - self._10btc: _0satsPattern = _0satsPattern(client, 'addrs_under_10btc') - self._10k_btc: _0satsPattern = _0satsPattern(client, 'addrs_under_10k_btc') - self._10k_sats: _0satsPattern = _0satsPattern(client, 'addrs_under_10k_sats') - self._10m_sats: _0satsPattern = _0satsPattern(client, 'addrs_under_10m_sats') - self._10sats: _0satsPattern = _0satsPattern(client, 'addrs_under_10sats') - self._1btc: _0satsPattern = _0satsPattern(client, 'addrs_under_1btc') - self._1k_btc: _0satsPattern = _0satsPattern(client, 'addrs_under_1k_btc') - self._1k_sats: _0satsPattern = _0satsPattern(client, 'addrs_under_1k_sats') - self._1m_sats: _0satsPattern = _0satsPattern(client, 'addrs_under_1m_sats') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._100btc: _0satsPattern = _0satsPattern(client, "addrs_under_100btc") + self._100k_btc: _0satsPattern = _0satsPattern(client, "addrs_under_100k_btc") + self._100k_sats: _0satsPattern = _0satsPattern(client, "addrs_under_100k_sats") + self._100sats: _0satsPattern = _0satsPattern(client, "addrs_under_100sats") + self._10btc: _0satsPattern = _0satsPattern(client, "addrs_under_10btc") + self._10k_btc: _0satsPattern = _0satsPattern(client, "addrs_under_10k_btc") + self._10k_sats: _0satsPattern = _0satsPattern(client, "addrs_under_10k_sats") + self._10m_sats: _0satsPattern = _0satsPattern(client, "addrs_under_10m_sats") + self._10sats: _0satsPattern = _0satsPattern(client, "addrs_under_10sats") + self._1btc: _0satsPattern = _0satsPattern(client, "addrs_under_1btc") + self._1k_btc: _0satsPattern = _0satsPattern(client, "addrs_under_1k_btc") + self._1k_sats: _0satsPattern = _0satsPattern(client, "addrs_under_1k_sats") + self._1m_sats: _0satsPattern = _0satsPattern(client, "addrs_under_1m_sats") + class MetricsTree_Distribution_AddressCohorts: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.amount_range: MetricsTree_Distribution_AddressCohorts_AmountRange = MetricsTree_Distribution_AddressCohorts_AmountRange(client) - self.ge_amount: MetricsTree_Distribution_AddressCohorts_GeAmount = MetricsTree_Distribution_AddressCohorts_GeAmount(client) - self.lt_amount: MetricsTree_Distribution_AddressCohorts_LtAmount = MetricsTree_Distribution_AddressCohorts_LtAmount(client) + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.amount_range: MetricsTree_Distribution_AddressCohorts_AmountRange = ( + MetricsTree_Distribution_AddressCohorts_AmountRange(client) + ) + self.ge_amount: MetricsTree_Distribution_AddressCohorts_GeAmount = ( + MetricsTree_Distribution_AddressCohorts_GeAmount(client) + ) + self.lt_amount: MetricsTree_Distribution_AddressCohorts_LtAmount = ( + MetricsTree_Distribution_AddressCohorts_LtAmount(client) + ) + class MetricsTree_Distribution_AddressesData: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.empty: MetricPattern32[EmptyAddressData] = MetricPattern32(client, 'emptyaddressdata') - self.loaded: MetricPattern31[LoadedAddressData] = MetricPattern31(client, 'loadedaddressdata') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.empty: MetricPattern32[EmptyAddressData] = MetricPattern32( + client, "emptyaddressdata" + ) + self.loaded: MetricPattern31[LoadedAddressData] = MetricPattern31( + client, "loadedaddressdata" + ) + class MetricsTree_Distribution_AnyAddressIndexes: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.p2a: MetricPattern16[AnyAddressIndex] = MetricPattern16(client, 'anyaddressindex') - self.p2pk33: MetricPattern18[AnyAddressIndex] = MetricPattern18(client, 'anyaddressindex') - self.p2pk65: MetricPattern19[AnyAddressIndex] = MetricPattern19(client, 'anyaddressindex') - self.p2pkh: MetricPattern20[AnyAddressIndex] = MetricPattern20(client, 'anyaddressindex') - self.p2sh: MetricPattern21[AnyAddressIndex] = MetricPattern21(client, 'anyaddressindex') - self.p2tr: MetricPattern22[AnyAddressIndex] = MetricPattern22(client, 'anyaddressindex') - self.p2wpkh: MetricPattern23[AnyAddressIndex] = MetricPattern23(client, 'anyaddressindex') - self.p2wsh: MetricPattern24[AnyAddressIndex] = MetricPattern24(client, 'anyaddressindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.p2a: MetricPattern16[AnyAddressIndex] = MetricPattern16( + client, "anyaddressindex" + ) + self.p2pk33: MetricPattern18[AnyAddressIndex] = MetricPattern18( + client, "anyaddressindex" + ) + self.p2pk65: MetricPattern19[AnyAddressIndex] = MetricPattern19( + client, "anyaddressindex" + ) + self.p2pkh: MetricPattern20[AnyAddressIndex] = MetricPattern20( + client, "anyaddressindex" + ) + self.p2sh: MetricPattern21[AnyAddressIndex] = MetricPattern21( + client, "anyaddressindex" + ) + self.p2tr: MetricPattern22[AnyAddressIndex] = MetricPattern22( + client, "anyaddressindex" + ) + self.p2wpkh: MetricPattern23[AnyAddressIndex] = MetricPattern23( + client, "anyaddressindex" + ) + self.p2wsh: MetricPattern24[AnyAddressIndex] = MetricPattern24( + client, "anyaddressindex" + ) + class MetricsTree_Distribution_UtxoCohorts_AgeRange: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._10y_to_12y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_10y_up_to_12y_old') - self._12y_to_15y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_12y_up_to_15y_old') - self._1d_to_1w: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_1d_up_to_1w_old') - self._1h_to_1d: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_1h_up_to_1d_old') - self._1m_to_2m: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_1m_up_to_2m_old') - self._1w_to_1m: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_1w_up_to_1m_old') - self._1y_to_2y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_1y_up_to_2y_old') - self._2m_to_3m: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_2m_up_to_3m_old') - self._2y_to_3y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_2y_up_to_3y_old') - self._3m_to_4m: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_3m_up_to_4m_old') - self._3y_to_4y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_3y_up_to_4y_old') - self._4m_to_5m: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_4m_up_to_5m_old') - self._4y_to_5y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_4y_up_to_5y_old') - self._5m_to_6m: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_5m_up_to_6m_old') - self._5y_to_6y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_5y_up_to_6y_old') - self._6m_to_1y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_6m_up_to_1y_old') - self._6y_to_7y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_6y_up_to_7y_old') - self._7y_to_8y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_7y_up_to_8y_old') - self._8y_to_10y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_8y_up_to_10y_old') - self.from_15y: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_at_least_15y_old') - self.up_to_1h: _10yTo12yPattern = _10yTo12yPattern(client, 'utxos_up_to_1h_old') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._10y_to_12y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_10y_up_to_12y_old" + ) + self._12y_to_15y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_12y_up_to_15y_old" + ) + self._1d_to_1w: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_1d_up_to_1w_old" + ) + self._1h_to_1d: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_1h_up_to_1d_old" + ) + self._1m_to_2m: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_1m_up_to_2m_old" + ) + self._1w_to_1m: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_1w_up_to_1m_old" + ) + self._1y_to_2y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_1y_up_to_2y_old" + ) + self._2m_to_3m: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_2m_up_to_3m_old" + ) + self._2y_to_3y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_2y_up_to_3y_old" + ) + self._3m_to_4m: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_3m_up_to_4m_old" + ) + self._3y_to_4y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_3y_up_to_4y_old" + ) + self._4m_to_5m: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_4m_up_to_5m_old" + ) + self._4y_to_5y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_4y_up_to_5y_old" + ) + self._5m_to_6m: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_5m_up_to_6m_old" + ) + self._5y_to_6y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_5y_up_to_6y_old" + ) + self._6m_to_1y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_6m_up_to_1y_old" + ) + self._6y_to_7y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_6y_up_to_7y_old" + ) + self._7y_to_8y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_7y_up_to_8y_old" + ) + self._8y_to_10y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_8y_up_to_10y_old" + ) + self.from_15y: _10yTo12yPattern = _10yTo12yPattern( + client, "utxos_at_least_15y_old" + ) + self.up_to_1h: _10yTo12yPattern = _10yTo12yPattern(client, "utxos_up_to_1h_old") + class MetricsTree_Distribution_UtxoCohorts_All_CostBasis: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.max: MetricPattern1[Dollars] = MetricPattern1(client, 'max_cost_basis') - self.min: MetricPattern1[Dollars] = MetricPattern1(client, 'min_cost_basis') - self.percentiles: PercentilesPattern = PercentilesPattern(client, 'cost_basis') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.max: MetricPattern1[Dollars] = MetricPattern1(client, "max_cost_basis") + self.min: MetricPattern1[Dollars] = MetricPattern1(client, "min_cost_basis") + self.percentiles: PercentilesPattern = PercentilesPattern(client, "cost_basis") + class MetricsTree_Distribution_UtxoCohorts_All_Relative: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.neg_unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, 'neg_unrealized_loss_rel_to_own_total_unrealized_pnl') - self.net_unrealized_pnl_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, 'net_unrealized_pnl_rel_to_own_total_unrealized_pnl') - self.supply_in_loss_rel_to_own_supply: MetricPattern1[StoredF64] = MetricPattern1(client, 'supply_in_loss_rel_to_own_supply') - self.supply_in_profit_rel_to_own_supply: MetricPattern1[StoredF64] = MetricPattern1(client, 'supply_in_profit_rel_to_own_supply') - self.unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, 'unrealized_loss_rel_to_own_total_unrealized_pnl') - self.unrealized_profit_rel_to_own_total_unrealized_pnl: MetricPattern1[StoredF32] = MetricPattern1(client, 'unrealized_profit_rel_to_own_total_unrealized_pnl') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.neg_unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1( + client, "neg_unrealized_loss_rel_to_own_total_unrealized_pnl" + ) + self.net_unrealized_pnl_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1(client, "net_unrealized_pnl_rel_to_own_total_unrealized_pnl") + self.supply_in_loss_rel_to_own_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, "supply_in_loss_rel_to_own_supply") + ) + self.supply_in_profit_rel_to_own_supply: MetricPattern1[StoredF64] = ( + MetricPattern1(client, "supply_in_profit_rel_to_own_supply") + ) + self.unrealized_loss_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1(client, "unrealized_loss_rel_to_own_total_unrealized_pnl") + self.unrealized_profit_rel_to_own_total_unrealized_pnl: MetricPattern1[ + StoredF32 + ] = MetricPattern1(client, "unrealized_profit_rel_to_own_total_unrealized_pnl") + class MetricsTree_Distribution_UtxoCohorts_All: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.activity: ActivityPattern2 = ActivityPattern2(client, '') - self.cost_basis: MetricsTree_Distribution_UtxoCohorts_All_CostBasis = MetricsTree_Distribution_UtxoCohorts_All_CostBasis(client) - self.outputs: OutputsPattern = OutputsPattern(client, 'utxo_count') - self.realized: RealizedPattern3 = RealizedPattern3(client, '') - self.relative: MetricsTree_Distribution_UtxoCohorts_All_Relative = MetricsTree_Distribution_UtxoCohorts_All_Relative(client) - self.supply: SupplyPattern2 = SupplyPattern2(client, 'supply') - self.unrealized: UnrealizedPattern = UnrealizedPattern(client, '') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.activity: ActivityPattern2 = ActivityPattern2(client, "") + self.cost_basis: MetricsTree_Distribution_UtxoCohorts_All_CostBasis = ( + MetricsTree_Distribution_UtxoCohorts_All_CostBasis(client) + ) + self.outputs: OutputsPattern = OutputsPattern(client, "utxo_count") + self.realized: RealizedPattern3 = RealizedPattern3(client, "") + self.relative: MetricsTree_Distribution_UtxoCohorts_All_Relative = ( + MetricsTree_Distribution_UtxoCohorts_All_Relative(client) + ) + self.supply: SupplyPattern2 = SupplyPattern2(client, "supply") + self.unrealized: UnrealizedPattern = UnrealizedPattern(client, "") + class MetricsTree_Distribution_UtxoCohorts_AmountRange: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._0sats: _0satsPattern2 = _0satsPattern2(client, 'utxos_with_0sats') - self._100btc_to_1k_btc: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_100btc_under_1k_btc') - self._100k_btc_or_more: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_100k_btc') - self._100k_sats_to_1m_sats: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_100k_sats_under_1m_sats') - self._100sats_to_1k_sats: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_100sats_under_1k_sats') - self._10btc_to_100btc: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_10btc_under_100btc') - self._10k_btc_to_100k_btc: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_10k_btc_under_100k_btc') - self._10k_sats_to_100k_sats: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_10k_sats_under_100k_sats') - self._10m_sats_to_1btc: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_10m_sats_under_1btc') - self._10sats_to_100sats: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_10sats_under_100sats') - self._1btc_to_10btc: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_1btc_under_10btc') - self._1k_btc_to_10k_btc: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_1k_btc_under_10k_btc') - self._1k_sats_to_10k_sats: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_1k_sats_under_10k_sats') - self._1m_sats_to_10m_sats: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_1m_sats_under_10m_sats') - self._1sat_to_10sats: _0satsPattern2 = _0satsPattern2(client, 'utxos_above_1sat_under_10sats') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._0sats: _0satsPattern2 = _0satsPattern2(client, "utxos_with_0sats") + self._100btc_to_1k_btc: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_100btc_under_1k_btc" + ) + self._100k_btc_or_more: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_100k_btc" + ) + self._100k_sats_to_1m_sats: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_100k_sats_under_1m_sats" + ) + self._100sats_to_1k_sats: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_100sats_under_1k_sats" + ) + self._10btc_to_100btc: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_10btc_under_100btc" + ) + self._10k_btc_to_100k_btc: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_10k_btc_under_100k_btc" + ) + self._10k_sats_to_100k_sats: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_10k_sats_under_100k_sats" + ) + self._10m_sats_to_1btc: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_10m_sats_under_1btc" + ) + self._10sats_to_100sats: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_10sats_under_100sats" + ) + self._1btc_to_10btc: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_1btc_under_10btc" + ) + self._1k_btc_to_10k_btc: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_1k_btc_under_10k_btc" + ) + self._1k_sats_to_10k_sats: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_1k_sats_under_10k_sats" + ) + self._1m_sats_to_10m_sats: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_1m_sats_under_10m_sats" + ) + self._1sat_to_10sats: _0satsPattern2 = _0satsPattern2( + client, "utxos_above_1sat_under_10sats" + ) + class MetricsTree_Distribution_UtxoCohorts_Epoch: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._0: _0satsPattern2 = _0satsPattern2(client, 'epoch_0') - self._1: _0satsPattern2 = _0satsPattern2(client, 'epoch_1') - self._2: _0satsPattern2 = _0satsPattern2(client, 'epoch_2') - self._3: _0satsPattern2 = _0satsPattern2(client, 'epoch_3') - self._4: _0satsPattern2 = _0satsPattern2(client, 'epoch_4') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._0: _0satsPattern2 = _0satsPattern2(client, "epoch_0") + self._1: _0satsPattern2 = _0satsPattern2(client, "epoch_1") + self._2: _0satsPattern2 = _0satsPattern2(client, "epoch_2") + self._3: _0satsPattern2 = _0satsPattern2(client, "epoch_3") + self._4: _0satsPattern2 = _0satsPattern2(client, "epoch_4") + class MetricsTree_Distribution_UtxoCohorts_GeAmount: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._100btc: _100btcPattern = _100btcPattern(client, 'utxos_above_100btc') - self._100k_sats: _100btcPattern = _100btcPattern(client, 'utxos_above_100k_sats') - self._100sats: _100btcPattern = _100btcPattern(client, 'utxos_above_100sats') - self._10btc: _100btcPattern = _100btcPattern(client, 'utxos_above_10btc') - self._10k_btc: _100btcPattern = _100btcPattern(client, 'utxos_above_10k_btc') - self._10k_sats: _100btcPattern = _100btcPattern(client, 'utxos_above_10k_sats') - self._10m_sats: _100btcPattern = _100btcPattern(client, 'utxos_above_10m_sats') - self._10sats: _100btcPattern = _100btcPattern(client, 'utxos_above_10sats') - self._1btc: _100btcPattern = _100btcPattern(client, 'utxos_above_1btc') - self._1k_btc: _100btcPattern = _100btcPattern(client, 'utxos_above_1k_btc') - self._1k_sats: _100btcPattern = _100btcPattern(client, 'utxos_above_1k_sats') - self._1m_sats: _100btcPattern = _100btcPattern(client, 'utxos_above_1m_sats') - self._1sat: _100btcPattern = _100btcPattern(client, 'utxos_above_1sat') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._100btc: _100btcPattern = _100btcPattern(client, "utxos_above_100btc") + self._100k_sats: _100btcPattern = _100btcPattern( + client, "utxos_above_100k_sats" + ) + self._100sats: _100btcPattern = _100btcPattern(client, "utxos_above_100sats") + self._10btc: _100btcPattern = _100btcPattern(client, "utxos_above_10btc") + self._10k_btc: _100btcPattern = _100btcPattern(client, "utxos_above_10k_btc") + self._10k_sats: _100btcPattern = _100btcPattern(client, "utxos_above_10k_sats") + self._10m_sats: _100btcPattern = _100btcPattern(client, "utxos_above_10m_sats") + self._10sats: _100btcPattern = _100btcPattern(client, "utxos_above_10sats") + self._1btc: _100btcPattern = _100btcPattern(client, "utxos_above_1btc") + self._1k_btc: _100btcPattern = _100btcPattern(client, "utxos_above_1k_btc") + self._1k_sats: _100btcPattern = _100btcPattern(client, "utxos_above_1k_sats") + self._1m_sats: _100btcPattern = _100btcPattern(client, "utxos_above_1m_sats") + self._1sat: _100btcPattern = _100btcPattern(client, "utxos_above_1sat") + class MetricsTree_Distribution_UtxoCohorts_LtAmount: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._100btc: _100btcPattern = _100btcPattern(client, 'utxos_under_100btc') - self._100k_btc: _100btcPattern = _100btcPattern(client, 'utxos_under_100k_btc') - self._100k_sats: _100btcPattern = _100btcPattern(client, 'utxos_under_100k_sats') - self._100sats: _100btcPattern = _100btcPattern(client, 'utxos_under_100sats') - self._10btc: _100btcPattern = _100btcPattern(client, 'utxos_under_10btc') - self._10k_btc: _100btcPattern = _100btcPattern(client, 'utxos_under_10k_btc') - self._10k_sats: _100btcPattern = _100btcPattern(client, 'utxos_under_10k_sats') - self._10m_sats: _100btcPattern = _100btcPattern(client, 'utxos_under_10m_sats') - self._10sats: _100btcPattern = _100btcPattern(client, 'utxos_under_10sats') - self._1btc: _100btcPattern = _100btcPattern(client, 'utxos_under_1btc') - self._1k_btc: _100btcPattern = _100btcPattern(client, 'utxos_under_1k_btc') - self._1k_sats: _100btcPattern = _100btcPattern(client, 'utxos_under_1k_sats') - self._1m_sats: _100btcPattern = _100btcPattern(client, 'utxos_under_1m_sats') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._100btc: _100btcPattern = _100btcPattern(client, "utxos_under_100btc") + self._100k_btc: _100btcPattern = _100btcPattern(client, "utxos_under_100k_btc") + self._100k_sats: _100btcPattern = _100btcPattern( + client, "utxos_under_100k_sats" + ) + self._100sats: _100btcPattern = _100btcPattern(client, "utxos_under_100sats") + self._10btc: _100btcPattern = _100btcPattern(client, "utxos_under_10btc") + self._10k_btc: _100btcPattern = _100btcPattern(client, "utxos_under_10k_btc") + self._10k_sats: _100btcPattern = _100btcPattern(client, "utxos_under_10k_sats") + self._10m_sats: _100btcPattern = _100btcPattern(client, "utxos_under_10m_sats") + self._10sats: _100btcPattern = _100btcPattern(client, "utxos_under_10sats") + self._1btc: _100btcPattern = _100btcPattern(client, "utxos_under_1btc") + self._1k_btc: _100btcPattern = _100btcPattern(client, "utxos_under_1k_btc") + self._1k_sats: _100btcPattern = _100btcPattern(client, "utxos_under_1k_sats") + self._1m_sats: _100btcPattern = _100btcPattern(client, "utxos_under_1m_sats") + class MetricsTree_Distribution_UtxoCohorts_MaxAge: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._10y: _10yPattern = _10yPattern(client, 'utxos_up_to_10y_old') - self._12y: _10yPattern = _10yPattern(client, 'utxos_up_to_12y_old') - self._15y: _10yPattern = _10yPattern(client, 'utxos_up_to_15y_old') - self._1m: _10yPattern = _10yPattern(client, 'utxos_up_to_1m_old') - self._1w: _10yPattern = _10yPattern(client, 'utxos_up_to_1w_old') - self._1y: _10yPattern = _10yPattern(client, 'utxos_up_to_1y_old') - self._2m: _10yPattern = _10yPattern(client, 'utxos_up_to_2m_old') - self._2y: _10yPattern = _10yPattern(client, 'utxos_up_to_2y_old') - self._3m: _10yPattern = _10yPattern(client, 'utxos_up_to_3m_old') - self._3y: _10yPattern = _10yPattern(client, 'utxos_up_to_3y_old') - self._4m: _10yPattern = _10yPattern(client, 'utxos_up_to_4m_old') - self._4y: _10yPattern = _10yPattern(client, 'utxos_up_to_4y_old') - self._5m: _10yPattern = _10yPattern(client, 'utxos_up_to_5m_old') - self._5y: _10yPattern = _10yPattern(client, 'utxos_up_to_5y_old') - self._6m: _10yPattern = _10yPattern(client, 'utxos_up_to_6m_old') - self._6y: _10yPattern = _10yPattern(client, 'utxos_up_to_6y_old') - self._7y: _10yPattern = _10yPattern(client, 'utxos_up_to_7y_old') - self._8y: _10yPattern = _10yPattern(client, 'utxos_up_to_8y_old') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._10y: _10yPattern = _10yPattern(client, "utxos_up_to_10y_old") + self._12y: _10yPattern = _10yPattern(client, "utxos_up_to_12y_old") + self._15y: _10yPattern = _10yPattern(client, "utxos_up_to_15y_old") + self._1m: _10yPattern = _10yPattern(client, "utxos_up_to_1m_old") + self._1w: _10yPattern = _10yPattern(client, "utxos_up_to_1w_old") + self._1y: _10yPattern = _10yPattern(client, "utxos_up_to_1y_old") + self._2m: _10yPattern = _10yPattern(client, "utxos_up_to_2m_old") + self._2y: _10yPattern = _10yPattern(client, "utxos_up_to_2y_old") + self._3m: _10yPattern = _10yPattern(client, "utxos_up_to_3m_old") + self._3y: _10yPattern = _10yPattern(client, "utxos_up_to_3y_old") + self._4m: _10yPattern = _10yPattern(client, "utxos_up_to_4m_old") + self._4y: _10yPattern = _10yPattern(client, "utxos_up_to_4y_old") + self._5m: _10yPattern = _10yPattern(client, "utxos_up_to_5m_old") + self._5y: _10yPattern = _10yPattern(client, "utxos_up_to_5y_old") + self._6m: _10yPattern = _10yPattern(client, "utxos_up_to_6m_old") + self._6y: _10yPattern = _10yPattern(client, "utxos_up_to_6y_old") + self._7y: _10yPattern = _10yPattern(client, "utxos_up_to_7y_old") + self._8y: _10yPattern = _10yPattern(client, "utxos_up_to_8y_old") + class MetricsTree_Distribution_UtxoCohorts_MinAge: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._10y: _100btcPattern = _100btcPattern(client, 'utxos_at_least_10y_old') - self._12y: _100btcPattern = _100btcPattern(client, 'utxos_at_least_12y_old') - self._1d: _100btcPattern = _100btcPattern(client, 'utxos_at_least_1d_old') - self._1m: _100btcPattern = _100btcPattern(client, 'utxos_at_least_1m_old') - self._1w: _100btcPattern = _100btcPattern(client, 'utxos_at_least_1w_old') - self._1y: _100btcPattern = _100btcPattern(client, 'utxos_at_least_1y_old') - self._2m: _100btcPattern = _100btcPattern(client, 'utxos_at_least_2m_old') - self._2y: _100btcPattern = _100btcPattern(client, 'utxos_at_least_2y_old') - self._3m: _100btcPattern = _100btcPattern(client, 'utxos_at_least_3m_old') - self._3y: _100btcPattern = _100btcPattern(client, 'utxos_at_least_3y_old') - self._4m: _100btcPattern = _100btcPattern(client, 'utxos_at_least_4m_old') - self._4y: _100btcPattern = _100btcPattern(client, 'utxos_at_least_4y_old') - self._5m: _100btcPattern = _100btcPattern(client, 'utxos_at_least_5m_old') - self._5y: _100btcPattern = _100btcPattern(client, 'utxos_at_least_5y_old') - self._6m: _100btcPattern = _100btcPattern(client, 'utxos_at_least_6m_old') - self._6y: _100btcPattern = _100btcPattern(client, 'utxos_at_least_6y_old') - self._7y: _100btcPattern = _100btcPattern(client, 'utxos_at_least_7y_old') - self._8y: _100btcPattern = _100btcPattern(client, 'utxos_at_least_8y_old') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._10y: _100btcPattern = _100btcPattern(client, "utxos_at_least_10y_old") + self._12y: _100btcPattern = _100btcPattern(client, "utxos_at_least_12y_old") + self._1d: _100btcPattern = _100btcPattern(client, "utxos_at_least_1d_old") + self._1m: _100btcPattern = _100btcPattern(client, "utxos_at_least_1m_old") + self._1w: _100btcPattern = _100btcPattern(client, "utxos_at_least_1w_old") + self._1y: _100btcPattern = _100btcPattern(client, "utxos_at_least_1y_old") + self._2m: _100btcPattern = _100btcPattern(client, "utxos_at_least_2m_old") + self._2y: _100btcPattern = _100btcPattern(client, "utxos_at_least_2y_old") + self._3m: _100btcPattern = _100btcPattern(client, "utxos_at_least_3m_old") + self._3y: _100btcPattern = _100btcPattern(client, "utxos_at_least_3y_old") + self._4m: _100btcPattern = _100btcPattern(client, "utxos_at_least_4m_old") + self._4y: _100btcPattern = _100btcPattern(client, "utxos_at_least_4y_old") + self._5m: _100btcPattern = _100btcPattern(client, "utxos_at_least_5m_old") + self._5y: _100btcPattern = _100btcPattern(client, "utxos_at_least_5y_old") + self._6m: _100btcPattern = _100btcPattern(client, "utxos_at_least_6m_old") + self._6y: _100btcPattern = _100btcPattern(client, "utxos_at_least_6y_old") + self._7y: _100btcPattern = _100btcPattern(client, "utxos_at_least_7y_old") + self._8y: _100btcPattern = _100btcPattern(client, "utxos_at_least_8y_old") + class MetricsTree_Distribution_UtxoCohorts_Term_Long: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.activity: ActivityPattern2 = ActivityPattern2(client, 'lth') - self.cost_basis: CostBasisPattern2 = CostBasisPattern2(client, 'lth') - self.outputs: OutputsPattern = OutputsPattern(client, 'lth_utxo_count') - self.realized: RealizedPattern2 = RealizedPattern2(client, 'lth') - self.relative: RelativePattern5 = RelativePattern5(client, 'lth') - self.supply: SupplyPattern2 = SupplyPattern2(client, 'lth_supply') - self.unrealized: UnrealizedPattern = UnrealizedPattern(client, 'lth') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.activity: ActivityPattern2 = ActivityPattern2(client, "lth") + self.cost_basis: CostBasisPattern2 = CostBasisPattern2(client, "lth") + self.outputs: OutputsPattern = OutputsPattern(client, "lth_utxo_count") + self.realized: RealizedPattern2 = RealizedPattern2(client, "lth") + self.relative: RelativePattern5 = RelativePattern5(client, "lth") + self.supply: SupplyPattern2 = SupplyPattern2(client, "lth_supply") + self.unrealized: UnrealizedPattern = UnrealizedPattern(client, "lth") + class MetricsTree_Distribution_UtxoCohorts_Term_Short: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.activity: ActivityPattern2 = ActivityPattern2(client, 'sth') - self.cost_basis: CostBasisPattern2 = CostBasisPattern2(client, 'sth') - self.outputs: OutputsPattern = OutputsPattern(client, 'sth_utxo_count') - self.realized: RealizedPattern3 = RealizedPattern3(client, 'sth') - self.relative: RelativePattern5 = RelativePattern5(client, 'sth') - self.supply: SupplyPattern2 = SupplyPattern2(client, 'sth_supply') - self.unrealized: UnrealizedPattern = UnrealizedPattern(client, 'sth') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.activity: ActivityPattern2 = ActivityPattern2(client, "sth") + self.cost_basis: CostBasisPattern2 = CostBasisPattern2(client, "sth") + self.outputs: OutputsPattern = OutputsPattern(client, "sth_utxo_count") + self.realized: RealizedPattern3 = RealizedPattern3(client, "sth") + self.relative: RelativePattern5 = RelativePattern5(client, "sth") + self.supply: SupplyPattern2 = SupplyPattern2(client, "sth_supply") + self.unrealized: UnrealizedPattern = UnrealizedPattern(client, "sth") + class MetricsTree_Distribution_UtxoCohorts_Term: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.long: MetricsTree_Distribution_UtxoCohorts_Term_Long = MetricsTree_Distribution_UtxoCohorts_Term_Long(client) - self.short: MetricsTree_Distribution_UtxoCohorts_Term_Short = MetricsTree_Distribution_UtxoCohorts_Term_Short(client) + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.long: MetricsTree_Distribution_UtxoCohorts_Term_Long = ( + MetricsTree_Distribution_UtxoCohorts_Term_Long(client) + ) + self.short: MetricsTree_Distribution_UtxoCohorts_Term_Short = ( + MetricsTree_Distribution_UtxoCohorts_Term_Short(client) + ) + class MetricsTree_Distribution_UtxoCohorts_Type: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.empty: _0satsPattern2 = _0satsPattern2(client, 'empty_outputs') - self.p2a: _0satsPattern2 = _0satsPattern2(client, 'p2a') - self.p2ms: _0satsPattern2 = _0satsPattern2(client, 'p2ms') - self.p2pk33: _0satsPattern2 = _0satsPattern2(client, 'p2pk33') - self.p2pk65: _0satsPattern2 = _0satsPattern2(client, 'p2pk65') - self.p2pkh: _0satsPattern2 = _0satsPattern2(client, 'p2pkh') - self.p2sh: _0satsPattern2 = _0satsPattern2(client, 'p2sh') - self.p2tr: _0satsPattern2 = _0satsPattern2(client, 'p2tr') - self.p2wpkh: _0satsPattern2 = _0satsPattern2(client, 'p2wpkh') - self.p2wsh: _0satsPattern2 = _0satsPattern2(client, 'p2wsh') - self.unknown: _0satsPattern2 = _0satsPattern2(client, 'unknown_outputs') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.empty: _0satsPattern2 = _0satsPattern2(client, "empty_outputs") + self.p2a: _0satsPattern2 = _0satsPattern2(client, "p2a") + self.p2ms: _0satsPattern2 = _0satsPattern2(client, "p2ms") + self.p2pk33: _0satsPattern2 = _0satsPattern2(client, "p2pk33") + self.p2pk65: _0satsPattern2 = _0satsPattern2(client, "p2pk65") + self.p2pkh: _0satsPattern2 = _0satsPattern2(client, "p2pkh") + self.p2sh: _0satsPattern2 = _0satsPattern2(client, "p2sh") + self.p2tr: _0satsPattern2 = _0satsPattern2(client, "p2tr") + self.p2wpkh: _0satsPattern2 = _0satsPattern2(client, "p2wpkh") + self.p2wsh: _0satsPattern2 = _0satsPattern2(client, "p2wsh") + self.unknown: _0satsPattern2 = _0satsPattern2(client, "unknown_outputs") + class MetricsTree_Distribution_UtxoCohorts_Year: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._2009: _0satsPattern2 = _0satsPattern2(client, 'year_2009') - self._2010: _0satsPattern2 = _0satsPattern2(client, 'year_2010') - self._2011: _0satsPattern2 = _0satsPattern2(client, 'year_2011') - self._2012: _0satsPattern2 = _0satsPattern2(client, 'year_2012') - self._2013: _0satsPattern2 = _0satsPattern2(client, 'year_2013') - self._2014: _0satsPattern2 = _0satsPattern2(client, 'year_2014') - self._2015: _0satsPattern2 = _0satsPattern2(client, 'year_2015') - self._2016: _0satsPattern2 = _0satsPattern2(client, 'year_2016') - self._2017: _0satsPattern2 = _0satsPattern2(client, 'year_2017') - self._2018: _0satsPattern2 = _0satsPattern2(client, 'year_2018') - self._2019: _0satsPattern2 = _0satsPattern2(client, 'year_2019') - self._2020: _0satsPattern2 = _0satsPattern2(client, 'year_2020') - self._2021: _0satsPattern2 = _0satsPattern2(client, 'year_2021') - self._2022: _0satsPattern2 = _0satsPattern2(client, 'year_2022') - self._2023: _0satsPattern2 = _0satsPattern2(client, 'year_2023') - self._2024: _0satsPattern2 = _0satsPattern2(client, 'year_2024') - self._2025: _0satsPattern2 = _0satsPattern2(client, 'year_2025') - self._2026: _0satsPattern2 = _0satsPattern2(client, 'year_2026') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._2009: _0satsPattern2 = _0satsPattern2(client, "year_2009") + self._2010: _0satsPattern2 = _0satsPattern2(client, "year_2010") + self._2011: _0satsPattern2 = _0satsPattern2(client, "year_2011") + self._2012: _0satsPattern2 = _0satsPattern2(client, "year_2012") + self._2013: _0satsPattern2 = _0satsPattern2(client, "year_2013") + self._2014: _0satsPattern2 = _0satsPattern2(client, "year_2014") + self._2015: _0satsPattern2 = _0satsPattern2(client, "year_2015") + self._2016: _0satsPattern2 = _0satsPattern2(client, "year_2016") + self._2017: _0satsPattern2 = _0satsPattern2(client, "year_2017") + self._2018: _0satsPattern2 = _0satsPattern2(client, "year_2018") + self._2019: _0satsPattern2 = _0satsPattern2(client, "year_2019") + self._2020: _0satsPattern2 = _0satsPattern2(client, "year_2020") + self._2021: _0satsPattern2 = _0satsPattern2(client, "year_2021") + self._2022: _0satsPattern2 = _0satsPattern2(client, "year_2022") + self._2023: _0satsPattern2 = _0satsPattern2(client, "year_2023") + self._2024: _0satsPattern2 = _0satsPattern2(client, "year_2024") + self._2025: _0satsPattern2 = _0satsPattern2(client, "year_2025") + self._2026: _0satsPattern2 = _0satsPattern2(client, "year_2026") + class MetricsTree_Distribution_UtxoCohorts: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.age_range: MetricsTree_Distribution_UtxoCohorts_AgeRange = MetricsTree_Distribution_UtxoCohorts_AgeRange(client) - self.all: MetricsTree_Distribution_UtxoCohorts_All = MetricsTree_Distribution_UtxoCohorts_All(client) - self.amount_range: MetricsTree_Distribution_UtxoCohorts_AmountRange = MetricsTree_Distribution_UtxoCohorts_AmountRange(client) - self.epoch: MetricsTree_Distribution_UtxoCohorts_Epoch = MetricsTree_Distribution_UtxoCohorts_Epoch(client) - self.ge_amount: MetricsTree_Distribution_UtxoCohorts_GeAmount = MetricsTree_Distribution_UtxoCohorts_GeAmount(client) - self.lt_amount: MetricsTree_Distribution_UtxoCohorts_LtAmount = MetricsTree_Distribution_UtxoCohorts_LtAmount(client) - self.max_age: MetricsTree_Distribution_UtxoCohorts_MaxAge = MetricsTree_Distribution_UtxoCohorts_MaxAge(client) - self.min_age: MetricsTree_Distribution_UtxoCohorts_MinAge = MetricsTree_Distribution_UtxoCohorts_MinAge(client) - self.term: MetricsTree_Distribution_UtxoCohorts_Term = MetricsTree_Distribution_UtxoCohorts_Term(client) - self.type_: MetricsTree_Distribution_UtxoCohorts_Type = MetricsTree_Distribution_UtxoCohorts_Type(client) - self.year: MetricsTree_Distribution_UtxoCohorts_Year = MetricsTree_Distribution_UtxoCohorts_Year(client) + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.age_range: MetricsTree_Distribution_UtxoCohorts_AgeRange = ( + MetricsTree_Distribution_UtxoCohorts_AgeRange(client) + ) + self.all: MetricsTree_Distribution_UtxoCohorts_All = ( + MetricsTree_Distribution_UtxoCohorts_All(client) + ) + self.amount_range: MetricsTree_Distribution_UtxoCohorts_AmountRange = ( + MetricsTree_Distribution_UtxoCohorts_AmountRange(client) + ) + self.epoch: MetricsTree_Distribution_UtxoCohorts_Epoch = ( + MetricsTree_Distribution_UtxoCohorts_Epoch(client) + ) + self.ge_amount: MetricsTree_Distribution_UtxoCohorts_GeAmount = ( + MetricsTree_Distribution_UtxoCohorts_GeAmount(client) + ) + self.lt_amount: MetricsTree_Distribution_UtxoCohorts_LtAmount = ( + MetricsTree_Distribution_UtxoCohorts_LtAmount(client) + ) + self.max_age: MetricsTree_Distribution_UtxoCohorts_MaxAge = ( + MetricsTree_Distribution_UtxoCohorts_MaxAge(client) + ) + self.min_age: MetricsTree_Distribution_UtxoCohorts_MinAge = ( + MetricsTree_Distribution_UtxoCohorts_MinAge(client) + ) + self.term: MetricsTree_Distribution_UtxoCohorts_Term = ( + MetricsTree_Distribution_UtxoCohorts_Term(client) + ) + self.type_: MetricsTree_Distribution_UtxoCohorts_Type = ( + MetricsTree_Distribution_UtxoCohorts_Type(client) + ) + self.year: MetricsTree_Distribution_UtxoCohorts_Year = ( + MetricsTree_Distribution_UtxoCohorts_Year(client) + ) + class MetricsTree_Distribution: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.addr_count: AddrCountPattern = AddrCountPattern(client, 'addr_count') - self.address_cohorts: MetricsTree_Distribution_AddressCohorts = MetricsTree_Distribution_AddressCohorts(client) - self.addresses_data: MetricsTree_Distribution_AddressesData = MetricsTree_Distribution_AddressesData(client) - self.any_address_indexes: MetricsTree_Distribution_AnyAddressIndexes = MetricsTree_Distribution_AnyAddressIndexes(client) - self.chain_state: MetricPattern11[SupplyState] = MetricPattern11(client, 'chain') - self.empty_addr_count: AddrCountPattern = AddrCountPattern(client, 'empty_addr_count') - self.emptyaddressindex: MetricPattern32[EmptyAddressIndex] = MetricPattern32(client, 'emptyaddressindex') - self.loadedaddressindex: MetricPattern31[LoadedAddressIndex] = MetricPattern31(client, 'loadedaddressindex') - self.utxo_cohorts: MetricsTree_Distribution_UtxoCohorts = MetricsTree_Distribution_UtxoCohorts(client) + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.addr_count: AddrCountPattern = AddrCountPattern(client, "addr_count") + self.address_cohorts: MetricsTree_Distribution_AddressCohorts = ( + MetricsTree_Distribution_AddressCohorts(client) + ) + self.addresses_data: MetricsTree_Distribution_AddressesData = ( + MetricsTree_Distribution_AddressesData(client) + ) + self.any_address_indexes: MetricsTree_Distribution_AnyAddressIndexes = ( + MetricsTree_Distribution_AnyAddressIndexes(client) + ) + self.chain_state: MetricPattern11[SupplyState] = MetricPattern11( + client, "chain" + ) + self.empty_addr_count: AddrCountPattern = AddrCountPattern( + client, "empty_addr_count" + ) + self.emptyaddressindex: MetricPattern32[EmptyAddressIndex] = MetricPattern32( + client, "emptyaddressindex" + ) + self.loadedaddressindex: MetricPattern31[LoadedAddressIndex] = MetricPattern31( + client, "loadedaddressindex" + ) + self.utxo_cohorts: MetricsTree_Distribution_UtxoCohorts = ( + MetricsTree_Distribution_UtxoCohorts(client) + ) + class MetricsTree_Indexes_Address_Empty: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern9[EmptyOutputIndex] = MetricPattern9(client, 'emptyoutputindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern9[EmptyOutputIndex] = MetricPattern9( + client, "emptyoutputindex" + ) + class MetricsTree_Indexes_Address_Opreturn: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern14[OpReturnIndex] = MetricPattern14(client, 'opreturnindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern14[OpReturnIndex] = MetricPattern14( + client, "opreturnindex" + ) + class MetricsTree_Indexes_Address_P2a: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern16[P2AAddressIndex] = MetricPattern16(client, 'p2aaddressindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern16[P2AAddressIndex] = MetricPattern16( + client, "p2aaddressindex" + ) + class MetricsTree_Indexes_Address_P2ms: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern17[P2MSOutputIndex] = MetricPattern17(client, 'p2msoutputindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern17[P2MSOutputIndex] = MetricPattern17( + client, "p2msoutputindex" + ) + class MetricsTree_Indexes_Address_P2pk33: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern18[P2PK33AddressIndex] = MetricPattern18(client, 'p2pk33addressindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern18[P2PK33AddressIndex] = MetricPattern18( + client, "p2pk33addressindex" + ) + class MetricsTree_Indexes_Address_P2pk65: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern19[P2PK65AddressIndex] = MetricPattern19(client, 'p2pk65addressindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern19[P2PK65AddressIndex] = MetricPattern19( + client, "p2pk65addressindex" + ) + class MetricsTree_Indexes_Address_P2pkh: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern20[P2PKHAddressIndex] = MetricPattern20(client, 'p2pkhaddressindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern20[P2PKHAddressIndex] = MetricPattern20( + client, "p2pkhaddressindex" + ) + class MetricsTree_Indexes_Address_P2sh: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern21[P2SHAddressIndex] = MetricPattern21(client, 'p2shaddressindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern21[P2SHAddressIndex] = MetricPattern21( + client, "p2shaddressindex" + ) + class MetricsTree_Indexes_Address_P2tr: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern22[P2TRAddressIndex] = MetricPattern22(client, 'p2traddressindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern22[P2TRAddressIndex] = MetricPattern22( + client, "p2traddressindex" + ) + class MetricsTree_Indexes_Address_P2wpkh: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern23[P2WPKHAddressIndex] = MetricPattern23(client, 'p2wpkhaddressindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern23[P2WPKHAddressIndex] = MetricPattern23( + client, "p2wpkhaddressindex" + ) + class MetricsTree_Indexes_Address_P2wsh: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern24[P2WSHAddressIndex] = MetricPattern24(client, 'p2wshaddressindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern24[P2WSHAddressIndex] = MetricPattern24( + client, "p2wshaddressindex" + ) + class MetricsTree_Indexes_Address_Unknown: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern28[UnknownOutputIndex] = MetricPattern28(client, 'unknownoutputindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern28[UnknownOutputIndex] = MetricPattern28( + client, "unknownoutputindex" + ) + class MetricsTree_Indexes_Address: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.empty: MetricsTree_Indexes_Address_Empty = MetricsTree_Indexes_Address_Empty(client) - self.opreturn: MetricsTree_Indexes_Address_Opreturn = MetricsTree_Indexes_Address_Opreturn(client) - self.p2a: MetricsTree_Indexes_Address_P2a = MetricsTree_Indexes_Address_P2a(client) - self.p2ms: MetricsTree_Indexes_Address_P2ms = MetricsTree_Indexes_Address_P2ms(client) - self.p2pk33: MetricsTree_Indexes_Address_P2pk33 = MetricsTree_Indexes_Address_P2pk33(client) - self.p2pk65: MetricsTree_Indexes_Address_P2pk65 = MetricsTree_Indexes_Address_P2pk65(client) - self.p2pkh: MetricsTree_Indexes_Address_P2pkh = MetricsTree_Indexes_Address_P2pkh(client) - self.p2sh: MetricsTree_Indexes_Address_P2sh = MetricsTree_Indexes_Address_P2sh(client) - self.p2tr: MetricsTree_Indexes_Address_P2tr = MetricsTree_Indexes_Address_P2tr(client) - self.p2wpkh: MetricsTree_Indexes_Address_P2wpkh = MetricsTree_Indexes_Address_P2wpkh(client) - self.p2wsh: MetricsTree_Indexes_Address_P2wsh = MetricsTree_Indexes_Address_P2wsh(client) - self.unknown: MetricsTree_Indexes_Address_Unknown = MetricsTree_Indexes_Address_Unknown(client) + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.empty: MetricsTree_Indexes_Address_Empty = ( + MetricsTree_Indexes_Address_Empty(client) + ) + self.opreturn: MetricsTree_Indexes_Address_Opreturn = ( + MetricsTree_Indexes_Address_Opreturn(client) + ) + self.p2a: MetricsTree_Indexes_Address_P2a = MetricsTree_Indexes_Address_P2a( + client + ) + self.p2ms: MetricsTree_Indexes_Address_P2ms = MetricsTree_Indexes_Address_P2ms( + client + ) + self.p2pk33: MetricsTree_Indexes_Address_P2pk33 = ( + MetricsTree_Indexes_Address_P2pk33(client) + ) + self.p2pk65: MetricsTree_Indexes_Address_P2pk65 = ( + MetricsTree_Indexes_Address_P2pk65(client) + ) + self.p2pkh: MetricsTree_Indexes_Address_P2pkh = ( + MetricsTree_Indexes_Address_P2pkh(client) + ) + self.p2sh: MetricsTree_Indexes_Address_P2sh = MetricsTree_Indexes_Address_P2sh( + client + ) + self.p2tr: MetricsTree_Indexes_Address_P2tr = MetricsTree_Indexes_Address_P2tr( + client + ) + self.p2wpkh: MetricsTree_Indexes_Address_P2wpkh = ( + MetricsTree_Indexes_Address_P2wpkh(client) + ) + self.p2wsh: MetricsTree_Indexes_Address_P2wsh = ( + MetricsTree_Indexes_Address_P2wsh(client) + ) + self.unknown: MetricsTree_Indexes_Address_Unknown = ( + MetricsTree_Indexes_Address_Unknown(client) + ) + class MetricsTree_Indexes_Dateindex: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.date: MetricPattern6[Date] = MetricPattern6(client, 'date') - self.first_height: MetricPattern6[Height] = MetricPattern6(client, 'first_height') - self.height_count: MetricPattern6[StoredU64] = MetricPattern6(client, 'height_count') - self.identity: MetricPattern6[DateIndex] = MetricPattern6(client, 'dateindex') - self.monthindex: MetricPattern6[MonthIndex] = MetricPattern6(client, 'monthindex') - self.weekindex: MetricPattern6[WeekIndex] = MetricPattern6(client, 'weekindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.date: MetricPattern6[Date] = MetricPattern6(client, "date") + self.first_height: MetricPattern6[Height] = MetricPattern6( + client, "first_height" + ) + self.height_count: MetricPattern6[StoredU64] = MetricPattern6( + client, "height_count" + ) + self.identity: MetricPattern6[DateIndex] = MetricPattern6(client, "dateindex") + self.monthindex: MetricPattern6[MonthIndex] = MetricPattern6( + client, "monthindex" + ) + self.weekindex: MetricPattern6[WeekIndex] = MetricPattern6(client, "weekindex") + class MetricsTree_Indexes_Decadeindex: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.date: MetricPattern7[Date] = MetricPattern7(client, 'date') - self.first_yearindex: MetricPattern7[YearIndex] = MetricPattern7(client, 'first_yearindex') - self.identity: MetricPattern7[DecadeIndex] = MetricPattern7(client, 'decadeindex') - self.yearindex_count: MetricPattern7[StoredU64] = MetricPattern7(client, 'yearindex_count') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.date: MetricPattern7[Date] = MetricPattern7(client, "date") + self.first_yearindex: MetricPattern7[YearIndex] = MetricPattern7( + client, "first_yearindex" + ) + self.identity: MetricPattern7[DecadeIndex] = MetricPattern7( + client, "decadeindex" + ) + self.yearindex_count: MetricPattern7[StoredU64] = MetricPattern7( + client, "yearindex_count" + ) + class MetricsTree_Indexes_Difficultyepoch: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.first_height: MetricPattern8[Height] = MetricPattern8(client, 'first_height') - self.height_count: MetricPattern8[StoredU64] = MetricPattern8(client, 'height_count') - self.identity: MetricPattern8[DifficultyEpoch] = MetricPattern8(client, 'difficultyepoch') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.first_height: MetricPattern8[Height] = MetricPattern8( + client, "first_height" + ) + self.height_count: MetricPattern8[StoredU64] = MetricPattern8( + client, "height_count" + ) + self.identity: MetricPattern8[DifficultyEpoch] = MetricPattern8( + client, "difficultyepoch" + ) + class MetricsTree_Indexes_Halvingepoch: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.first_height: MetricPattern10[Height] = MetricPattern10(client, 'first_height') - self.identity: MetricPattern10[HalvingEpoch] = MetricPattern10(client, 'halvingepoch') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.first_height: MetricPattern10[Height] = MetricPattern10( + client, "first_height" + ) + self.identity: MetricPattern10[HalvingEpoch] = MetricPattern10( + client, "halvingepoch" + ) + class MetricsTree_Indexes_Height: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.dateindex: MetricPattern11[DateIndex] = MetricPattern11(client, 'height_dateindex') - self.difficultyepoch: MetricPattern11[DifficultyEpoch] = MetricPattern11(client, 'difficultyepoch') - self.halvingepoch: MetricPattern11[HalvingEpoch] = MetricPattern11(client, 'halvingepoch') - self.identity: MetricPattern11[Height] = MetricPattern11(client, 'height') - self.txindex_count: MetricPattern11[StoredU64] = MetricPattern11(client, 'txindex_count') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.dateindex: MetricPattern11[DateIndex] = MetricPattern11( + client, "height_dateindex" + ) + self.difficultyepoch: MetricPattern11[DifficultyEpoch] = MetricPattern11( + client, "difficultyepoch" + ) + self.halvingepoch: MetricPattern11[HalvingEpoch] = MetricPattern11( + client, "halvingepoch" + ) + self.identity: MetricPattern11[Height] = MetricPattern11(client, "height") + self.txindex_count: MetricPattern11[StoredU64] = MetricPattern11( + client, "txindex_count" + ) + class MetricsTree_Indexes_Monthindex: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.date: MetricPattern13[Date] = MetricPattern13(client, 'date') - self.dateindex_count: MetricPattern13[StoredU64] = MetricPattern13(client, 'dateindex_count') - self.first_dateindex: MetricPattern13[DateIndex] = MetricPattern13(client, 'first_dateindex') - self.identity: MetricPattern13[MonthIndex] = MetricPattern13(client, 'monthindex') - self.quarterindex: MetricPattern13[QuarterIndex] = MetricPattern13(client, 'quarterindex') - self.semesterindex: MetricPattern13[SemesterIndex] = MetricPattern13(client, 'semesterindex') - self.yearindex: MetricPattern13[YearIndex] = MetricPattern13(client, 'yearindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.date: MetricPattern13[Date] = MetricPattern13(client, "date") + self.dateindex_count: MetricPattern13[StoredU64] = MetricPattern13( + client, "dateindex_count" + ) + self.first_dateindex: MetricPattern13[DateIndex] = MetricPattern13( + client, "first_dateindex" + ) + self.identity: MetricPattern13[MonthIndex] = MetricPattern13( + client, "monthindex" + ) + self.quarterindex: MetricPattern13[QuarterIndex] = MetricPattern13( + client, "quarterindex" + ) + self.semesterindex: MetricPattern13[SemesterIndex] = MetricPattern13( + client, "semesterindex" + ) + self.yearindex: MetricPattern13[YearIndex] = MetricPattern13( + client, "yearindex" + ) + class MetricsTree_Indexes_Quarterindex: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.date: MetricPattern25[Date] = MetricPattern25(client, 'date') - self.first_monthindex: MetricPattern25[MonthIndex] = MetricPattern25(client, 'first_monthindex') - self.identity: MetricPattern25[QuarterIndex] = MetricPattern25(client, 'quarterindex') - self.monthindex_count: MetricPattern25[StoredU64] = MetricPattern25(client, 'monthindex_count') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.date: MetricPattern25[Date] = MetricPattern25(client, "date") + self.first_monthindex: MetricPattern25[MonthIndex] = MetricPattern25( + client, "first_monthindex" + ) + self.identity: MetricPattern25[QuarterIndex] = MetricPattern25( + client, "quarterindex" + ) + self.monthindex_count: MetricPattern25[StoredU64] = MetricPattern25( + client, "monthindex_count" + ) + class MetricsTree_Indexes_Semesterindex: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.date: MetricPattern26[Date] = MetricPattern26(client, 'date') - self.first_monthindex: MetricPattern26[MonthIndex] = MetricPattern26(client, 'first_monthindex') - self.identity: MetricPattern26[SemesterIndex] = MetricPattern26(client, 'semesterindex') - self.monthindex_count: MetricPattern26[StoredU64] = MetricPattern26(client, 'monthindex_count') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.date: MetricPattern26[Date] = MetricPattern26(client, "date") + self.first_monthindex: MetricPattern26[MonthIndex] = MetricPattern26( + client, "first_monthindex" + ) + self.identity: MetricPattern26[SemesterIndex] = MetricPattern26( + client, "semesterindex" + ) + self.monthindex_count: MetricPattern26[StoredU64] = MetricPattern26( + client, "monthindex_count" + ) + class MetricsTree_Indexes_Txindex: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern27[TxIndex] = MetricPattern27(client, 'txindex') - self.input_count: MetricPattern27[StoredU64] = MetricPattern27(client, 'input_count') - self.output_count: MetricPattern27[StoredU64] = MetricPattern27(client, 'output_count') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern27[TxIndex] = MetricPattern27(client, "txindex") + self.input_count: MetricPattern27[StoredU64] = MetricPattern27( + client, "input_count" + ) + self.output_count: MetricPattern27[StoredU64] = MetricPattern27( + client, "output_count" + ) + class MetricsTree_Indexes_Txinindex: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern12[TxInIndex] = MetricPattern12(client, 'txinindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern12[TxInIndex] = MetricPattern12(client, "txinindex") + class MetricsTree_Indexes_Txoutindex: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.identity: MetricPattern15[TxOutIndex] = MetricPattern15(client, 'txoutindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.identity: MetricPattern15[TxOutIndex] = MetricPattern15( + client, "txoutindex" + ) + class MetricsTree_Indexes_Weekindex: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.date: MetricPattern29[Date] = MetricPattern29(client, 'date') - self.dateindex_count: MetricPattern29[StoredU64] = MetricPattern29(client, 'dateindex_count') - self.first_dateindex: MetricPattern29[DateIndex] = MetricPattern29(client, 'first_dateindex') - self.identity: MetricPattern29[WeekIndex] = MetricPattern29(client, 'weekindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.date: MetricPattern29[Date] = MetricPattern29(client, "date") + self.dateindex_count: MetricPattern29[StoredU64] = MetricPattern29( + client, "dateindex_count" + ) + self.first_dateindex: MetricPattern29[DateIndex] = MetricPattern29( + client, "first_dateindex" + ) + self.identity: MetricPattern29[WeekIndex] = MetricPattern29(client, "weekindex") + class MetricsTree_Indexes_Yearindex: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.date: MetricPattern30[Date] = MetricPattern30(client, 'date') - self.decadeindex: MetricPattern30[DecadeIndex] = MetricPattern30(client, 'decadeindex') - self.first_monthindex: MetricPattern30[MonthIndex] = MetricPattern30(client, 'first_monthindex') - self.identity: MetricPattern30[YearIndex] = MetricPattern30(client, 'yearindex') - self.monthindex_count: MetricPattern30[StoredU64] = MetricPattern30(client, 'monthindex_count') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.date: MetricPattern30[Date] = MetricPattern30(client, "date") + self.decadeindex: MetricPattern30[DecadeIndex] = MetricPattern30( + client, "decadeindex" + ) + self.first_monthindex: MetricPattern30[MonthIndex] = MetricPattern30( + client, "first_monthindex" + ) + self.identity: MetricPattern30[YearIndex] = MetricPattern30(client, "yearindex") + self.monthindex_count: MetricPattern30[StoredU64] = MetricPattern30( + client, "monthindex_count" + ) + class MetricsTree_Indexes: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): + + def __init__(self, client: BrkClientBase, base_path: str = ""): self.address: MetricsTree_Indexes_Address = MetricsTree_Indexes_Address(client) - self.dateindex: MetricsTree_Indexes_Dateindex = MetricsTree_Indexes_Dateindex(client) - self.decadeindex: MetricsTree_Indexes_Decadeindex = MetricsTree_Indexes_Decadeindex(client) - self.difficultyepoch: MetricsTree_Indexes_Difficultyepoch = MetricsTree_Indexes_Difficultyepoch(client) - self.halvingepoch: MetricsTree_Indexes_Halvingepoch = MetricsTree_Indexes_Halvingepoch(client) + self.dateindex: MetricsTree_Indexes_Dateindex = MetricsTree_Indexes_Dateindex( + client + ) + self.decadeindex: MetricsTree_Indexes_Decadeindex = ( + MetricsTree_Indexes_Decadeindex(client) + ) + self.difficultyepoch: MetricsTree_Indexes_Difficultyepoch = ( + MetricsTree_Indexes_Difficultyepoch(client) + ) + self.halvingepoch: MetricsTree_Indexes_Halvingepoch = ( + MetricsTree_Indexes_Halvingepoch(client) + ) self.height: MetricsTree_Indexes_Height = MetricsTree_Indexes_Height(client) - self.monthindex: MetricsTree_Indexes_Monthindex = MetricsTree_Indexes_Monthindex(client) - self.quarterindex: MetricsTree_Indexes_Quarterindex = MetricsTree_Indexes_Quarterindex(client) - self.semesterindex: MetricsTree_Indexes_Semesterindex = MetricsTree_Indexes_Semesterindex(client) + self.monthindex: MetricsTree_Indexes_Monthindex = ( + MetricsTree_Indexes_Monthindex(client) + ) + self.quarterindex: MetricsTree_Indexes_Quarterindex = ( + MetricsTree_Indexes_Quarterindex(client) + ) + self.semesterindex: MetricsTree_Indexes_Semesterindex = ( + MetricsTree_Indexes_Semesterindex(client) + ) self.txindex: MetricsTree_Indexes_Txindex = MetricsTree_Indexes_Txindex(client) - self.txinindex: MetricsTree_Indexes_Txinindex = MetricsTree_Indexes_Txinindex(client) - self.txoutindex: MetricsTree_Indexes_Txoutindex = MetricsTree_Indexes_Txoutindex(client) - self.weekindex: MetricsTree_Indexes_Weekindex = MetricsTree_Indexes_Weekindex(client) - self.yearindex: MetricsTree_Indexes_Yearindex = MetricsTree_Indexes_Yearindex(client) + self.txinindex: MetricsTree_Indexes_Txinindex = MetricsTree_Indexes_Txinindex( + client + ) + self.txoutindex: MetricsTree_Indexes_Txoutindex = ( + MetricsTree_Indexes_Txoutindex(client) + ) + self.weekindex: MetricsTree_Indexes_Weekindex = MetricsTree_Indexes_Weekindex( + client + ) + self.yearindex: MetricsTree_Indexes_Yearindex = MetricsTree_Indexes_Yearindex( + client + ) + class MetricsTree_Inputs_Spent: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.txoutindex: MetricPattern12[TxOutIndex] = MetricPattern12(client, 'txoutindex') - self.value: MetricPattern12[Sats] = MetricPattern12(client, 'value') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.txoutindex: MetricPattern12[TxOutIndex] = MetricPattern12( + client, "txoutindex" + ) + self.value: MetricPattern12[Sats] = MetricPattern12(client, "value") + class MetricsTree_Inputs: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.count: CountPattern2[StoredU64] = CountPattern2(client, 'input_count') - self.first_txinindex: MetricPattern11[TxInIndex] = MetricPattern11(client, 'first_txinindex') - self.outpoint: MetricPattern12[OutPoint] = MetricPattern12(client, 'outpoint') - self.outputtype: MetricPattern12[OutputType] = MetricPattern12(client, 'outputtype') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.count: CountPattern2[StoredU64] = CountPattern2(client, "input_count") + self.first_txinindex: MetricPattern11[TxInIndex] = MetricPattern11( + client, "first_txinindex" + ) + self.outpoint: MetricPattern12[OutPoint] = MetricPattern12(client, "outpoint") + self.outputtype: MetricPattern12[OutputType] = MetricPattern12( + client, "outputtype" + ) self.spent: MetricsTree_Inputs_Spent = MetricsTree_Inputs_Spent(client) - self.txindex: MetricPattern12[TxIndex] = MetricPattern12(client, 'txindex') - self.typeindex: MetricPattern12[TypeIndex] = MetricPattern12(client, 'typeindex') + self.txindex: MetricPattern12[TxIndex] = MetricPattern12(client, "txindex") + self.typeindex: MetricPattern12[TypeIndex] = MetricPattern12( + client, "typeindex" + ) + class MetricsTree_Market_Ath: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.days_since_price_ath: MetricPattern4[StoredU16] = MetricPattern4(client, 'days_since_price_ath') - self.max_days_between_price_aths: MetricPattern4[StoredU16] = MetricPattern4(client, 'max_days_between_price_aths') - self.max_years_between_price_aths: MetricPattern4[StoredF32] = MetricPattern4(client, 'max_years_between_price_aths') - self.price_ath: MetricPattern1[Dollars] = MetricPattern1(client, 'price_ath') - self.price_drawdown: MetricPattern3[StoredF32] = MetricPattern3(client, 'price_drawdown') - self.years_since_price_ath: MetricPattern4[StoredF32] = MetricPattern4(client, 'years_since_price_ath') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.days_since_price_ath: MetricPattern4[StoredU16] = MetricPattern4( + client, "days_since_price_ath" + ) + self.max_days_between_price_aths: MetricPattern4[StoredU16] = MetricPattern4( + client, "max_days_between_price_aths" + ) + self.max_years_between_price_aths: MetricPattern4[StoredF32] = MetricPattern4( + client, "max_years_between_price_aths" + ) + self.price_ath: MetricPattern1[Dollars] = MetricPattern1(client, "price_ath") + self.price_drawdown: MetricPattern3[StoredF32] = MetricPattern3( + client, "price_drawdown" + ) + self.years_since_price_ath: MetricPattern4[StoredF32] = MetricPattern4( + client, "years_since_price_ath" + ) + class MetricsTree_Market_Dca_ClassAveragePrice: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._2015: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2015_average_price') - self._2016: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2016_average_price') - self._2017: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2017_average_price') - self._2018: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2018_average_price') - self._2019: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2019_average_price') - self._2020: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2020_average_price') - self._2021: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2021_average_price') - self._2022: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2022_average_price') - self._2023: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2023_average_price') - self._2024: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2024_average_price') - self._2025: MetricPattern4[Dollars] = MetricPattern4(client, 'dca_class_2025_average_price') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._2015: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2015_average_price" + ) + self._2016: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2016_average_price" + ) + self._2017: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2017_average_price" + ) + self._2018: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2018_average_price" + ) + self._2019: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2019_average_price" + ) + self._2020: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2020_average_price" + ) + self._2021: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2021_average_price" + ) + self._2022: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2022_average_price" + ) + self._2023: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2023_average_price" + ) + self._2024: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2024_average_price" + ) + self._2025: MetricPattern4[Dollars] = MetricPattern4( + client, "dca_class_2025_average_price" + ) + class MetricsTree_Market_Dca_ClassStack: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._2015: _2015Pattern = _2015Pattern(client, 'dca_class_2015_stack') - self._2016: _2015Pattern = _2015Pattern(client, 'dca_class_2016_stack') - self._2017: _2015Pattern = _2015Pattern(client, 'dca_class_2017_stack') - self._2018: _2015Pattern = _2015Pattern(client, 'dca_class_2018_stack') - self._2019: _2015Pattern = _2015Pattern(client, 'dca_class_2019_stack') - self._2020: _2015Pattern = _2015Pattern(client, 'dca_class_2020_stack') - self._2021: _2015Pattern = _2015Pattern(client, 'dca_class_2021_stack') - self._2022: _2015Pattern = _2015Pattern(client, 'dca_class_2022_stack') - self._2023: _2015Pattern = _2015Pattern(client, 'dca_class_2023_stack') - self._2024: _2015Pattern = _2015Pattern(client, 'dca_class_2024_stack') - self._2025: _2015Pattern = _2015Pattern(client, 'dca_class_2025_stack') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._2015: _2015Pattern = _2015Pattern(client, "dca_class_2015_stack") + self._2016: _2015Pattern = _2015Pattern(client, "dca_class_2016_stack") + self._2017: _2015Pattern = _2015Pattern(client, "dca_class_2017_stack") + self._2018: _2015Pattern = _2015Pattern(client, "dca_class_2018_stack") + self._2019: _2015Pattern = _2015Pattern(client, "dca_class_2019_stack") + self._2020: _2015Pattern = _2015Pattern(client, "dca_class_2020_stack") + self._2021: _2015Pattern = _2015Pattern(client, "dca_class_2021_stack") + self._2022: _2015Pattern = _2015Pattern(client, "dca_class_2022_stack") + self._2023: _2015Pattern = _2015Pattern(client, "dca_class_2023_stack") + self._2024: _2015Pattern = _2015Pattern(client, "dca_class_2024_stack") + self._2025: _2015Pattern = _2015Pattern(client, "dca_class_2025_stack") + class MetricsTree_Market_Dca: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.class_average_price: MetricsTree_Market_Dca_ClassAveragePrice = MetricsTree_Market_Dca_ClassAveragePrice(client) - self.class_returns: ClassAveragePricePattern[StoredF32] = ClassAveragePricePattern(client, 'dca_class') - self.class_stack: MetricsTree_Market_Dca_ClassStack = MetricsTree_Market_Dca_ClassStack(client) - self.period_average_price: PeriodAveragePricePattern[Dollars] = PeriodAveragePricePattern(client, 'dca_average_price') - self.period_cagr: PeriodCagrPattern = PeriodCagrPattern(client, 'dca_cagr') - self.period_lump_sum_stack: PeriodLumpSumStackPattern = PeriodLumpSumStackPattern(client, 'lump_sum_stack') - self.period_returns: PeriodAveragePricePattern[StoredF32] = PeriodAveragePricePattern(client, 'dca_returns') - self.period_stack: PeriodLumpSumStackPattern = PeriodLumpSumStackPattern(client, 'dca_stack') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.class_average_price: MetricsTree_Market_Dca_ClassAveragePrice = ( + MetricsTree_Market_Dca_ClassAveragePrice(client) + ) + self.class_returns: ClassAveragePricePattern[StoredF32] = ( + ClassAveragePricePattern(client, "dca_class") + ) + self.class_stack: MetricsTree_Market_Dca_ClassStack = ( + MetricsTree_Market_Dca_ClassStack(client) + ) + self.period_average_price: PeriodAveragePricePattern[Dollars] = ( + PeriodAveragePricePattern(client, "dca_average_price") + ) + self.period_cagr: PeriodCagrPattern = PeriodCagrPattern(client, "dca_cagr") + self.period_lump_sum_stack: PeriodLumpSumStackPattern = ( + PeriodLumpSumStackPattern(client, "lump_sum_stack") + ) + self.period_returns: PeriodAveragePricePattern[StoredF32] = ( + PeriodAveragePricePattern(client, "dca_returns") + ) + self.period_stack: PeriodLumpSumStackPattern = PeriodLumpSumStackPattern( + client, "dca_stack" + ) + class MetricsTree_Market_Indicators: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.gini: MetricPattern6[StoredF32] = MetricPattern6(client, 'gini') - self.macd_histogram: MetricPattern6[StoredF32] = MetricPattern6(client, 'macd_histogram') - self.macd_line: MetricPattern6[StoredF32] = MetricPattern6(client, 'macd_line') - self.macd_signal: MetricPattern6[StoredF32] = MetricPattern6(client, 'macd_signal') - self.nvt: MetricPattern4[StoredF32] = MetricPattern4(client, 'nvt') - self.pi_cycle: MetricPattern6[StoredF32] = MetricPattern6(client, 'pi_cycle') - self.puell_multiple: MetricPattern4[StoredF32] = MetricPattern4(client, 'puell_multiple') - self.rsi_14d: MetricPattern6[StoredF32] = MetricPattern6(client, 'rsi_14d') - self.rsi_14d_max: MetricPattern6[StoredF32] = MetricPattern6(client, 'rsi_14d_max') - self.rsi_14d_min: MetricPattern6[StoredF32] = MetricPattern6(client, 'rsi_14d_min') - self.rsi_average_gain_14d: MetricPattern6[StoredF32] = MetricPattern6(client, 'rsi_average_gain_14d') - self.rsi_average_loss_14d: MetricPattern6[StoredF32] = MetricPattern6(client, 'rsi_average_loss_14d') - self.rsi_gains: MetricPattern6[StoredF32] = MetricPattern6(client, 'rsi_gains') - self.rsi_losses: MetricPattern6[StoredF32] = MetricPattern6(client, 'rsi_losses') - self.stoch_d: MetricPattern6[StoredF32] = MetricPattern6(client, 'stoch_d') - self.stoch_k: MetricPattern6[StoredF32] = MetricPattern6(client, 'stoch_k') - self.stoch_rsi: MetricPattern6[StoredF32] = MetricPattern6(client, 'stoch_rsi') - self.stoch_rsi_d: MetricPattern6[StoredF32] = MetricPattern6(client, 'stoch_rsi_d') - self.stoch_rsi_k: MetricPattern6[StoredF32] = MetricPattern6(client, 'stoch_rsi_k') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.gini: MetricPattern6[StoredF32] = MetricPattern6(client, "gini") + self.macd_histogram: MetricPattern6[StoredF32] = MetricPattern6( + client, "macd_histogram" + ) + self.macd_line: MetricPattern6[StoredF32] = MetricPattern6(client, "macd_line") + self.macd_signal: MetricPattern6[StoredF32] = MetricPattern6( + client, "macd_signal" + ) + self.nvt: MetricPattern4[StoredF32] = MetricPattern4(client, "nvt") + self.pi_cycle: MetricPattern6[StoredF32] = MetricPattern6(client, "pi_cycle") + self.puell_multiple: MetricPattern4[StoredF32] = MetricPattern4( + client, "puell_multiple" + ) + self.rsi_14d: MetricPattern6[StoredF32] = MetricPattern6(client, "rsi_14d") + self.rsi_14d_max: MetricPattern6[StoredF32] = MetricPattern6( + client, "rsi_14d_max" + ) + self.rsi_14d_min: MetricPattern6[StoredF32] = MetricPattern6( + client, "rsi_14d_min" + ) + self.rsi_average_gain_14d: MetricPattern6[StoredF32] = MetricPattern6( + client, "rsi_average_gain_14d" + ) + self.rsi_average_loss_14d: MetricPattern6[StoredF32] = MetricPattern6( + client, "rsi_average_loss_14d" + ) + self.rsi_gains: MetricPattern6[StoredF32] = MetricPattern6(client, "rsi_gains") + self.rsi_losses: MetricPattern6[StoredF32] = MetricPattern6( + client, "rsi_losses" + ) + self.stoch_d: MetricPattern6[StoredF32] = MetricPattern6(client, "stoch_d") + self.stoch_k: MetricPattern6[StoredF32] = MetricPattern6(client, "stoch_k") + self.stoch_rsi: MetricPattern6[StoredF32] = MetricPattern6(client, "stoch_rsi") + self.stoch_rsi_d: MetricPattern6[StoredF32] = MetricPattern6( + client, "stoch_rsi_d" + ) + self.stoch_rsi_k: MetricPattern6[StoredF32] = MetricPattern6( + client, "stoch_rsi_k" + ) + class MetricsTree_Market_MovingAverage: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.price_111d_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_111d_sma') - self.price_12d_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_12d_ema') - self.price_13d_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_13d_ema') - self.price_13d_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_13d_sma') - self.price_144d_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_144d_ema') - self.price_144d_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_144d_sma') - self.price_1m_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_1m_ema') - self.price_1m_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_1m_sma') - self.price_1w_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_1w_ema') - self.price_1w_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_1w_sma') - self.price_1y_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_1y_ema') - self.price_1y_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_1y_sma') - self.price_200d_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_200d_ema') - self.price_200d_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_200d_sma') - self.price_200d_sma_x0_8: MetricPattern4[Dollars] = MetricPattern4(client, 'price_200d_sma_x0_8') - self.price_200d_sma_x2_4: MetricPattern4[Dollars] = MetricPattern4(client, 'price_200d_sma_x2_4') - self.price_200w_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_200w_ema') - self.price_200w_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_200w_sma') - self.price_21d_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_21d_ema') - self.price_21d_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_21d_sma') - self.price_26d_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_26d_ema') - self.price_2y_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_2y_ema') - self.price_2y_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_2y_sma') - self.price_34d_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_34d_ema') - self.price_34d_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_34d_sma') - self.price_350d_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_350d_sma') - self.price_350d_sma_x2: MetricPattern4[Dollars] = MetricPattern4(client, 'price_350d_sma_x2') - self.price_4y_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_4y_ema') - self.price_4y_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_4y_sma') - self.price_55d_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_55d_ema') - self.price_55d_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_55d_sma') - self.price_89d_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_89d_ema') - self.price_89d_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_89d_sma') - self.price_8d_ema: Price111dSmaPattern = Price111dSmaPattern(client, 'price_8d_ema') - self.price_8d_sma: Price111dSmaPattern = Price111dSmaPattern(client, 'price_8d_sma') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.price_111d_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_111d_sma" + ) + self.price_12d_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_12d_ema" + ) + self.price_13d_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_13d_ema" + ) + self.price_13d_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_13d_sma" + ) + self.price_144d_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_144d_ema" + ) + self.price_144d_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_144d_sma" + ) + self.price_1m_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_1m_ema" + ) + self.price_1m_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_1m_sma" + ) + self.price_1w_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_1w_ema" + ) + self.price_1w_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_1w_sma" + ) + self.price_1y_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_1y_ema" + ) + self.price_1y_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_1y_sma" + ) + self.price_200d_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_200d_ema" + ) + self.price_200d_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_200d_sma" + ) + self.price_200d_sma_x0_8: MetricPattern4[Dollars] = MetricPattern4( + client, "price_200d_sma_x0_8" + ) + self.price_200d_sma_x2_4: MetricPattern4[Dollars] = MetricPattern4( + client, "price_200d_sma_x2_4" + ) + self.price_200w_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_200w_ema" + ) + self.price_200w_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_200w_sma" + ) + self.price_21d_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_21d_ema" + ) + self.price_21d_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_21d_sma" + ) + self.price_26d_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_26d_ema" + ) + self.price_2y_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_2y_ema" + ) + self.price_2y_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_2y_sma" + ) + self.price_34d_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_34d_ema" + ) + self.price_34d_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_34d_sma" + ) + self.price_350d_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_350d_sma" + ) + self.price_350d_sma_x2: MetricPattern4[Dollars] = MetricPattern4( + client, "price_350d_sma_x2" + ) + self.price_4y_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_4y_ema" + ) + self.price_4y_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_4y_sma" + ) + self.price_55d_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_55d_ema" + ) + self.price_55d_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_55d_sma" + ) + self.price_89d_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_89d_ema" + ) + self.price_89d_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_89d_sma" + ) + self.price_8d_ema: Price111dSmaPattern = Price111dSmaPattern( + client, "price_8d_ema" + ) + self.price_8d_sma: Price111dSmaPattern = Price111dSmaPattern( + client, "price_8d_sma" + ) + class MetricsTree_Market_Range: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.price_1m_max: MetricPattern4[Dollars] = MetricPattern4(client, 'price_1m_max') - self.price_1m_min: MetricPattern4[Dollars] = MetricPattern4(client, 'price_1m_min') - self.price_1w_max: MetricPattern4[Dollars] = MetricPattern4(client, 'price_1w_max') - self.price_1w_min: MetricPattern4[Dollars] = MetricPattern4(client, 'price_1w_min') - self.price_1y_max: MetricPattern4[Dollars] = MetricPattern4(client, 'price_1y_max') - self.price_1y_min: MetricPattern4[Dollars] = MetricPattern4(client, 'price_1y_min') - self.price_2w_choppiness_index: MetricPattern4[StoredF32] = MetricPattern4(client, 'price_2w_choppiness_index') - self.price_2w_max: MetricPattern4[Dollars] = MetricPattern4(client, 'price_2w_max') - self.price_2w_min: MetricPattern4[Dollars] = MetricPattern4(client, 'price_2w_min') - self.price_true_range: MetricPattern6[StoredF32] = MetricPattern6(client, 'price_true_range') - self.price_true_range_2w_sum: MetricPattern6[StoredF32] = MetricPattern6(client, 'price_true_range_2w_sum') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.price_1m_max: MetricPattern4[Dollars] = MetricPattern4( + client, "price_1m_max" + ) + self.price_1m_min: MetricPattern4[Dollars] = MetricPattern4( + client, "price_1m_min" + ) + self.price_1w_max: MetricPattern4[Dollars] = MetricPattern4( + client, "price_1w_max" + ) + self.price_1w_min: MetricPattern4[Dollars] = MetricPattern4( + client, "price_1w_min" + ) + self.price_1y_max: MetricPattern4[Dollars] = MetricPattern4( + client, "price_1y_max" + ) + self.price_1y_min: MetricPattern4[Dollars] = MetricPattern4( + client, "price_1y_min" + ) + self.price_2w_choppiness_index: MetricPattern4[StoredF32] = MetricPattern4( + client, "price_2w_choppiness_index" + ) + self.price_2w_max: MetricPattern4[Dollars] = MetricPattern4( + client, "price_2w_max" + ) + self.price_2w_min: MetricPattern4[Dollars] = MetricPattern4( + client, "price_2w_min" + ) + self.price_true_range: MetricPattern6[StoredF32] = MetricPattern6( + client, "price_true_range" + ) + self.price_true_range_2w_sum: MetricPattern6[StoredF32] = MetricPattern6( + client, "price_true_range_2w_sum" + ) + class MetricsTree_Market_Returns_PriceReturns: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._10y: MetricPattern4[StoredF32] = MetricPattern4(client, '10y_price_returns') - self._1d: MetricPattern4[StoredF32] = MetricPattern4(client, '1d_price_returns') - self._1m: MetricPattern4[StoredF32] = MetricPattern4(client, '1m_price_returns') - self._1w: MetricPattern4[StoredF32] = MetricPattern4(client, '1w_price_returns') - self._1y: MetricPattern4[StoredF32] = MetricPattern4(client, '1y_price_returns') - self._2y: MetricPattern4[StoredF32] = MetricPattern4(client, '2y_price_returns') - self._3m: MetricPattern4[StoredF32] = MetricPattern4(client, '3m_price_returns') - self._3y: MetricPattern4[StoredF32] = MetricPattern4(client, '3y_price_returns') - self._4y: MetricPattern4[StoredF32] = MetricPattern4(client, '4y_price_returns') - self._5y: MetricPattern4[StoredF32] = MetricPattern4(client, '5y_price_returns') - self._6m: MetricPattern4[StoredF32] = MetricPattern4(client, '6m_price_returns') - self._6y: MetricPattern4[StoredF32] = MetricPattern4(client, '6y_price_returns') - self._8y: MetricPattern4[StoredF32] = MetricPattern4(client, '8y_price_returns') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._10y: MetricPattern4[StoredF32] = MetricPattern4( + client, "10y_price_returns" + ) + self._1d: MetricPattern4[StoredF32] = MetricPattern4(client, "1d_price_returns") + self._1m: MetricPattern4[StoredF32] = MetricPattern4(client, "1m_price_returns") + self._1w: MetricPattern4[StoredF32] = MetricPattern4(client, "1w_price_returns") + self._1y: MetricPattern4[StoredF32] = MetricPattern4(client, "1y_price_returns") + self._2y: MetricPattern4[StoredF32] = MetricPattern4(client, "2y_price_returns") + self._3m: MetricPattern4[StoredF32] = MetricPattern4(client, "3m_price_returns") + self._3y: MetricPattern4[StoredF32] = MetricPattern4(client, "3y_price_returns") + self._4y: MetricPattern4[StoredF32] = MetricPattern4(client, "4y_price_returns") + self._5y: MetricPattern4[StoredF32] = MetricPattern4(client, "5y_price_returns") + self._6m: MetricPattern4[StoredF32] = MetricPattern4(client, "6m_price_returns") + self._6y: MetricPattern4[StoredF32] = MetricPattern4(client, "6y_price_returns") + self._8y: MetricPattern4[StoredF32] = MetricPattern4(client, "8y_price_returns") + class MetricsTree_Market_Returns: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self._1d_returns_1m_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern(client, '1d_returns_1m_sd') - self._1d_returns_1w_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern(client, '1d_returns_1w_sd') - self._1d_returns_1y_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern(client, '1d_returns_1y_sd') - self.cagr: PeriodCagrPattern = PeriodCagrPattern(client, 'cagr') - self.downside_1m_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern(client, 'downside_1m_sd') - self.downside_1w_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern(client, 'downside_1w_sd') - self.downside_1y_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern(client, 'downside_1y_sd') - self.downside_returns: MetricPattern6[StoredF32] = MetricPattern6(client, 'downside_returns') - self.price_returns: MetricsTree_Market_Returns_PriceReturns = MetricsTree_Market_Returns_PriceReturns(client) + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self._1d_returns_1m_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern( + client, "1d_returns_1m_sd" + ) + self._1d_returns_1w_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern( + client, "1d_returns_1w_sd" + ) + self._1d_returns_1y_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern( + client, "1d_returns_1y_sd" + ) + self.cagr: PeriodCagrPattern = PeriodCagrPattern(client, "cagr") + self.downside_1m_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern( + client, "downside_1m_sd" + ) + self.downside_1w_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern( + client, "downside_1w_sd" + ) + self.downside_1y_sd: _1dReturns1mSdPattern = _1dReturns1mSdPattern( + client, "downside_1y_sd" + ) + self.downside_returns: MetricPattern6[StoredF32] = MetricPattern6( + client, "downside_returns" + ) + self.price_returns: MetricsTree_Market_Returns_PriceReturns = ( + MetricsTree_Market_Returns_PriceReturns(client) + ) + class MetricsTree_Market_Volatility: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.price_1m_volatility: MetricPattern4[StoredF32] = MetricPattern4(client, 'price_1m_volatility') - self.price_1w_volatility: MetricPattern4[StoredF32] = MetricPattern4(client, 'price_1w_volatility') - self.price_1y_volatility: MetricPattern4[StoredF32] = MetricPattern4(client, 'price_1y_volatility') - self.sharpe_1m: MetricPattern6[StoredF32] = MetricPattern6(client, 'sharpe_1m') - self.sharpe_1w: MetricPattern6[StoredF32] = MetricPattern6(client, 'sharpe_1w') - self.sharpe_1y: MetricPattern6[StoredF32] = MetricPattern6(client, 'sharpe_1y') - self.sortino_1m: MetricPattern6[StoredF32] = MetricPattern6(client, 'sortino_1m') - self.sortino_1w: MetricPattern6[StoredF32] = MetricPattern6(client, 'sortino_1w') - self.sortino_1y: MetricPattern6[StoredF32] = MetricPattern6(client, 'sortino_1y') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.price_1m_volatility: MetricPattern4[StoredF32] = MetricPattern4( + client, "price_1m_volatility" + ) + self.price_1w_volatility: MetricPattern4[StoredF32] = MetricPattern4( + client, "price_1w_volatility" + ) + self.price_1y_volatility: MetricPattern4[StoredF32] = MetricPattern4( + client, "price_1y_volatility" + ) + self.sharpe_1m: MetricPattern6[StoredF32] = MetricPattern6(client, "sharpe_1m") + self.sharpe_1w: MetricPattern6[StoredF32] = MetricPattern6(client, "sharpe_1w") + self.sharpe_1y: MetricPattern6[StoredF32] = MetricPattern6(client, "sharpe_1y") + self.sortino_1m: MetricPattern6[StoredF32] = MetricPattern6( + client, "sortino_1m" + ) + self.sortino_1w: MetricPattern6[StoredF32] = MetricPattern6( + client, "sortino_1w" + ) + self.sortino_1y: MetricPattern6[StoredF32] = MetricPattern6( + client, "sortino_1y" + ) + class MetricsTree_Market: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): + + def __init__(self, client: BrkClientBase, base_path: str = ""): self.ath: MetricsTree_Market_Ath = MetricsTree_Market_Ath(client) self.dca: MetricsTree_Market_Dca = MetricsTree_Market_Dca(client) - self.indicators: MetricsTree_Market_Indicators = MetricsTree_Market_Indicators(client) - self.lookback: LookbackPattern[Dollars] = LookbackPattern(client, 'price') - self.moving_average: MetricsTree_Market_MovingAverage = MetricsTree_Market_MovingAverage(client) + self.indicators: MetricsTree_Market_Indicators = MetricsTree_Market_Indicators( + client + ) + self.lookback: LookbackPattern[Dollars] = LookbackPattern(client, "price") + self.moving_average: MetricsTree_Market_MovingAverage = ( + MetricsTree_Market_MovingAverage(client) + ) self.range: MetricsTree_Market_Range = MetricsTree_Market_Range(client) self.returns: MetricsTree_Market_Returns = MetricsTree_Market_Returns(client) - self.volatility: MetricsTree_Market_Volatility = MetricsTree_Market_Volatility(client) + self.volatility: MetricsTree_Market_Volatility = MetricsTree_Market_Volatility( + client + ) + class MetricsTree_Outputs_Count: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.total_count: CountPattern2[StoredU64] = CountPattern2(client, 'output_count') - self.utxo_count: MetricPattern1[StoredU64] = MetricPattern1(client, 'exact_utxo_count') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.total_count: CountPattern2[StoredU64] = CountPattern2( + client, "output_count" + ) + self.utxo_count: MetricPattern1[StoredU64] = MetricPattern1( + client, "exact_utxo_count" + ) + class MetricsTree_Outputs_Spent: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.txinindex: MetricPattern15[TxInIndex] = MetricPattern15(client, 'txinindex') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.txinindex: MetricPattern15[TxInIndex] = MetricPattern15( + client, "txinindex" + ) + class MetricsTree_Outputs: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): + + def __init__(self, client: BrkClientBase, base_path: str = ""): self.count: MetricsTree_Outputs_Count = MetricsTree_Outputs_Count(client) - self.first_txoutindex: MetricPattern11[TxOutIndex] = MetricPattern11(client, 'first_txoutindex') - self.outputtype: MetricPattern15[OutputType] = MetricPattern15(client, 'outputtype') + self.first_txoutindex: MetricPattern11[TxOutIndex] = MetricPattern11( + client, "first_txoutindex" + ) + self.outputtype: MetricPattern15[OutputType] = MetricPattern15( + client, "outputtype" + ) self.spent: MetricsTree_Outputs_Spent = MetricsTree_Outputs_Spent(client) - self.txindex: MetricPattern15[TxIndex] = MetricPattern15(client, 'txindex') - self.typeindex: MetricPattern15[TypeIndex] = MetricPattern15(client, 'typeindex') - self.value: MetricPattern15[Sats] = MetricPattern15(client, 'value') + self.txindex: MetricPattern15[TxIndex] = MetricPattern15(client, "txindex") + self.typeindex: MetricPattern15[TypeIndex] = MetricPattern15( + client, "typeindex" + ) + self.value: MetricPattern15[Sats] = MetricPattern15(client, "value") + class MetricsTree_Pools_Vecs: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.aaopool: AaopoolPattern = AaopoolPattern(client, 'aaopool') - self.antpool: AaopoolPattern = AaopoolPattern(client, 'antpool') - self.arkpool: AaopoolPattern = AaopoolPattern(client, 'arkpool') - self.asicminer: AaopoolPattern = AaopoolPattern(client, 'asicminer') - self.axbt: AaopoolPattern = AaopoolPattern(client, 'axbt') - self.batpool: AaopoolPattern = AaopoolPattern(client, 'batpool') - self.bcmonster: AaopoolPattern = AaopoolPattern(client, 'bcmonster') - self.bcpoolio: AaopoolPattern = AaopoolPattern(client, 'bcpoolio') - self.binancepool: AaopoolPattern = AaopoolPattern(client, 'binancepool') - self.bitalo: AaopoolPattern = AaopoolPattern(client, 'bitalo') - self.bitclub: AaopoolPattern = AaopoolPattern(client, 'bitclub') - self.bitcoinaffiliatenetwork: AaopoolPattern = AaopoolPattern(client, 'bitcoinaffiliatenetwork') - self.bitcoincom: AaopoolPattern = AaopoolPattern(client, 'bitcoincom') - self.bitcoinindia: AaopoolPattern = AaopoolPattern(client, 'bitcoinindia') - self.bitcoinrussia: AaopoolPattern = AaopoolPattern(client, 'bitcoinrussia') - self.bitcoinukraine: AaopoolPattern = AaopoolPattern(client, 'bitcoinukraine') - self.bitfarms: AaopoolPattern = AaopoolPattern(client, 'bitfarms') - self.bitfufupool: AaopoolPattern = AaopoolPattern(client, 'bitfufupool') - self.bitfury: AaopoolPattern = AaopoolPattern(client, 'bitfury') - self.bitminter: AaopoolPattern = AaopoolPattern(client, 'bitminter') - self.bitparking: AaopoolPattern = AaopoolPattern(client, 'bitparking') - self.bitsolo: AaopoolPattern = AaopoolPattern(client, 'bitsolo') - self.bixin: AaopoolPattern = AaopoolPattern(client, 'bixin') - self.blockfills: AaopoolPattern = AaopoolPattern(client, 'blockfills') - self.braiinspool: AaopoolPattern = AaopoolPattern(client, 'braiinspool') - self.bravomining: AaopoolPattern = AaopoolPattern(client, 'bravomining') - self.btcc: AaopoolPattern = AaopoolPattern(client, 'btcc') - self.btccom: AaopoolPattern = AaopoolPattern(client, 'btccom') - self.btcdig: AaopoolPattern = AaopoolPattern(client, 'btcdig') - self.btcguild: AaopoolPattern = AaopoolPattern(client, 'btcguild') - self.btclab: AaopoolPattern = AaopoolPattern(client, 'btclab') - self.btcmp: AaopoolPattern = AaopoolPattern(client, 'btcmp') - self.btcnuggets: AaopoolPattern = AaopoolPattern(client, 'btcnuggets') - self.btcpoolparty: AaopoolPattern = AaopoolPattern(client, 'btcpoolparty') - self.btcserv: AaopoolPattern = AaopoolPattern(client, 'btcserv') - self.btctop: AaopoolPattern = AaopoolPattern(client, 'btctop') - self.btpool: AaopoolPattern = AaopoolPattern(client, 'btpool') - self.bwpool: AaopoolPattern = AaopoolPattern(client, 'bwpool') - self.bytepool: AaopoolPattern = AaopoolPattern(client, 'bytepool') - self.canoe: AaopoolPattern = AaopoolPattern(client, 'canoe') - self.canoepool: AaopoolPattern = AaopoolPattern(client, 'canoepool') - self.carbonnegative: AaopoolPattern = AaopoolPattern(client, 'carbonnegative') - self.ckpool: AaopoolPattern = AaopoolPattern(client, 'ckpool') - self.cloudhashing: AaopoolPattern = AaopoolPattern(client, 'cloudhashing') - self.coinlab: AaopoolPattern = AaopoolPattern(client, 'coinlab') - self.cointerra: AaopoolPattern = AaopoolPattern(client, 'cointerra') - self.connectbtc: AaopoolPattern = AaopoolPattern(client, 'connectbtc') - self.dcex: AaopoolPattern = AaopoolPattern(client, 'dcex') - self.dcexploration: AaopoolPattern = AaopoolPattern(client, 'dcexploration') - self.digitalbtc: AaopoolPattern = AaopoolPattern(client, 'digitalbtc') - self.digitalxmintsy: AaopoolPattern = AaopoolPattern(client, 'digitalxmintsy') - self.dpool: AaopoolPattern = AaopoolPattern(client, 'dpool') - self.eclipsemc: AaopoolPattern = AaopoolPattern(client, 'eclipsemc') - self.eightbaochi: AaopoolPattern = AaopoolPattern(client, 'eightbaochi') - self.ekanembtc: AaopoolPattern = AaopoolPattern(client, 'ekanembtc') - self.eligius: AaopoolPattern = AaopoolPattern(client, 'eligius') - self.emcdpool: AaopoolPattern = AaopoolPattern(client, 'emcdpool') - self.entrustcharitypool: AaopoolPattern = AaopoolPattern(client, 'entrustcharitypool') - self.eobot: AaopoolPattern = AaopoolPattern(client, 'eobot') - self.exxbw: AaopoolPattern = AaopoolPattern(client, 'exxbw') - self.f2pool: AaopoolPattern = AaopoolPattern(client, 'f2pool') - self.fiftyeightcoin: AaopoolPattern = AaopoolPattern(client, 'fiftyeightcoin') - self.foundryusa: AaopoolPattern = AaopoolPattern(client, 'foundryusa') - self.futurebitapollosolo: AaopoolPattern = AaopoolPattern(client, 'futurebitapollosolo') - self.gbminers: AaopoolPattern = AaopoolPattern(client, 'gbminers') - self.ghashio: AaopoolPattern = AaopoolPattern(client, 'ghashio') - self.givemecoins: AaopoolPattern = AaopoolPattern(client, 'givemecoins') - self.gogreenlight: AaopoolPattern = AaopoolPattern(client, 'gogreenlight') - self.haominer: AaopoolPattern = AaopoolPattern(client, 'haominer') - self.haozhuzhu: AaopoolPattern = AaopoolPattern(client, 'haozhuzhu') - self.hashbx: AaopoolPattern = AaopoolPattern(client, 'hashbx') - self.hashpool: AaopoolPattern = AaopoolPattern(client, 'hashpool') - self.helix: AaopoolPattern = AaopoolPattern(client, 'helix') - self.hhtt: AaopoolPattern = AaopoolPattern(client, 'hhtt') - self.hotpool: AaopoolPattern = AaopoolPattern(client, 'hotpool') - self.hummerpool: AaopoolPattern = AaopoolPattern(client, 'hummerpool') - self.huobipool: AaopoolPattern = AaopoolPattern(client, 'huobipool') - self.innopolistech: AaopoolPattern = AaopoolPattern(client, 'innopolistech') - self.kanopool: AaopoolPattern = AaopoolPattern(client, 'kanopool') - self.kncminer: AaopoolPattern = AaopoolPattern(client, 'kncminer') - self.kucoinpool: AaopoolPattern = AaopoolPattern(client, 'kucoinpool') - self.lubiancom: AaopoolPattern = AaopoolPattern(client, 'lubiancom') - self.luckypool: AaopoolPattern = AaopoolPattern(client, 'luckypool') - self.luxor: AaopoolPattern = AaopoolPattern(client, 'luxor') - self.marapool: AaopoolPattern = AaopoolPattern(client, 'marapool') - self.maxbtc: AaopoolPattern = AaopoolPattern(client, 'maxbtc') - self.maxipool: AaopoolPattern = AaopoolPattern(client, 'maxipool') - self.megabigpower: AaopoolPattern = AaopoolPattern(client, 'megabigpower') - self.minerium: AaopoolPattern = AaopoolPattern(client, 'minerium') - self.miningcity: AaopoolPattern = AaopoolPattern(client, 'miningcity') - self.miningdutch: AaopoolPattern = AaopoolPattern(client, 'miningdutch') - self.miningkings: AaopoolPattern = AaopoolPattern(client, 'miningkings') - self.miningsquared: AaopoolPattern = AaopoolPattern(client, 'miningsquared') - self.mmpool: AaopoolPattern = AaopoolPattern(client, 'mmpool') - self.mtred: AaopoolPattern = AaopoolPattern(client, 'mtred') - self.multicoinco: AaopoolPattern = AaopoolPattern(client, 'multicoinco') - self.multipool: AaopoolPattern = AaopoolPattern(client, 'multipool') - self.mybtccoinpool: AaopoolPattern = AaopoolPattern(client, 'mybtccoinpool') - self.neopool: AaopoolPattern = AaopoolPattern(client, 'neopool') - self.nexious: AaopoolPattern = AaopoolPattern(client, 'nexious') - self.nicehash: AaopoolPattern = AaopoolPattern(client, 'nicehash') - self.nmcbit: AaopoolPattern = AaopoolPattern(client, 'nmcbit') - self.novablock: AaopoolPattern = AaopoolPattern(client, 'novablock') - self.ocean: AaopoolPattern = AaopoolPattern(client, 'ocean') - self.okexpool: AaopoolPattern = AaopoolPattern(client, 'okexpool') - self.okkong: AaopoolPattern = AaopoolPattern(client, 'okkong') - self.okminer: AaopoolPattern = AaopoolPattern(client, 'okminer') - self.okpooltop: AaopoolPattern = AaopoolPattern(client, 'okpooltop') - self.onehash: AaopoolPattern = AaopoolPattern(client, 'onehash') - self.onem1x: AaopoolPattern = AaopoolPattern(client, 'onem1x') - self.onethash: AaopoolPattern = AaopoolPattern(client, 'onethash') - self.ozcoin: AaopoolPattern = AaopoolPattern(client, 'ozcoin') - self.parasite: AaopoolPattern = AaopoolPattern(client, 'parasite') - self.patels: AaopoolPattern = AaopoolPattern(client, 'patels') - self.pegapool: AaopoolPattern = AaopoolPattern(client, 'pegapool') - self.phashio: AaopoolPattern = AaopoolPattern(client, 'phashio') - self.phoenix: AaopoolPattern = AaopoolPattern(client, 'phoenix') - self.polmine: AaopoolPattern = AaopoolPattern(client, 'polmine') - self.pool175btc: AaopoolPattern = AaopoolPattern(client, 'pool175btc') - self.pool50btc: AaopoolPattern = AaopoolPattern(client, 'pool50btc') - self.poolin: AaopoolPattern = AaopoolPattern(client, 'poolin') - self.portlandhodl: AaopoolPattern = AaopoolPattern(client, 'portlandhodl') - self.publicpool: AaopoolPattern = AaopoolPattern(client, 'publicpool') - self.purebtccom: AaopoolPattern = AaopoolPattern(client, 'purebtccom') - self.rawpool: AaopoolPattern = AaopoolPattern(client, 'rawpool') - self.rigpool: AaopoolPattern = AaopoolPattern(client, 'rigpool') - self.sbicrypto: AaopoolPattern = AaopoolPattern(client, 'sbicrypto') - self.secpool: AaopoolPattern = AaopoolPattern(client, 'secpool') - self.secretsuperstar: AaopoolPattern = AaopoolPattern(client, 'secretsuperstar') - self.sevenpool: AaopoolPattern = AaopoolPattern(client, 'sevenpool') - self.shawnp0wers: AaopoolPattern = AaopoolPattern(client, 'shawnp0wers') - self.sigmapoolcom: AaopoolPattern = AaopoolPattern(client, 'sigmapoolcom') - self.simplecoinus: AaopoolPattern = AaopoolPattern(client, 'simplecoinus') - self.solock: AaopoolPattern = AaopoolPattern(client, 'solock') - self.spiderpool: AaopoolPattern = AaopoolPattern(client, 'spiderpool') - self.stminingcorp: AaopoolPattern = AaopoolPattern(client, 'stminingcorp') - self.tangpool: AaopoolPattern = AaopoolPattern(client, 'tangpool') - self.tatmaspool: AaopoolPattern = AaopoolPattern(client, 'tatmaspool') - self.tbdice: AaopoolPattern = AaopoolPattern(client, 'tbdice') - self.telco214: AaopoolPattern = AaopoolPattern(client, 'telco214') - self.terrapool: AaopoolPattern = AaopoolPattern(client, 'terrapool') - self.tiger: AaopoolPattern = AaopoolPattern(client, 'tiger') - self.tigerpoolnet: AaopoolPattern = AaopoolPattern(client, 'tigerpoolnet') - self.titan: AaopoolPattern = AaopoolPattern(client, 'titan') - self.transactioncoinmining: AaopoolPattern = AaopoolPattern(client, 'transactioncoinmining') - self.trickysbtcpool: AaopoolPattern = AaopoolPattern(client, 'trickysbtcpool') - self.triplemining: AaopoolPattern = AaopoolPattern(client, 'triplemining') - self.twentyoneinc: AaopoolPattern = AaopoolPattern(client, 'twentyoneinc') - self.ultimuspool: AaopoolPattern = AaopoolPattern(client, 'ultimuspool') - self.unknown: AaopoolPattern = AaopoolPattern(client, 'unknown') - self.unomp: AaopoolPattern = AaopoolPattern(client, 'unomp') - self.viabtc: AaopoolPattern = AaopoolPattern(client, 'viabtc') - self.waterhole: AaopoolPattern = AaopoolPattern(client, 'waterhole') - self.wayicn: AaopoolPattern = AaopoolPattern(client, 'wayicn') - self.whitepool: AaopoolPattern = AaopoolPattern(client, 'whitepool') - self.wk057: AaopoolPattern = AaopoolPattern(client, 'wk057') - self.yourbtcnet: AaopoolPattern = AaopoolPattern(client, 'yourbtcnet') - self.zulupool: AaopoolPattern = AaopoolPattern(client, 'zulupool') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.aaopool: AaopoolPattern = AaopoolPattern(client, "aaopool") + self.antpool: AaopoolPattern = AaopoolPattern(client, "antpool") + self.arkpool: AaopoolPattern = AaopoolPattern(client, "arkpool") + self.asicminer: AaopoolPattern = AaopoolPattern(client, "asicminer") + self.axbt: AaopoolPattern = AaopoolPattern(client, "axbt") + self.batpool: AaopoolPattern = AaopoolPattern(client, "batpool") + self.bcmonster: AaopoolPattern = AaopoolPattern(client, "bcmonster") + self.bcpoolio: AaopoolPattern = AaopoolPattern(client, "bcpoolio") + self.binancepool: AaopoolPattern = AaopoolPattern(client, "binancepool") + self.bitalo: AaopoolPattern = AaopoolPattern(client, "bitalo") + self.bitclub: AaopoolPattern = AaopoolPattern(client, "bitclub") + self.bitcoinaffiliatenetwork: AaopoolPattern = AaopoolPattern( + client, "bitcoinaffiliatenetwork" + ) + self.bitcoincom: AaopoolPattern = AaopoolPattern(client, "bitcoincom") + self.bitcoinindia: AaopoolPattern = AaopoolPattern(client, "bitcoinindia") + self.bitcoinrussia: AaopoolPattern = AaopoolPattern(client, "bitcoinrussia") + self.bitcoinukraine: AaopoolPattern = AaopoolPattern(client, "bitcoinukraine") + self.bitfarms: AaopoolPattern = AaopoolPattern(client, "bitfarms") + self.bitfufupool: AaopoolPattern = AaopoolPattern(client, "bitfufupool") + self.bitfury: AaopoolPattern = AaopoolPattern(client, "bitfury") + self.bitminter: AaopoolPattern = AaopoolPattern(client, "bitminter") + self.bitparking: AaopoolPattern = AaopoolPattern(client, "bitparking") + self.bitsolo: AaopoolPattern = AaopoolPattern(client, "bitsolo") + self.bixin: AaopoolPattern = AaopoolPattern(client, "bixin") + self.blockfills: AaopoolPattern = AaopoolPattern(client, "blockfills") + self.braiinspool: AaopoolPattern = AaopoolPattern(client, "braiinspool") + self.bravomining: AaopoolPattern = AaopoolPattern(client, "bravomining") + self.btcc: AaopoolPattern = AaopoolPattern(client, "btcc") + self.btccom: AaopoolPattern = AaopoolPattern(client, "btccom") + self.btcdig: AaopoolPattern = AaopoolPattern(client, "btcdig") + self.btcguild: AaopoolPattern = AaopoolPattern(client, "btcguild") + self.btclab: AaopoolPattern = AaopoolPattern(client, "btclab") + self.btcmp: AaopoolPattern = AaopoolPattern(client, "btcmp") + self.btcnuggets: AaopoolPattern = AaopoolPattern(client, "btcnuggets") + self.btcpoolparty: AaopoolPattern = AaopoolPattern(client, "btcpoolparty") + self.btcserv: AaopoolPattern = AaopoolPattern(client, "btcserv") + self.btctop: AaopoolPattern = AaopoolPattern(client, "btctop") + self.btpool: AaopoolPattern = AaopoolPattern(client, "btpool") + self.bwpool: AaopoolPattern = AaopoolPattern(client, "bwpool") + self.bytepool: AaopoolPattern = AaopoolPattern(client, "bytepool") + self.canoe: AaopoolPattern = AaopoolPattern(client, "canoe") + self.canoepool: AaopoolPattern = AaopoolPattern(client, "canoepool") + self.carbonnegative: AaopoolPattern = AaopoolPattern(client, "carbonnegative") + self.ckpool: AaopoolPattern = AaopoolPattern(client, "ckpool") + self.cloudhashing: AaopoolPattern = AaopoolPattern(client, "cloudhashing") + self.coinlab: AaopoolPattern = AaopoolPattern(client, "coinlab") + self.cointerra: AaopoolPattern = AaopoolPattern(client, "cointerra") + self.connectbtc: AaopoolPattern = AaopoolPattern(client, "connectbtc") + self.dcex: AaopoolPattern = AaopoolPattern(client, "dcex") + self.dcexploration: AaopoolPattern = AaopoolPattern(client, "dcexploration") + self.digitalbtc: AaopoolPattern = AaopoolPattern(client, "digitalbtc") + self.digitalxmintsy: AaopoolPattern = AaopoolPattern(client, "digitalxmintsy") + self.dpool: AaopoolPattern = AaopoolPattern(client, "dpool") + self.eclipsemc: AaopoolPattern = AaopoolPattern(client, "eclipsemc") + self.eightbaochi: AaopoolPattern = AaopoolPattern(client, "eightbaochi") + self.ekanembtc: AaopoolPattern = AaopoolPattern(client, "ekanembtc") + self.eligius: AaopoolPattern = AaopoolPattern(client, "eligius") + self.emcdpool: AaopoolPattern = AaopoolPattern(client, "emcdpool") + self.entrustcharitypool: AaopoolPattern = AaopoolPattern( + client, "entrustcharitypool" + ) + self.eobot: AaopoolPattern = AaopoolPattern(client, "eobot") + self.exxbw: AaopoolPattern = AaopoolPattern(client, "exxbw") + self.f2pool: AaopoolPattern = AaopoolPattern(client, "f2pool") + self.fiftyeightcoin: AaopoolPattern = AaopoolPattern(client, "fiftyeightcoin") + self.foundryusa: AaopoolPattern = AaopoolPattern(client, "foundryusa") + self.futurebitapollosolo: AaopoolPattern = AaopoolPattern( + client, "futurebitapollosolo" + ) + self.gbminers: AaopoolPattern = AaopoolPattern(client, "gbminers") + self.ghashio: AaopoolPattern = AaopoolPattern(client, "ghashio") + self.givemecoins: AaopoolPattern = AaopoolPattern(client, "givemecoins") + self.gogreenlight: AaopoolPattern = AaopoolPattern(client, "gogreenlight") + self.haominer: AaopoolPattern = AaopoolPattern(client, "haominer") + self.haozhuzhu: AaopoolPattern = AaopoolPattern(client, "haozhuzhu") + self.hashbx: AaopoolPattern = AaopoolPattern(client, "hashbx") + self.hashpool: AaopoolPattern = AaopoolPattern(client, "hashpool") + self.helix: AaopoolPattern = AaopoolPattern(client, "helix") + self.hhtt: AaopoolPattern = AaopoolPattern(client, "hhtt") + self.hotpool: AaopoolPattern = AaopoolPattern(client, "hotpool") + self.hummerpool: AaopoolPattern = AaopoolPattern(client, "hummerpool") + self.huobipool: AaopoolPattern = AaopoolPattern(client, "huobipool") + self.innopolistech: AaopoolPattern = AaopoolPattern(client, "innopolistech") + self.kanopool: AaopoolPattern = AaopoolPattern(client, "kanopool") + self.kncminer: AaopoolPattern = AaopoolPattern(client, "kncminer") + self.kucoinpool: AaopoolPattern = AaopoolPattern(client, "kucoinpool") + self.lubiancom: AaopoolPattern = AaopoolPattern(client, "lubiancom") + self.luckypool: AaopoolPattern = AaopoolPattern(client, "luckypool") + self.luxor: AaopoolPattern = AaopoolPattern(client, "luxor") + self.marapool: AaopoolPattern = AaopoolPattern(client, "marapool") + self.maxbtc: AaopoolPattern = AaopoolPattern(client, "maxbtc") + self.maxipool: AaopoolPattern = AaopoolPattern(client, "maxipool") + self.megabigpower: AaopoolPattern = AaopoolPattern(client, "megabigpower") + self.minerium: AaopoolPattern = AaopoolPattern(client, "minerium") + self.miningcity: AaopoolPattern = AaopoolPattern(client, "miningcity") + self.miningdutch: AaopoolPattern = AaopoolPattern(client, "miningdutch") + self.miningkings: AaopoolPattern = AaopoolPattern(client, "miningkings") + self.miningsquared: AaopoolPattern = AaopoolPattern(client, "miningsquared") + self.mmpool: AaopoolPattern = AaopoolPattern(client, "mmpool") + self.mtred: AaopoolPattern = AaopoolPattern(client, "mtred") + self.multicoinco: AaopoolPattern = AaopoolPattern(client, "multicoinco") + self.multipool: AaopoolPattern = AaopoolPattern(client, "multipool") + self.mybtccoinpool: AaopoolPattern = AaopoolPattern(client, "mybtccoinpool") + self.neopool: AaopoolPattern = AaopoolPattern(client, "neopool") + self.nexious: AaopoolPattern = AaopoolPattern(client, "nexious") + self.nicehash: AaopoolPattern = AaopoolPattern(client, "nicehash") + self.nmcbit: AaopoolPattern = AaopoolPattern(client, "nmcbit") + self.novablock: AaopoolPattern = AaopoolPattern(client, "novablock") + self.ocean: AaopoolPattern = AaopoolPattern(client, "ocean") + self.okexpool: AaopoolPattern = AaopoolPattern(client, "okexpool") + self.okkong: AaopoolPattern = AaopoolPattern(client, "okkong") + self.okminer: AaopoolPattern = AaopoolPattern(client, "okminer") + self.okpooltop: AaopoolPattern = AaopoolPattern(client, "okpooltop") + self.onehash: AaopoolPattern = AaopoolPattern(client, "onehash") + self.onem1x: AaopoolPattern = AaopoolPattern(client, "onem1x") + self.onethash: AaopoolPattern = AaopoolPattern(client, "onethash") + self.ozcoin: AaopoolPattern = AaopoolPattern(client, "ozcoin") + self.parasite: AaopoolPattern = AaopoolPattern(client, "parasite") + self.patels: AaopoolPattern = AaopoolPattern(client, "patels") + self.pegapool: AaopoolPattern = AaopoolPattern(client, "pegapool") + self.phashio: AaopoolPattern = AaopoolPattern(client, "phashio") + self.phoenix: AaopoolPattern = AaopoolPattern(client, "phoenix") + self.polmine: AaopoolPattern = AaopoolPattern(client, "polmine") + self.pool175btc: AaopoolPattern = AaopoolPattern(client, "pool175btc") + self.pool50btc: AaopoolPattern = AaopoolPattern(client, "pool50btc") + self.poolin: AaopoolPattern = AaopoolPattern(client, "poolin") + self.portlandhodl: AaopoolPattern = AaopoolPattern(client, "portlandhodl") + self.publicpool: AaopoolPattern = AaopoolPattern(client, "publicpool") + self.purebtccom: AaopoolPattern = AaopoolPattern(client, "purebtccom") + self.rawpool: AaopoolPattern = AaopoolPattern(client, "rawpool") + self.rigpool: AaopoolPattern = AaopoolPattern(client, "rigpool") + self.sbicrypto: AaopoolPattern = AaopoolPattern(client, "sbicrypto") + self.secpool: AaopoolPattern = AaopoolPattern(client, "secpool") + self.secretsuperstar: AaopoolPattern = AaopoolPattern(client, "secretsuperstar") + self.sevenpool: AaopoolPattern = AaopoolPattern(client, "sevenpool") + self.shawnp0wers: AaopoolPattern = AaopoolPattern(client, "shawnp0wers") + self.sigmapoolcom: AaopoolPattern = AaopoolPattern(client, "sigmapoolcom") + self.simplecoinus: AaopoolPattern = AaopoolPattern(client, "simplecoinus") + self.solock: AaopoolPattern = AaopoolPattern(client, "solock") + self.spiderpool: AaopoolPattern = AaopoolPattern(client, "spiderpool") + self.stminingcorp: AaopoolPattern = AaopoolPattern(client, "stminingcorp") + self.tangpool: AaopoolPattern = AaopoolPattern(client, "tangpool") + self.tatmaspool: AaopoolPattern = AaopoolPattern(client, "tatmaspool") + self.tbdice: AaopoolPattern = AaopoolPattern(client, "tbdice") + self.telco214: AaopoolPattern = AaopoolPattern(client, "telco214") + self.terrapool: AaopoolPattern = AaopoolPattern(client, "terrapool") + self.tiger: AaopoolPattern = AaopoolPattern(client, "tiger") + self.tigerpoolnet: AaopoolPattern = AaopoolPattern(client, "tigerpoolnet") + self.titan: AaopoolPattern = AaopoolPattern(client, "titan") + self.transactioncoinmining: AaopoolPattern = AaopoolPattern( + client, "transactioncoinmining" + ) + self.trickysbtcpool: AaopoolPattern = AaopoolPattern(client, "trickysbtcpool") + self.triplemining: AaopoolPattern = AaopoolPattern(client, "triplemining") + self.twentyoneinc: AaopoolPattern = AaopoolPattern(client, "twentyoneinc") + self.ultimuspool: AaopoolPattern = AaopoolPattern(client, "ultimuspool") + self.unknown: AaopoolPattern = AaopoolPattern(client, "unknown") + self.unomp: AaopoolPattern = AaopoolPattern(client, "unomp") + self.viabtc: AaopoolPattern = AaopoolPattern(client, "viabtc") + self.waterhole: AaopoolPattern = AaopoolPattern(client, "waterhole") + self.wayicn: AaopoolPattern = AaopoolPattern(client, "wayicn") + self.whitepool: AaopoolPattern = AaopoolPattern(client, "whitepool") + self.wk057: AaopoolPattern = AaopoolPattern(client, "wk057") + self.yourbtcnet: AaopoolPattern = AaopoolPattern(client, "yourbtcnet") + self.zulupool: AaopoolPattern = AaopoolPattern(client, "zulupool") + class MetricsTree_Pools: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.height_to_pool: MetricPattern11[PoolSlug] = MetricPattern11(client, 'pool') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.height_to_pool: MetricPattern11[PoolSlug] = MetricPattern11(client, "pool") self.vecs: MetricsTree_Pools_Vecs = MetricsTree_Pools_Vecs(client) + class MetricsTree_Positions: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.block_position: MetricPattern11[BlkPosition] = MetricPattern11(client, 'position') - self.tx_position: MetricPattern27[BlkPosition] = MetricPattern27(client, 'position') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.block_position: MetricPattern11[BlkPosition] = MetricPattern11( + client, "position" + ) + self.tx_position: MetricPattern27[BlkPosition] = MetricPattern27( + client, "position" + ) + class MetricsTree_Price_Cents_Split: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.close: MetricPattern5[Cents] = MetricPattern5(client, 'price_close_cents') - self.high: MetricPattern5[Cents] = MetricPattern5(client, 'price_high_cents') - self.low: MetricPattern5[Cents] = MetricPattern5(client, 'price_low_cents') - self.open: MetricPattern5[Cents] = MetricPattern5(client, 'price_open_cents') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.close: MetricPattern5[Cents] = MetricPattern5(client, "price_close_cents") + self.high: MetricPattern5[Cents] = MetricPattern5(client, "price_high_cents") + self.low: MetricPattern5[Cents] = MetricPattern5(client, "price_low_cents") + self.open: MetricPattern5[Cents] = MetricPattern5(client, "price_open_cents") + class MetricsTree_Price_Cents: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.ohlc: MetricPattern5[OHLCCents] = MetricPattern5(client, 'ohlc_cents') - self.split: MetricsTree_Price_Cents_Split = MetricsTree_Price_Cents_Split(client) + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.ohlc: MetricPattern5[OHLCCents] = MetricPattern5(client, "ohlc_cents") + self.split: MetricsTree_Price_Cents_Split = MetricsTree_Price_Cents_Split( + client + ) + class MetricsTree_Price_Oracle: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.ohlc_cents: MetricPattern6[OHLCCents] = MetricPattern6(client, 'oracle_ohlc_cents') - self.ohlc_dollars: MetricPattern6[OHLCDollars] = MetricPattern6(client, 'oracle_ohlc') - self.price_cents: MetricPattern11[Cents] = MetricPattern11(client, 'oracle_price_cents') - self.tx_count: MetricPattern6[StoredU32] = MetricPattern6(client, 'oracle_tx_count') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.ohlc_cents: MetricPattern6[OHLCCents] = MetricPattern6( + client, "oracle_ohlc_cents" + ) + self.ohlc_dollars: MetricPattern6[OHLCDollars] = MetricPattern6( + client, "oracle_ohlc" + ) + self.price_cents: MetricPattern11[Cents] = MetricPattern11( + client, "oracle_price_cents" + ) + self.tx_count: MetricPattern6[StoredU32] = MetricPattern6( + client, "oracle_tx_count" + ) + class MetricsTree_Price_Usd: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.ohlc: MetricPattern1[OHLCDollars] = MetricPattern1(client, 'price_ohlc') - self.split: SplitPattern2[Dollars] = SplitPattern2(client, 'price') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.ohlc: MetricPattern1[OHLCDollars] = MetricPattern1(client, "price_ohlc") + self.split: SplitPattern2[Dollars] = SplitPattern2(client, "price") + class MetricsTree_Price: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): + + def __init__(self, client: BrkClientBase, base_path: str = ""): self.cents: MetricsTree_Price_Cents = MetricsTree_Price_Cents(client) self.oracle: MetricsTree_Price_Oracle = MetricsTree_Price_Oracle(client) - self.sats: SatsPattern[OHLCSats] = SatsPattern(client, 'price') + self.sats: SatsPattern[OHLCSats] = SatsPattern(client, "price") self.usd: MetricsTree_Price_Usd = MetricsTree_Price_Usd(client) + class MetricsTree_Scripts_Count: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.emptyoutput: DollarsPattern[StoredU64] = DollarsPattern(client, 'emptyoutput_count') - self.opreturn: DollarsPattern[StoredU64] = DollarsPattern(client, 'opreturn_count') - self.p2a: DollarsPattern[StoredU64] = DollarsPattern(client, 'p2a_count') - self.p2ms: DollarsPattern[StoredU64] = DollarsPattern(client, 'p2ms_count') - self.p2pk33: DollarsPattern[StoredU64] = DollarsPattern(client, 'p2pk33_count') - self.p2pk65: DollarsPattern[StoredU64] = DollarsPattern(client, 'p2pk65_count') - self.p2pkh: DollarsPattern[StoredU64] = DollarsPattern(client, 'p2pkh_count') - self.p2sh: DollarsPattern[StoredU64] = DollarsPattern(client, 'p2sh_count') - self.p2tr: DollarsPattern[StoredU64] = DollarsPattern(client, 'p2tr_count') - self.p2wpkh: DollarsPattern[StoredU64] = DollarsPattern(client, 'p2wpkh_count') - self.p2wsh: DollarsPattern[StoredU64] = DollarsPattern(client, 'p2wsh_count') - self.segwit: DollarsPattern[StoredU64] = DollarsPattern(client, 'segwit_count') - self.segwit_adoption: SegwitAdoptionPattern = SegwitAdoptionPattern(client, 'segwit_adoption') - self.taproot_adoption: SegwitAdoptionPattern = SegwitAdoptionPattern(client, 'taproot_adoption') - self.unknownoutput: DollarsPattern[StoredU64] = DollarsPattern(client, 'unknownoutput_count') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.emptyoutput: DollarsPattern[StoredU64] = DollarsPattern( + client, "emptyoutput_count" + ) + self.opreturn: DollarsPattern[StoredU64] = DollarsPattern( + client, "opreturn_count" + ) + self.p2a: DollarsPattern[StoredU64] = DollarsPattern(client, "p2a_count") + self.p2ms: DollarsPattern[StoredU64] = DollarsPattern(client, "p2ms_count") + self.p2pk33: DollarsPattern[StoredU64] = DollarsPattern(client, "p2pk33_count") + self.p2pk65: DollarsPattern[StoredU64] = DollarsPattern(client, "p2pk65_count") + self.p2pkh: DollarsPattern[StoredU64] = DollarsPattern(client, "p2pkh_count") + self.p2sh: DollarsPattern[StoredU64] = DollarsPattern(client, "p2sh_count") + self.p2tr: DollarsPattern[StoredU64] = DollarsPattern(client, "p2tr_count") + self.p2wpkh: DollarsPattern[StoredU64] = DollarsPattern(client, "p2wpkh_count") + self.p2wsh: DollarsPattern[StoredU64] = DollarsPattern(client, "p2wsh_count") + self.segwit: DollarsPattern[StoredU64] = DollarsPattern(client, "segwit_count") + self.segwit_adoption: SegwitAdoptionPattern = SegwitAdoptionPattern( + client, "segwit_adoption" + ) + self.taproot_adoption: SegwitAdoptionPattern = SegwitAdoptionPattern( + client, "taproot_adoption" + ) + self.unknownoutput: DollarsPattern[StoredU64] = DollarsPattern( + client, "unknownoutput_count" + ) + class MetricsTree_Scripts_Value: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.opreturn: CoinbasePattern = CoinbasePattern(client, 'opreturn_value') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.opreturn: CoinbasePattern = CoinbasePattern(client, "opreturn_value") + class MetricsTree_Scripts: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): + + def __init__(self, client: BrkClientBase, base_path: str = ""): self.count: MetricsTree_Scripts_Count = MetricsTree_Scripts_Count(client) - self.empty_to_txindex: MetricPattern9[TxIndex] = MetricPattern9(client, 'txindex') - self.first_emptyoutputindex: MetricPattern11[EmptyOutputIndex] = MetricPattern11(client, 'first_emptyoutputindex') - self.first_opreturnindex: MetricPattern11[OpReturnIndex] = MetricPattern11(client, 'first_opreturnindex') - self.first_p2msoutputindex: MetricPattern11[P2MSOutputIndex] = MetricPattern11(client, 'first_p2msoutputindex') - self.first_unknownoutputindex: MetricPattern11[UnknownOutputIndex] = MetricPattern11(client, 'first_unknownoutputindex') - self.opreturn_to_txindex: MetricPattern14[TxIndex] = MetricPattern14(client, 'txindex') - self.p2ms_to_txindex: MetricPattern17[TxIndex] = MetricPattern17(client, 'txindex') - self.unknown_to_txindex: MetricPattern28[TxIndex] = MetricPattern28(client, 'txindex') + self.empty_to_txindex: MetricPattern9[TxIndex] = MetricPattern9( + client, "txindex" + ) + self.first_emptyoutputindex: MetricPattern11[EmptyOutputIndex] = ( + MetricPattern11(client, "first_emptyoutputindex") + ) + self.first_opreturnindex: MetricPattern11[OpReturnIndex] = MetricPattern11( + client, "first_opreturnindex" + ) + self.first_p2msoutputindex: MetricPattern11[P2MSOutputIndex] = MetricPattern11( + client, "first_p2msoutputindex" + ) + self.first_unknownoutputindex: MetricPattern11[UnknownOutputIndex] = ( + MetricPattern11(client, "first_unknownoutputindex") + ) + self.opreturn_to_txindex: MetricPattern14[TxIndex] = MetricPattern14( + client, "txindex" + ) + self.p2ms_to_txindex: MetricPattern17[TxIndex] = MetricPattern17( + client, "txindex" + ) + self.unknown_to_txindex: MetricPattern28[TxIndex] = MetricPattern28( + client, "txindex" + ) self.value: MetricsTree_Scripts_Value = MetricsTree_Scripts_Value(client) + class MetricsTree_Supply_Burned: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.opreturn: UnclaimedRewardsPattern = UnclaimedRewardsPattern(client, 'opreturn_supply') - self.unspendable: UnclaimedRewardsPattern = UnclaimedRewardsPattern(client, 'unspendable_supply') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.opreturn: UnclaimedRewardsPattern = UnclaimedRewardsPattern( + client, "opreturn_supply" + ) + self.unspendable: UnclaimedRewardsPattern = UnclaimedRewardsPattern( + client, "unspendable_supply" + ) + class MetricsTree_Supply_Circulating: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.bitcoin: MetricPattern3[Bitcoin] = MetricPattern3(client, 'circulating_supply_btc') - self.dollars: MetricPattern3[Dollars] = MetricPattern3(client, 'circulating_supply_usd') - self.sats: MetricPattern3[Sats] = MetricPattern3(client, 'circulating_supply') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.bitcoin: MetricPattern3[Bitcoin] = MetricPattern3( + client, "circulating_supply_btc" + ) + self.dollars: MetricPattern3[Dollars] = MetricPattern3( + client, "circulating_supply_usd" + ) + self.sats: MetricPattern3[Sats] = MetricPattern3(client, "circulating_supply") + class MetricsTree_Supply_Velocity: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.btc: MetricPattern4[StoredF64] = MetricPattern4(client, 'btc_velocity') - self.usd: MetricPattern4[StoredF64] = MetricPattern4(client, 'usd_velocity') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.btc: MetricPattern4[StoredF64] = MetricPattern4(client, "btc_velocity") + self.usd: MetricPattern4[StoredF64] = MetricPattern4(client, "usd_velocity") + class MetricsTree_Supply: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): + + def __init__(self, client: BrkClientBase, base_path: str = ""): self.burned: MetricsTree_Supply_Burned = MetricsTree_Supply_Burned(client) - self.circulating: MetricsTree_Supply_Circulating = MetricsTree_Supply_Circulating(client) - self.inflation: MetricPattern4[StoredF32] = MetricPattern4(client, 'inflation_rate') - self.market_cap: MetricPattern1[Dollars] = MetricPattern1(client, 'market_cap') + self.circulating: MetricsTree_Supply_Circulating = ( + MetricsTree_Supply_Circulating(client) + ) + self.inflation: MetricPattern4[StoredF32] = MetricPattern4( + client, "inflation_rate" + ) + self.market_cap: MetricPattern1[Dollars] = MetricPattern1(client, "market_cap") self.velocity: MetricsTree_Supply_Velocity = MetricsTree_Supply_Velocity(client) + class MetricsTree_Transactions_Count: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.is_coinbase: MetricPattern27[StoredBool] = MetricPattern27(client, 'is_coinbase') - self.tx_count: DollarsPattern[StoredU64] = DollarsPattern(client, 'tx_count') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.is_coinbase: MetricPattern27[StoredBool] = MetricPattern27( + client, "is_coinbase" + ) + self.tx_count: DollarsPattern[StoredU64] = DollarsPattern(client, "tx_count") + class MetricsTree_Transactions_Fees_Fee_Dollars: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.average: MetricPattern1[Dollars] = MetricPattern1(client, 'fee_usd_average') - self.cumulative: MetricPattern2[Dollars] = MetricPattern2(client, 'fee_usd_cumulative') - self.height_cumulative: MetricPattern11[Dollars] = MetricPattern11(client, 'fee_usd_cumulative') - self.max: MetricPattern1[Dollars] = MetricPattern1(client, 'fee_usd_max') - self.median: MetricPattern11[Dollars] = MetricPattern11(client, 'fee_usd_median') - self.min: MetricPattern1[Dollars] = MetricPattern1(client, 'fee_usd_min') - self.pct10: MetricPattern11[Dollars] = MetricPattern11(client, 'fee_usd_pct10') - self.pct25: MetricPattern11[Dollars] = MetricPattern11(client, 'fee_usd_pct25') - self.pct75: MetricPattern11[Dollars] = MetricPattern11(client, 'fee_usd_pct75') - self.pct90: MetricPattern11[Dollars] = MetricPattern11(client, 'fee_usd_pct90') - self.sum: MetricPattern1[Dollars] = MetricPattern1(client, 'fee_usd_sum') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.average: MetricPattern1[Dollars] = MetricPattern1( + client, "fee_usd_average" + ) + self.cumulative: MetricPattern2[Dollars] = MetricPattern2( + client, "fee_usd_cumulative" + ) + self.height_cumulative: MetricPattern11[Dollars] = MetricPattern11( + client, "fee_usd_cumulative" + ) + self.max: MetricPattern1[Dollars] = MetricPattern1(client, "fee_usd_max") + self.median: MetricPattern11[Dollars] = MetricPattern11( + client, "fee_usd_median" + ) + self.min: MetricPattern1[Dollars] = MetricPattern1(client, "fee_usd_min") + self.pct10: MetricPattern11[Dollars] = MetricPattern11(client, "fee_usd_pct10") + self.pct25: MetricPattern11[Dollars] = MetricPattern11(client, "fee_usd_pct25") + self.pct75: MetricPattern11[Dollars] = MetricPattern11(client, "fee_usd_pct75") + self.pct90: MetricPattern11[Dollars] = MetricPattern11(client, "fee_usd_pct90") + self.sum: MetricPattern1[Dollars] = MetricPattern1(client, "fee_usd_sum") + class MetricsTree_Transactions_Fees_Fee: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.bitcoin: CountPattern2[Bitcoin] = CountPattern2(client, 'fee_btc') - self.dollars: MetricsTree_Transactions_Fees_Fee_Dollars = MetricsTree_Transactions_Fees_Fee_Dollars(client) - self.sats: CountPattern2[Sats] = CountPattern2(client, 'fee') - self.txindex: MetricPattern27[Sats] = MetricPattern27(client, 'fee') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.bitcoin: CountPattern2[Bitcoin] = CountPattern2(client, "fee_btc") + self.dollars: MetricsTree_Transactions_Fees_Fee_Dollars = ( + MetricsTree_Transactions_Fees_Fee_Dollars(client) + ) + self.sats: CountPattern2[Sats] = CountPattern2(client, "fee") + self.txindex: MetricPattern27[Sats] = MetricPattern27(client, "fee") + class MetricsTree_Transactions_Fees: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.fee: MetricsTree_Transactions_Fees_Fee = MetricsTree_Transactions_Fees_Fee(client) - self.fee_rate: FeeRatePattern[FeeRate] = FeeRatePattern(client, 'fee_rate') - self.input_value: MetricPattern27[Sats] = MetricPattern27(client, 'input_value') - self.output_value: MetricPattern27[Sats] = MetricPattern27(client, 'output_value') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.fee: MetricsTree_Transactions_Fees_Fee = MetricsTree_Transactions_Fees_Fee( + client + ) + self.fee_rate: FeeRatePattern[FeeRate] = FeeRatePattern(client, "fee_rate") + self.input_value: MetricPattern27[Sats] = MetricPattern27(client, "input_value") + self.output_value: MetricPattern27[Sats] = MetricPattern27( + client, "output_value" + ) + class MetricsTree_Transactions_Size: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.vsize: FeeRatePattern[VSize] = FeeRatePattern(client, 'tx_vsize') - self.weight: FeeRatePattern[Weight] = FeeRatePattern(client, 'tx_weight') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.vsize: FeeRatePattern[VSize] = FeeRatePattern(client, "tx_vsize") + self.weight: FeeRatePattern[Weight] = FeeRatePattern(client, "tx_weight") + class MetricsTree_Transactions_Versions: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.v1: BlockCountPattern[StoredU64] = BlockCountPattern(client, 'tx_v1') - self.v2: BlockCountPattern[StoredU64] = BlockCountPattern(client, 'tx_v2') - self.v3: BlockCountPattern[StoredU64] = BlockCountPattern(client, 'tx_v3') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.v1: BlockCountPattern[StoredU64] = BlockCountPattern(client, "tx_v1") + self.v2: BlockCountPattern[StoredU64] = BlockCountPattern(client, "tx_v2") + self.v3: BlockCountPattern[StoredU64] = BlockCountPattern(client, "tx_v3") + class MetricsTree_Transactions_Volume: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.annualized_volume: _2015Pattern = _2015Pattern(client, 'annualized_volume') - self.inputs_per_sec: MetricPattern4[StoredF32] = MetricPattern4(client, 'inputs_per_sec') - self.outputs_per_sec: MetricPattern4[StoredF32] = MetricPattern4(client, 'outputs_per_sec') - self.sent_sum: ActiveSupplyPattern = ActiveSupplyPattern(client, 'sent_sum') - self.tx_per_sec: MetricPattern4[StoredF32] = MetricPattern4(client, 'tx_per_sec') + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.annualized_volume: _2015Pattern = _2015Pattern(client, "annualized_volume") + self.inputs_per_sec: MetricPattern4[StoredF32] = MetricPattern4( + client, "inputs_per_sec" + ) + self.outputs_per_sec: MetricPattern4[StoredF32] = MetricPattern4( + client, "outputs_per_sec" + ) + self.sent_sum: ActiveSupplyPattern = ActiveSupplyPattern(client, "sent_sum") + self.tx_per_sec: MetricPattern4[StoredF32] = MetricPattern4( + client, "tx_per_sec" + ) + class MetricsTree_Transactions: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): - self.base_size: MetricPattern27[StoredU32] = MetricPattern27(client, 'base_size') - self.count: MetricsTree_Transactions_Count = MetricsTree_Transactions_Count(client) + + def __init__(self, client: BrkClientBase, base_path: str = ""): + self.base_size: MetricPattern27[StoredU32] = MetricPattern27( + client, "base_size" + ) + self.count: MetricsTree_Transactions_Count = MetricsTree_Transactions_Count( + client + ) self.fees: MetricsTree_Transactions_Fees = MetricsTree_Transactions_Fees(client) - self.first_txindex: MetricPattern11[TxIndex] = MetricPattern11(client, 'first_txindex') - self.first_txinindex: MetricPattern27[TxInIndex] = MetricPattern27(client, 'first_txinindex') - self.first_txoutindex: MetricPattern27[TxOutIndex] = MetricPattern27(client, 'first_txoutindex') - self.height: MetricPattern27[Height] = MetricPattern27(client, 'height') - self.is_explicitly_rbf: MetricPattern27[StoredBool] = MetricPattern27(client, 'is_explicitly_rbf') - self.rawlocktime: MetricPattern27[RawLockTime] = MetricPattern27(client, 'rawlocktime') + self.first_txindex: MetricPattern11[TxIndex] = MetricPattern11( + client, "first_txindex" + ) + self.first_txinindex: MetricPattern27[TxInIndex] = MetricPattern27( + client, "first_txinindex" + ) + self.first_txoutindex: MetricPattern27[TxOutIndex] = MetricPattern27( + client, "first_txoutindex" + ) + self.height: MetricPattern27[Height] = MetricPattern27(client, "height") + self.is_explicitly_rbf: MetricPattern27[StoredBool] = MetricPattern27( + client, "is_explicitly_rbf" + ) + self.rawlocktime: MetricPattern27[RawLockTime] = MetricPattern27( + client, "rawlocktime" + ) self.size: MetricsTree_Transactions_Size = MetricsTree_Transactions_Size(client) - self.total_size: MetricPattern27[StoredU32] = MetricPattern27(client, 'total_size') - self.txid: MetricPattern27[Txid] = MetricPattern27(client, 'txid') - self.txversion: MetricPattern27[TxVersion] = MetricPattern27(client, 'txversion') - self.versions: MetricsTree_Transactions_Versions = MetricsTree_Transactions_Versions(client) - self.volume: MetricsTree_Transactions_Volume = MetricsTree_Transactions_Volume(client) + self.total_size: MetricPattern27[StoredU32] = MetricPattern27( + client, "total_size" + ) + self.txid: MetricPattern27[Txid] = MetricPattern27(client, "txid") + self.txversion: MetricPattern27[TxVersion] = MetricPattern27( + client, "txversion" + ) + self.versions: MetricsTree_Transactions_Versions = ( + MetricsTree_Transactions_Versions(client) + ) + self.volume: MetricsTree_Transactions_Volume = MetricsTree_Transactions_Volume( + client + ) + class MetricsTree: """Metrics tree node.""" - - def __init__(self, client: BrkClientBase, base_path: str = ''): + + def __init__(self, client: BrkClientBase, base_path: str = ""): self.addresses: MetricsTree_Addresses = MetricsTree_Addresses(client) self.blocks: MetricsTree_Blocks = MetricsTree_Blocks(client) self.cointime: MetricsTree_Cointime = MetricsTree_Cointime(client) @@ -3842,903 +6221,644 @@ class MetricsTree: self.supply: MetricsTree_Supply = MetricsTree_Supply(client) self.transactions: MetricsTree_Transactions = MetricsTree_Transactions(client) + class BrkClient(BrkClientBase): """Main BRK client with metrics tree and API methods.""" VERSION = "v0.1.0-alpha.2" INDEXES = [ - "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", - "loadedaddressindex", - "emptyaddressindex" + "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", + "loadedaddressindex", + "emptyaddressindex", ] POOL_ID_TO_POOL_NAME = { - "aaopool": "AAO Pool", - "antpool": "AntPool", - "arkpool": "ArkPool", - "asicminer": "ASICMiner", - "axbt": "A-XBT", - "batpool": "BATPOOL", - "bcmonster": "BCMonster", - "bcpoolio": "bcpool.io", - "binancepool": "Binance Pool", - "bitalo": "Bitalo", - "bitclub": "BitClub", - "bitcoinaffiliatenetwork": "Bitcoin Affiliate Network", - "bitcoincom": "Bitcoin.com", - "bitcoinindia": "Bitcoin India", - "bitcoinrussia": "BitcoinRussia", - "bitcoinukraine": "Bitcoin-Ukraine", - "bitfarms": "Bitfarms", - "bitfufupool": "BitFuFuPool", - "bitfury": "BitFury", - "bitminter": "BitMinter", - "bitparking": "Bitparking", - "bitsolo": "Bitsolo", - "bixin": "Bixin", - "blockfills": "BlockFills", - "braiinspool": "Braiins Pool", - "bravomining": "Bravo Mining", - "btcc": "BTCC", - "btccom": "BTC.com", - "btcdig": "BTCDig", - "btcguild": "BTC Guild", - "btclab": "BTCLab", - "btcmp": "BTCMP", - "btcnuggets": "BTC Nuggets", - "btcpoolparty": "BTC Pool Party", - "btcserv": "BTCServ", - "btctop": "BTC.TOP", - "btpool": "BTPOOL", - "bwpool": "BWPool", - "bytepool": "BytePool", - "canoe": "CANOE", - "canoepool": "CanoePool", - "carbonnegative": "Carbon Negative", - "ckpool": "CKPool", - "cloudhashing": "CloudHashing", - "coinlab": "CoinLab", - "cointerra": "Cointerra", - "connectbtc": "ConnectBTC", - "dcex": "DCEX", - "dcexploration": "DCExploration", - "digitalbtc": "digitalBTC", - "digitalxmintsy": "digitalX Mintsy", - "dpool": "DPOOL", - "eclipsemc": "EclipseMC", - "eightbaochi": "8baochi", - "ekanembtc": "EkanemBTC", - "eligius": "Eligius", - "emcdpool": "EMCDPool", - "entrustcharitypool": "Entrust Charity Pool", - "eobot": "Eobot", - "exxbw": "EXX&BW", - "f2pool": "F2Pool", - "fiftyeightcoin": "58COIN", - "foundryusa": "Foundry USA", - "futurebitapollosolo": "FutureBit Apollo Solo", - "gbminers": "GBMiners", - "ghashio": "GHash.IO", - "givemecoins": "Give Me Coins", - "gogreenlight": "GoGreenLight", - "haominer": "haominer", - "haozhuzhu": "HAOZHUZHU", - "hashbx": "HashBX", - "hashpool": "HASHPOOL", - "helix": "Helix", - "hhtt": "HHTT", - "hotpool": "HotPool", - "hummerpool": "Hummerpool", - "huobipool": "Huobi.pool", - "innopolistech": "Innopolis Tech", - "kanopool": "KanoPool", - "kncminer": "KnCMiner", - "kucoinpool": "KuCoinPool", - "lubiancom": "Lubian.com", - "luckypool": "luckyPool", - "luxor": "Luxor", - "marapool": "MARA Pool", - "maxbtc": "MaxBTC", - "maxipool": "MaxiPool", - "megabigpower": "MegaBigPower", - "minerium": "Minerium", - "miningcity": "MiningCity", - "miningdutch": "Mining-Dutch", - "miningkings": "MiningKings", - "miningsquared": "Mining Squared", - "mmpool": "mmpool", - "mtred": "Mt Red", - "multicoinco": "MultiCoin.co", - "multipool": "Multipool", - "mybtccoinpool": "myBTCcoin Pool", - "neopool": "Neopool", - "nexious": "Nexious", - "nicehash": "NiceHash", - "nmcbit": "NMCbit", - "novablock": "NovaBlock", - "ocean": "OCEAN", - "okexpool": "OKExPool", - "okkong": "OKKONG", - "okminer": "OKMINER", - "okpooltop": "okpool.top", - "onehash": "1Hash", - "onem1x": "1M1X", - "onethash": "1THash", - "ozcoin": "OzCoin", - "parasite": "Parasite", - "patels": "Patels", - "pegapool": "PEGA Pool", - "phashio": "PHash.IO", - "phoenix": "Phoenix", - "polmine": "Polmine", - "pool175btc": "175btc", - "pool50btc": "50BTC", - "poolin": "Poolin", - "portlandhodl": "Portland.HODL", - "publicpool": "Public Pool", - "purebtccom": "PureBTC.COM", - "rawpool": "Rawpool", - "rigpool": "RigPool", - "sbicrypto": "SBI Crypto", - "secpool": "SECPOOL", - "secretsuperstar": "SecretSuperstar", - "sevenpool": "7pool", - "shawnp0wers": "shawnp0wers", - "sigmapoolcom": "Sigmapool.com", - "simplecoinus": "simplecoin.us", - "solock": "Solo CK", - "spiderpool": "SpiderPool", - "stminingcorp": "ST Mining Corp", - "tangpool": "Tangpool", - "tatmaspool": "TATMAS Pool", - "tbdice": "TBDice", - "telco214": "Telco 214", - "terrapool": "Terra Pool", - "tiger": "tiger", - "tigerpoolnet": "tigerpool.net", - "titan": "Titan", - "transactioncoinmining": "transactioncoinmining", - "trickysbtcpool": "Tricky's BTC Pool", - "triplemining": "TripleMining", - "twentyoneinc": "21 Inc.", - "ultimuspool": "ULTIMUSPOOL", - "unknown": "Unknown", - "unomp": "UNOMP", - "viabtc": "ViaBTC", - "waterhole": "Waterhole", - "wayicn": "WAYI.CN", - "whitepool": "WhitePool", - "wk057": "wk057", - "yourbtcnet": "Yourbtc.net", - "zulupool": "Zulupool" + "aaopool": "AAO Pool", + "antpool": "AntPool", + "arkpool": "ArkPool", + "asicminer": "ASICMiner", + "axbt": "A-XBT", + "batpool": "BATPOOL", + "bcmonster": "BCMonster", + "bcpoolio": "bcpool.io", + "binancepool": "Binance Pool", + "bitalo": "Bitalo", + "bitclub": "BitClub", + "bitcoinaffiliatenetwork": "Bitcoin Affiliate Network", + "bitcoincom": "Bitcoin.com", + "bitcoinindia": "Bitcoin India", + "bitcoinrussia": "BitcoinRussia", + "bitcoinukraine": "Bitcoin-Ukraine", + "bitfarms": "Bitfarms", + "bitfufupool": "BitFuFuPool", + "bitfury": "BitFury", + "bitminter": "BitMinter", + "bitparking": "Bitparking", + "bitsolo": "Bitsolo", + "bixin": "Bixin", + "blockfills": "BlockFills", + "braiinspool": "Braiins Pool", + "bravomining": "Bravo Mining", + "btcc": "BTCC", + "btccom": "BTC.com", + "btcdig": "BTCDig", + "btcguild": "BTC Guild", + "btclab": "BTCLab", + "btcmp": "BTCMP", + "btcnuggets": "BTC Nuggets", + "btcpoolparty": "BTC Pool Party", + "btcserv": "BTCServ", + "btctop": "BTC.TOP", + "btpool": "BTPOOL", + "bwpool": "BWPool", + "bytepool": "BytePool", + "canoe": "CANOE", + "canoepool": "CanoePool", + "carbonnegative": "Carbon Negative", + "ckpool": "CKPool", + "cloudhashing": "CloudHashing", + "coinlab": "CoinLab", + "cointerra": "Cointerra", + "connectbtc": "ConnectBTC", + "dcex": "DCEX", + "dcexploration": "DCExploration", + "digitalbtc": "digitalBTC", + "digitalxmintsy": "digitalX Mintsy", + "dpool": "DPOOL", + "eclipsemc": "EclipseMC", + "eightbaochi": "8baochi", + "ekanembtc": "EkanemBTC", + "eligius": "Eligius", + "emcdpool": "EMCDPool", + "entrustcharitypool": "Entrust Charity Pool", + "eobot": "Eobot", + "exxbw": "EXX&BW", + "f2pool": "F2Pool", + "fiftyeightcoin": "58COIN", + "foundryusa": "Foundry USA", + "futurebitapollosolo": "FutureBit Apollo Solo", + "gbminers": "GBMiners", + "ghashio": "GHash.IO", + "givemecoins": "Give Me Coins", + "gogreenlight": "GoGreenLight", + "haominer": "haominer", + "haozhuzhu": "HAOZHUZHU", + "hashbx": "HashBX", + "hashpool": "HASHPOOL", + "helix": "Helix", + "hhtt": "HHTT", + "hotpool": "HotPool", + "hummerpool": "Hummerpool", + "huobipool": "Huobi.pool", + "innopolistech": "Innopolis Tech", + "kanopool": "KanoPool", + "kncminer": "KnCMiner", + "kucoinpool": "KuCoinPool", + "lubiancom": "Lubian.com", + "luckypool": "luckyPool", + "luxor": "Luxor", + "marapool": "MARA Pool", + "maxbtc": "MaxBTC", + "maxipool": "MaxiPool", + "megabigpower": "MegaBigPower", + "minerium": "Minerium", + "miningcity": "MiningCity", + "miningdutch": "Mining-Dutch", + "miningkings": "MiningKings", + "miningsquared": "Mining Squared", + "mmpool": "mmpool", + "mtred": "Mt Red", + "multicoinco": "MultiCoin.co", + "multipool": "Multipool", + "mybtccoinpool": "myBTCcoin Pool", + "neopool": "Neopool", + "nexious": "Nexious", + "nicehash": "NiceHash", + "nmcbit": "NMCbit", + "novablock": "NovaBlock", + "ocean": "OCEAN", + "okexpool": "OKExPool", + "okkong": "OKKONG", + "okminer": "OKMINER", + "okpooltop": "okpool.top", + "onehash": "1Hash", + "onem1x": "1M1X", + "onethash": "1THash", + "ozcoin": "OzCoin", + "parasite": "Parasite", + "patels": "Patels", + "pegapool": "PEGA Pool", + "phashio": "PHash.IO", + "phoenix": "Phoenix", + "polmine": "Polmine", + "pool175btc": "175btc", + "pool50btc": "50BTC", + "poolin": "Poolin", + "portlandhodl": "Portland.HODL", + "publicpool": "Public Pool", + "purebtccom": "PureBTC.COM", + "rawpool": "Rawpool", + "rigpool": "RigPool", + "sbicrypto": "SBI Crypto", + "secpool": "SECPOOL", + "secretsuperstar": "SecretSuperstar", + "sevenpool": "7pool", + "shawnp0wers": "shawnp0wers", + "sigmapoolcom": "Sigmapool.com", + "simplecoinus": "simplecoin.us", + "solock": "Solo CK", + "spiderpool": "SpiderPool", + "stminingcorp": "ST Mining Corp", + "tangpool": "Tangpool", + "tatmaspool": "TATMAS Pool", + "tbdice": "TBDice", + "telco214": "Telco 214", + "terrapool": "Terra Pool", + "tiger": "tiger", + "tigerpoolnet": "tigerpool.net", + "titan": "Titan", + "transactioncoinmining": "transactioncoinmining", + "trickysbtcpool": "Tricky's BTC Pool", + "triplemining": "TripleMining", + "twentyoneinc": "21 Inc.", + "ultimuspool": "ULTIMUSPOOL", + "unknown": "Unknown", + "unomp": "UNOMP", + "viabtc": "ViaBTC", + "waterhole": "Waterhole", + "wayicn": "WAYI.CN", + "whitepool": "WhitePool", + "wk057": "wk057", + "yourbtcnet": "Yourbtc.net", + "zulupool": "Zulupool", } TERM_NAMES = { - "short": { - "id": "sth", - "short": "STH", - "long": "Short Term Holders" - }, - "long": { - "id": "lth", - "short": "LTH", - "long": "Long Term Holders" - } + "short": {"id": "sth", "short": "STH", "long": "Short Term Holders"}, + "long": {"id": "lth", "short": "LTH", "long": "Long Term Holders"}, } EPOCH_NAMES = { - "_0": { - "id": "epoch_0", - "short": "Epoch 0", - "long": "Epoch 0" - }, - "_1": { - "id": "epoch_1", - "short": "Epoch 1", - "long": "Epoch 1" - }, - "_2": { - "id": "epoch_2", - "short": "Epoch 2", - "long": "Epoch 2" - }, - "_3": { - "id": "epoch_3", - "short": "Epoch 3", - "long": "Epoch 3" - }, - "_4": { - "id": "epoch_4", - "short": "Epoch 4", - "long": "Epoch 4" - } + "_0": {"id": "epoch_0", "short": "Epoch 0", "long": "Epoch 0"}, + "_1": {"id": "epoch_1", "short": "Epoch 1", "long": "Epoch 1"}, + "_2": {"id": "epoch_2", "short": "Epoch 2", "long": "Epoch 2"}, + "_3": {"id": "epoch_3", "short": "Epoch 3", "long": "Epoch 3"}, + "_4": {"id": "epoch_4", "short": "Epoch 4", "long": "Epoch 4"}, } YEAR_NAMES = { - "_2009": { - "id": "year_2009", - "short": "2009", - "long": "Year 2009" - }, - "_2010": { - "id": "year_2010", - "short": "2010", - "long": "Year 2010" - }, - "_2011": { - "id": "year_2011", - "short": "2011", - "long": "Year 2011" - }, - "_2012": { - "id": "year_2012", - "short": "2012", - "long": "Year 2012" - }, - "_2013": { - "id": "year_2013", - "short": "2013", - "long": "Year 2013" - }, - "_2014": { - "id": "year_2014", - "short": "2014", - "long": "Year 2014" - }, - "_2015": { - "id": "year_2015", - "short": "2015", - "long": "Year 2015" - }, - "_2016": { - "id": "year_2016", - "short": "2016", - "long": "Year 2016" - }, - "_2017": { - "id": "year_2017", - "short": "2017", - "long": "Year 2017" - }, - "_2018": { - "id": "year_2018", - "short": "2018", - "long": "Year 2018" - }, - "_2019": { - "id": "year_2019", - "short": "2019", - "long": "Year 2019" - }, - "_2020": { - "id": "year_2020", - "short": "2020", - "long": "Year 2020" - }, - "_2021": { - "id": "year_2021", - "short": "2021", - "long": "Year 2021" - }, - "_2022": { - "id": "year_2022", - "short": "2022", - "long": "Year 2022" - }, - "_2023": { - "id": "year_2023", - "short": "2023", - "long": "Year 2023" - }, - "_2024": { - "id": "year_2024", - "short": "2024", - "long": "Year 2024" - }, - "_2025": { - "id": "year_2025", - "short": "2025", - "long": "Year 2025" - }, - "_2026": { - "id": "year_2026", - "short": "2026", - "long": "Year 2026" - } + "_2009": {"id": "year_2009", "short": "2009", "long": "Year 2009"}, + "_2010": {"id": "year_2010", "short": "2010", "long": "Year 2010"}, + "_2011": {"id": "year_2011", "short": "2011", "long": "Year 2011"}, + "_2012": {"id": "year_2012", "short": "2012", "long": "Year 2012"}, + "_2013": {"id": "year_2013", "short": "2013", "long": "Year 2013"}, + "_2014": {"id": "year_2014", "short": "2014", "long": "Year 2014"}, + "_2015": {"id": "year_2015", "short": "2015", "long": "Year 2015"}, + "_2016": {"id": "year_2016", "short": "2016", "long": "Year 2016"}, + "_2017": {"id": "year_2017", "short": "2017", "long": "Year 2017"}, + "_2018": {"id": "year_2018", "short": "2018", "long": "Year 2018"}, + "_2019": {"id": "year_2019", "short": "2019", "long": "Year 2019"}, + "_2020": {"id": "year_2020", "short": "2020", "long": "Year 2020"}, + "_2021": {"id": "year_2021", "short": "2021", "long": "Year 2021"}, + "_2022": {"id": "year_2022", "short": "2022", "long": "Year 2022"}, + "_2023": {"id": "year_2023", "short": "2023", "long": "Year 2023"}, + "_2024": {"id": "year_2024", "short": "2024", "long": "Year 2024"}, + "_2025": {"id": "year_2025", "short": "2025", "long": "Year 2025"}, + "_2026": {"id": "year_2026", "short": "2026", "long": "Year 2026"}, } SPENDABLE_TYPE_NAMES = { - "p2pk65": { - "id": "p2pk65", - "short": "P2PK65", - "long": "Pay to Public Key (65 bytes)" - }, - "p2pk33": { - "id": "p2pk33", - "short": "P2PK33", - "long": "Pay to Public Key (33 bytes)" - }, - "p2pkh": { - "id": "p2pkh", - "short": "P2PKH", - "long": "Pay to Public Key Hash" - }, - "p2ms": { - "id": "p2ms", - "short": "P2MS", - "long": "Pay to Multisig" - }, - "p2sh": { - "id": "p2sh", - "short": "P2SH", - "long": "Pay to Script Hash" - }, - "p2wpkh": { - "id": "p2wpkh", - "short": "P2WPKH", - "long": "Pay to Witness Public Key Hash" - }, - "p2wsh": { - "id": "p2wsh", - "short": "P2WSH", - "long": "Pay to Witness Script Hash" - }, - "p2tr": { - "id": "p2tr", - "short": "P2TR", - "long": "Pay to Taproot" - }, - "p2a": { - "id": "p2a", - "short": "P2A", - "long": "Pay to Anchor" - }, - "unknown": { - "id": "unknown_outputs", - "short": "Unknown", - "long": "Unknown Output Type" - }, - "empty": { - "id": "empty_outputs", - "short": "Empty", - "long": "Empty Output" - } + "p2pk65": { + "id": "p2pk65", + "short": "P2PK65", + "long": "Pay to Public Key (65 bytes)", + }, + "p2pk33": { + "id": "p2pk33", + "short": "P2PK33", + "long": "Pay to Public Key (33 bytes)", + }, + "p2pkh": {"id": "p2pkh", "short": "P2PKH", "long": "Pay to Public Key Hash"}, + "p2ms": {"id": "p2ms", "short": "P2MS", "long": "Pay to Multisig"}, + "p2sh": {"id": "p2sh", "short": "P2SH", "long": "Pay to Script Hash"}, + "p2wpkh": { + "id": "p2wpkh", + "short": "P2WPKH", + "long": "Pay to Witness Public Key Hash", + }, + "p2wsh": { + "id": "p2wsh", + "short": "P2WSH", + "long": "Pay to Witness Script Hash", + }, + "p2tr": {"id": "p2tr", "short": "P2TR", "long": "Pay to Taproot"}, + "p2a": {"id": "p2a", "short": "P2A", "long": "Pay to Anchor"}, + "unknown": { + "id": "unknown_outputs", + "short": "Unknown", + "long": "Unknown Output Type", + }, + "empty": {"id": "empty_outputs", "short": "Empty", "long": "Empty Output"}, } AGE_RANGE_NAMES = { - "up_to_1h": { - "id": "up_to_1h_old", - "short": "<1h", - "long": "Up to 1 Hour Old" - }, - "_1h_to_1d": { - "id": "at_least_1h_up_to_1d_old", - "short": "1h-1d", - "long": "1 Hour to 1 Day Old" - }, - "_1d_to_1w": { - "id": "at_least_1d_up_to_1w_old", - "short": "1d-1w", - "long": "1 Day to 1 Week Old" - }, - "_1w_to_1m": { - "id": "at_least_1w_up_to_1m_old", - "short": "1w-1m", - "long": "1 Week to 1 Month Old" - }, - "_1m_to_2m": { - "id": "at_least_1m_up_to_2m_old", - "short": "1m-2m", - "long": "1 to 2 Months Old" - }, - "_2m_to_3m": { - "id": "at_least_2m_up_to_3m_old", - "short": "2m-3m", - "long": "2 to 3 Months Old" - }, - "_3m_to_4m": { - "id": "at_least_3m_up_to_4m_old", - "short": "3m-4m", - "long": "3 to 4 Months Old" - }, - "_4m_to_5m": { - "id": "at_least_4m_up_to_5m_old", - "short": "4m-5m", - "long": "4 to 5 Months Old" - }, - "_5m_to_6m": { - "id": "at_least_5m_up_to_6m_old", - "short": "5m-6m", - "long": "5 to 6 Months Old" - }, - "_6m_to_1y": { - "id": "at_least_6m_up_to_1y_old", - "short": "6m-1y", - "long": "6 Months to 1 Year Old" - }, - "_1y_to_2y": { - "id": "at_least_1y_up_to_2y_old", - "short": "1y-2y", - "long": "1 to 2 Years Old" - }, - "_2y_to_3y": { - "id": "at_least_2y_up_to_3y_old", - "short": "2y-3y", - "long": "2 to 3 Years Old" - }, - "_3y_to_4y": { - "id": "at_least_3y_up_to_4y_old", - "short": "3y-4y", - "long": "3 to 4 Years Old" - }, - "_4y_to_5y": { - "id": "at_least_4y_up_to_5y_old", - "short": "4y-5y", - "long": "4 to 5 Years Old" - }, - "_5y_to_6y": { - "id": "at_least_5y_up_to_6y_old", - "short": "5y-6y", - "long": "5 to 6 Years Old" - }, - "_6y_to_7y": { - "id": "at_least_6y_up_to_7y_old", - "short": "6y-7y", - "long": "6 to 7 Years Old" - }, - "_7y_to_8y": { - "id": "at_least_7y_up_to_8y_old", - "short": "7y-8y", - "long": "7 to 8 Years Old" - }, - "_8y_to_10y": { - "id": "at_least_8y_up_to_10y_old", - "short": "8y-10y", - "long": "8 to 10 Years Old" - }, - "_10y_to_12y": { - "id": "at_least_10y_up_to_12y_old", - "short": "10y-12y", - "long": "10 to 12 Years Old" - }, - "_12y_to_15y": { - "id": "at_least_12y_up_to_15y_old", - "short": "12y-15y", - "long": "12 to 15 Years Old" - }, - "from_15y": { - "id": "at_least_15y_old", - "short": "15y+", - "long": "15+ Years Old" - } + "up_to_1h": {"id": "up_to_1h_old", "short": "<1h", "long": "Up to 1 Hour Old"}, + "_1h_to_1d": { + "id": "at_least_1h_up_to_1d_old", + "short": "1h-1d", + "long": "1 Hour to 1 Day Old", + }, + "_1d_to_1w": { + "id": "at_least_1d_up_to_1w_old", + "short": "1d-1w", + "long": "1 Day to 1 Week Old", + }, + "_1w_to_1m": { + "id": "at_least_1w_up_to_1m_old", + "short": "1w-1m", + "long": "1 Week to 1 Month Old", + }, + "_1m_to_2m": { + "id": "at_least_1m_up_to_2m_old", + "short": "1m-2m", + "long": "1 to 2 Months Old", + }, + "_2m_to_3m": { + "id": "at_least_2m_up_to_3m_old", + "short": "2m-3m", + "long": "2 to 3 Months Old", + }, + "_3m_to_4m": { + "id": "at_least_3m_up_to_4m_old", + "short": "3m-4m", + "long": "3 to 4 Months Old", + }, + "_4m_to_5m": { + "id": "at_least_4m_up_to_5m_old", + "short": "4m-5m", + "long": "4 to 5 Months Old", + }, + "_5m_to_6m": { + "id": "at_least_5m_up_to_6m_old", + "short": "5m-6m", + "long": "5 to 6 Months Old", + }, + "_6m_to_1y": { + "id": "at_least_6m_up_to_1y_old", + "short": "6m-1y", + "long": "6 Months to 1 Year Old", + }, + "_1y_to_2y": { + "id": "at_least_1y_up_to_2y_old", + "short": "1y-2y", + "long": "1 to 2 Years Old", + }, + "_2y_to_3y": { + "id": "at_least_2y_up_to_3y_old", + "short": "2y-3y", + "long": "2 to 3 Years Old", + }, + "_3y_to_4y": { + "id": "at_least_3y_up_to_4y_old", + "short": "3y-4y", + "long": "3 to 4 Years Old", + }, + "_4y_to_5y": { + "id": "at_least_4y_up_to_5y_old", + "short": "4y-5y", + "long": "4 to 5 Years Old", + }, + "_5y_to_6y": { + "id": "at_least_5y_up_to_6y_old", + "short": "5y-6y", + "long": "5 to 6 Years Old", + }, + "_6y_to_7y": { + "id": "at_least_6y_up_to_7y_old", + "short": "6y-7y", + "long": "6 to 7 Years Old", + }, + "_7y_to_8y": { + "id": "at_least_7y_up_to_8y_old", + "short": "7y-8y", + "long": "7 to 8 Years Old", + }, + "_8y_to_10y": { + "id": "at_least_8y_up_to_10y_old", + "short": "8y-10y", + "long": "8 to 10 Years Old", + }, + "_10y_to_12y": { + "id": "at_least_10y_up_to_12y_old", + "short": "10y-12y", + "long": "10 to 12 Years Old", + }, + "_12y_to_15y": { + "id": "at_least_12y_up_to_15y_old", + "short": "12y-15y", + "long": "12 to 15 Years Old", + }, + "from_15y": { + "id": "at_least_15y_old", + "short": "15y+", + "long": "15+ Years Old", + }, } MAX_AGE_NAMES = { - "_1w": { - "id": "up_to_1w_old", - "short": "<1w", - "long": "Up to 1 Week Old" - }, - "_1m": { - "id": "up_to_1m_old", - "short": "<1m", - "long": "Up to 1 Month Old" - }, - "_2m": { - "id": "up_to_2m_old", - "short": "<2m", - "long": "Up to 2 Months Old" - }, - "_3m": { - "id": "up_to_3m_old", - "short": "<3m", - "long": "Up to 3 Months Old" - }, - "_4m": { - "id": "up_to_4m_old", - "short": "<4m", - "long": "Up to 4 Months Old" - }, - "_5m": { - "id": "up_to_5m_old", - "short": "<5m", - "long": "Up to 5 Months Old" - }, - "_6m": { - "id": "up_to_6m_old", - "short": "<6m", - "long": "Up to 6 Months Old" - }, - "_1y": { - "id": "up_to_1y_old", - "short": "<1y", - "long": "Up to 1 Year Old" - }, - "_2y": { - "id": "up_to_2y_old", - "short": "<2y", - "long": "Up to 2 Years Old" - }, - "_3y": { - "id": "up_to_3y_old", - "short": "<3y", - "long": "Up to 3 Years Old" - }, - "_4y": { - "id": "up_to_4y_old", - "short": "<4y", - "long": "Up to 4 Years Old" - }, - "_5y": { - "id": "up_to_5y_old", - "short": "<5y", - "long": "Up to 5 Years Old" - }, - "_6y": { - "id": "up_to_6y_old", - "short": "<6y", - "long": "Up to 6 Years Old" - }, - "_7y": { - "id": "up_to_7y_old", - "short": "<7y", - "long": "Up to 7 Years Old" - }, - "_8y": { - "id": "up_to_8y_old", - "short": "<8y", - "long": "Up to 8 Years Old" - }, - "_10y": { - "id": "up_to_10y_old", - "short": "<10y", - "long": "Up to 10 Years Old" - }, - "_12y": { - "id": "up_to_12y_old", - "short": "<12y", - "long": "Up to 12 Years Old" - }, - "_15y": { - "id": "up_to_15y_old", - "short": "<15y", - "long": "Up to 15 Years Old" - } + "_1w": {"id": "up_to_1w_old", "short": "<1w", "long": "Up to 1 Week Old"}, + "_1m": {"id": "up_to_1m_old", "short": "<1m", "long": "Up to 1 Month Old"}, + "_2m": {"id": "up_to_2m_old", "short": "<2m", "long": "Up to 2 Months Old"}, + "_3m": {"id": "up_to_3m_old", "short": "<3m", "long": "Up to 3 Months Old"}, + "_4m": {"id": "up_to_4m_old", "short": "<4m", "long": "Up to 4 Months Old"}, + "_5m": {"id": "up_to_5m_old", "short": "<5m", "long": "Up to 5 Months Old"}, + "_6m": {"id": "up_to_6m_old", "short": "<6m", "long": "Up to 6 Months Old"}, + "_1y": {"id": "up_to_1y_old", "short": "<1y", "long": "Up to 1 Year Old"}, + "_2y": {"id": "up_to_2y_old", "short": "<2y", "long": "Up to 2 Years Old"}, + "_3y": {"id": "up_to_3y_old", "short": "<3y", "long": "Up to 3 Years Old"}, + "_4y": {"id": "up_to_4y_old", "short": "<4y", "long": "Up to 4 Years Old"}, + "_5y": {"id": "up_to_5y_old", "short": "<5y", "long": "Up to 5 Years Old"}, + "_6y": {"id": "up_to_6y_old", "short": "<6y", "long": "Up to 6 Years Old"}, + "_7y": {"id": "up_to_7y_old", "short": "<7y", "long": "Up to 7 Years Old"}, + "_8y": {"id": "up_to_8y_old", "short": "<8y", "long": "Up to 8 Years Old"}, + "_10y": {"id": "up_to_10y_old", "short": "<10y", "long": "Up to 10 Years Old"}, + "_12y": {"id": "up_to_12y_old", "short": "<12y", "long": "Up to 12 Years Old"}, + "_15y": {"id": "up_to_15y_old", "short": "<15y", "long": "Up to 15 Years Old"}, } MIN_AGE_NAMES = { - "_1d": { - "id": "at_least_1d_old", - "short": "1d+", - "long": "At Least 1 Day Old" - }, - "_1w": { - "id": "at_least_1w_old", - "short": "1w+", - "long": "At Least 1 Week Old" - }, - "_1m": { - "id": "at_least_1m_old", - "short": "1m+", - "long": "At Least 1 Month Old" - }, - "_2m": { - "id": "at_least_2m_old", - "short": "2m+", - "long": "At Least 2 Months Old" - }, - "_3m": { - "id": "at_least_3m_old", - "short": "3m+", - "long": "At Least 3 Months Old" - }, - "_4m": { - "id": "at_least_4m_old", - "short": "4m+", - "long": "At Least 4 Months Old" - }, - "_5m": { - "id": "at_least_5m_old", - "short": "5m+", - "long": "At Least 5 Months Old" - }, - "_6m": { - "id": "at_least_6m_old", - "short": "6m+", - "long": "At Least 6 Months Old" - }, - "_1y": { - "id": "at_least_1y_old", - "short": "1y+", - "long": "At Least 1 Year Old" - }, - "_2y": { - "id": "at_least_2y_old", - "short": "2y+", - "long": "At Least 2 Years Old" - }, - "_3y": { - "id": "at_least_3y_old", - "short": "3y+", - "long": "At Least 3 Years Old" - }, - "_4y": { - "id": "at_least_4y_old", - "short": "4y+", - "long": "At Least 4 Years Old" - }, - "_5y": { - "id": "at_least_5y_old", - "short": "5y+", - "long": "At Least 5 Years Old" - }, - "_6y": { - "id": "at_least_6y_old", - "short": "6y+", - "long": "At Least 6 Years Old" - }, - "_7y": { - "id": "at_least_7y_old", - "short": "7y+", - "long": "At Least 7 Years Old" - }, - "_8y": { - "id": "at_least_8y_old", - "short": "8y+", - "long": "At Least 8 Years Old" - }, - "_10y": { - "id": "at_least_10y_old", - "short": "10y+", - "long": "At Least 10 Years Old" - }, - "_12y": { - "id": "at_least_12y_old", - "short": "12y+", - "long": "At Least 12 Years Old" - } + "_1d": {"id": "at_least_1d_old", "short": "1d+", "long": "At Least 1 Day Old"}, + "_1w": {"id": "at_least_1w_old", "short": "1w+", "long": "At Least 1 Week Old"}, + "_1m": { + "id": "at_least_1m_old", + "short": "1m+", + "long": "At Least 1 Month Old", + }, + "_2m": { + "id": "at_least_2m_old", + "short": "2m+", + "long": "At Least 2 Months Old", + }, + "_3m": { + "id": "at_least_3m_old", + "short": "3m+", + "long": "At Least 3 Months Old", + }, + "_4m": { + "id": "at_least_4m_old", + "short": "4m+", + "long": "At Least 4 Months Old", + }, + "_5m": { + "id": "at_least_5m_old", + "short": "5m+", + "long": "At Least 5 Months Old", + }, + "_6m": { + "id": "at_least_6m_old", + "short": "6m+", + "long": "At Least 6 Months Old", + }, + "_1y": {"id": "at_least_1y_old", "short": "1y+", "long": "At Least 1 Year Old"}, + "_2y": { + "id": "at_least_2y_old", + "short": "2y+", + "long": "At Least 2 Years Old", + }, + "_3y": { + "id": "at_least_3y_old", + "short": "3y+", + "long": "At Least 3 Years Old", + }, + "_4y": { + "id": "at_least_4y_old", + "short": "4y+", + "long": "At Least 4 Years Old", + }, + "_5y": { + "id": "at_least_5y_old", + "short": "5y+", + "long": "At Least 5 Years Old", + }, + "_6y": { + "id": "at_least_6y_old", + "short": "6y+", + "long": "At Least 6 Years Old", + }, + "_7y": { + "id": "at_least_7y_old", + "short": "7y+", + "long": "At Least 7 Years Old", + }, + "_8y": { + "id": "at_least_8y_old", + "short": "8y+", + "long": "At Least 8 Years Old", + }, + "_10y": { + "id": "at_least_10y_old", + "short": "10y+", + "long": "At Least 10 Years Old", + }, + "_12y": { + "id": "at_least_12y_old", + "short": "12y+", + "long": "At Least 12 Years Old", + }, } AMOUNT_RANGE_NAMES = { - "_0sats": { - "id": "with_0sats", - "short": "0 sats", - "long": "0 Sats" - }, - "_1sat_to_10sats": { - "id": "above_1sat_under_10sats", - "short": "1-10 sats", - "long": "1 to 10 Sats" - }, - "_10sats_to_100sats": { - "id": "above_10sats_under_100sats", - "short": "10-100 sats", - "long": "10 to 100 Sats" - }, - "_100sats_to_1k_sats": { - "id": "above_100sats_under_1k_sats", - "short": "100-1k sats", - "long": "100 to 1K Sats" - }, - "_1k_sats_to_10k_sats": { - "id": "above_1k_sats_under_10k_sats", - "short": "1k-10k sats", - "long": "1K to 10K Sats" - }, - "_10k_sats_to_100k_sats": { - "id": "above_10k_sats_under_100k_sats", - "short": "10k-100k sats", - "long": "10K to 100K Sats" - }, - "_100k_sats_to_1m_sats": { - "id": "above_100k_sats_under_1m_sats", - "short": "100k-1M sats", - "long": "100K to 1M Sats" - }, - "_1m_sats_to_10m_sats": { - "id": "above_1m_sats_under_10m_sats", - "short": "1M-10M sats", - "long": "1M to 10M Sats" - }, - "_10m_sats_to_1btc": { - "id": "above_10m_sats_under_1btc", - "short": "0.1-1 BTC", - "long": "0.1 to 1 BTC" - }, - "_1btc_to_10btc": { - "id": "above_1btc_under_10btc", - "short": "1-10 BTC", - "long": "1 to 10 BTC" - }, - "_10btc_to_100btc": { - "id": "above_10btc_under_100btc", - "short": "10-100 BTC", - "long": "10 to 100 BTC" - }, - "_100btc_to_1k_btc": { - "id": "above_100btc_under_1k_btc", - "short": "100-1k BTC", - "long": "100 to 1K BTC" - }, - "_1k_btc_to_10k_btc": { - "id": "above_1k_btc_under_10k_btc", - "short": "1k-10k BTC", - "long": "1K to 10K BTC" - }, - "_10k_btc_to_100k_btc": { - "id": "above_10k_btc_under_100k_btc", - "short": "10k-100k BTC", - "long": "10K to 100K BTC" - }, - "_100k_btc_or_more": { - "id": "above_100k_btc", - "short": "100k+ BTC", - "long": "100K+ BTC" - } + "_0sats": {"id": "with_0sats", "short": "0 sats", "long": "0 Sats"}, + "_1sat_to_10sats": { + "id": "above_1sat_under_10sats", + "short": "1-10 sats", + "long": "1 to 10 Sats", + }, + "_10sats_to_100sats": { + "id": "above_10sats_under_100sats", + "short": "10-100 sats", + "long": "10 to 100 Sats", + }, + "_100sats_to_1k_sats": { + "id": "above_100sats_under_1k_sats", + "short": "100-1k sats", + "long": "100 to 1K Sats", + }, + "_1k_sats_to_10k_sats": { + "id": "above_1k_sats_under_10k_sats", + "short": "1k-10k sats", + "long": "1K to 10K Sats", + }, + "_10k_sats_to_100k_sats": { + "id": "above_10k_sats_under_100k_sats", + "short": "10k-100k sats", + "long": "10K to 100K Sats", + }, + "_100k_sats_to_1m_sats": { + "id": "above_100k_sats_under_1m_sats", + "short": "100k-1M sats", + "long": "100K to 1M Sats", + }, + "_1m_sats_to_10m_sats": { + "id": "above_1m_sats_under_10m_sats", + "short": "1M-10M sats", + "long": "1M to 10M Sats", + }, + "_10m_sats_to_1btc": { + "id": "above_10m_sats_under_1btc", + "short": "0.1-1 BTC", + "long": "0.1 to 1 BTC", + }, + "_1btc_to_10btc": { + "id": "above_1btc_under_10btc", + "short": "1-10 BTC", + "long": "1 to 10 BTC", + }, + "_10btc_to_100btc": { + "id": "above_10btc_under_100btc", + "short": "10-100 BTC", + "long": "10 to 100 BTC", + }, + "_100btc_to_1k_btc": { + "id": "above_100btc_under_1k_btc", + "short": "100-1k BTC", + "long": "100 to 1K BTC", + }, + "_1k_btc_to_10k_btc": { + "id": "above_1k_btc_under_10k_btc", + "short": "1k-10k BTC", + "long": "1K to 10K BTC", + }, + "_10k_btc_to_100k_btc": { + "id": "above_10k_btc_under_100k_btc", + "short": "10k-100k BTC", + "long": "10K to 100K BTC", + }, + "_100k_btc_or_more": { + "id": "above_100k_btc", + "short": "100k+ BTC", + "long": "100K+ BTC", + }, } GE_AMOUNT_NAMES = { - "_1sat": { - "id": "above_1sat", - "short": "1+ sats", - "long": "Above 1 Sat" - }, - "_10sats": { - "id": "above_10sats", - "short": "10+ sats", - "long": "Above 10 Sats" - }, - "_100sats": { - "id": "above_100sats", - "short": "100+ sats", - "long": "Above 100 Sats" - }, - "_1k_sats": { - "id": "above_1k_sats", - "short": "1k+ sats", - "long": "Above 1K Sats" - }, - "_10k_sats": { - "id": "above_10k_sats", - "short": "10k+ sats", - "long": "Above 10K Sats" - }, - "_100k_sats": { - "id": "above_100k_sats", - "short": "100k+ sats", - "long": "Above 100K Sats" - }, - "_1m_sats": { - "id": "above_1m_sats", - "short": "1M+ sats", - "long": "Above 1M Sats" - }, - "_10m_sats": { - "id": "above_10m_sats", - "short": "0.1+ BTC", - "long": "Above 0.1 BTC" - }, - "_1btc": { - "id": "above_1btc", - "short": "1+ BTC", - "long": "Above 1 BTC" - }, - "_10btc": { - "id": "above_10btc", - "short": "10+ BTC", - "long": "Above 10 BTC" - }, - "_100btc": { - "id": "above_100btc", - "short": "100+ BTC", - "long": "Above 100 BTC" - }, - "_1k_btc": { - "id": "above_1k_btc", - "short": "1k+ BTC", - "long": "Above 1K BTC" - }, - "_10k_btc": { - "id": "above_10k_btc", - "short": "10k+ BTC", - "long": "Above 10K BTC" - } + "_1sat": {"id": "above_1sat", "short": "1+ sats", "long": "Above 1 Sat"}, + "_10sats": {"id": "above_10sats", "short": "10+ sats", "long": "Above 10 Sats"}, + "_100sats": { + "id": "above_100sats", + "short": "100+ sats", + "long": "Above 100 Sats", + }, + "_1k_sats": { + "id": "above_1k_sats", + "short": "1k+ sats", + "long": "Above 1K Sats", + }, + "_10k_sats": { + "id": "above_10k_sats", + "short": "10k+ sats", + "long": "Above 10K Sats", + }, + "_100k_sats": { + "id": "above_100k_sats", + "short": "100k+ sats", + "long": "Above 100K Sats", + }, + "_1m_sats": { + "id": "above_1m_sats", + "short": "1M+ sats", + "long": "Above 1M Sats", + }, + "_10m_sats": { + "id": "above_10m_sats", + "short": "0.1+ BTC", + "long": "Above 0.1 BTC", + }, + "_1btc": {"id": "above_1btc", "short": "1+ BTC", "long": "Above 1 BTC"}, + "_10btc": {"id": "above_10btc", "short": "10+ BTC", "long": "Above 10 BTC"}, + "_100btc": {"id": "above_100btc", "short": "100+ BTC", "long": "Above 100 BTC"}, + "_1k_btc": {"id": "above_1k_btc", "short": "1k+ BTC", "long": "Above 1K BTC"}, + "_10k_btc": { + "id": "above_10k_btc", + "short": "10k+ BTC", + "long": "Above 10K BTC", + }, } LT_AMOUNT_NAMES = { - "_10sats": { - "id": "under_10sats", - "short": "<10 sats", - "long": "Under 10 Sats" - }, - "_100sats": { - "id": "under_100sats", - "short": "<100 sats", - "long": "Under 100 Sats" - }, - "_1k_sats": { - "id": "under_1k_sats", - "short": "<1k sats", - "long": "Under 1K Sats" - }, - "_10k_sats": { - "id": "under_10k_sats", - "short": "<10k sats", - "long": "Under 10K Sats" - }, - "_100k_sats": { - "id": "under_100k_sats", - "short": "<100k sats", - "long": "Under 100K Sats" - }, - "_1m_sats": { - "id": "under_1m_sats", - "short": "<1M sats", - "long": "Under 1M Sats" - }, - "_10m_sats": { - "id": "under_10m_sats", - "short": "<0.1 BTC", - "long": "Under 0.1 BTC" - }, - "_1btc": { - "id": "under_1btc", - "short": "<1 BTC", - "long": "Under 1 BTC" - }, - "_10btc": { - "id": "under_10btc", - "short": "<10 BTC", - "long": "Under 10 BTC" - }, - "_100btc": { - "id": "under_100btc", - "short": "<100 BTC", - "long": "Under 100 BTC" - }, - "_1k_btc": { - "id": "under_1k_btc", - "short": "<1k BTC", - "long": "Under 1K BTC" - }, - "_10k_btc": { - "id": "under_10k_btc", - "short": "<10k BTC", - "long": "Under 10K BTC" - }, - "_100k_btc": { - "id": "under_100k_btc", - "short": "<100k BTC", - "long": "Under 100K BTC" - } + "_10sats": {"id": "under_10sats", "short": "<10 sats", "long": "Under 10 Sats"}, + "_100sats": { + "id": "under_100sats", + "short": "<100 sats", + "long": "Under 100 Sats", + }, + "_1k_sats": { + "id": "under_1k_sats", + "short": "<1k sats", + "long": "Under 1K Sats", + }, + "_10k_sats": { + "id": "under_10k_sats", + "short": "<10k sats", + "long": "Under 10K Sats", + }, + "_100k_sats": { + "id": "under_100k_sats", + "short": "<100k sats", + "long": "Under 100K Sats", + }, + "_1m_sats": { + "id": "under_1m_sats", + "short": "<1M sats", + "long": "Under 1M Sats", + }, + "_10m_sats": { + "id": "under_10m_sats", + "short": "<0.1 BTC", + "long": "Under 0.1 BTC", + }, + "_1btc": {"id": "under_1btc", "short": "<1 BTC", "long": "Under 1 BTC"}, + "_10btc": {"id": "under_10btc", "short": "<10 BTC", "long": "Under 10 BTC"}, + "_100btc": {"id": "under_100btc", "short": "<100 BTC", "long": "Under 100 BTC"}, + "_1k_btc": {"id": "under_1k_btc", "short": "<1k BTC", "long": "Under 1K BTC"}, + "_10k_btc": { + "id": "under_10k_btc", + "short": "<10k BTC", + "long": "Under 10K BTC", + }, + "_100k_btc": { + "id": "under_100k_btc", + "short": "<100k BTC", + "long": "Under 100K BTC", + }, } - def __init__(self, base_url: str = 'http://localhost:3000', timeout: float = 30.0): + def __init__(self, base_url: str = "http://localhost:3000", timeout: float = 30.0): super().__init__(base_url, timeout) self.metrics = MetricsTree(self) @@ -4758,9 +6878,14 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-address)* Endpoint: `GET /api/address/{address}`""" - return self.get_json(f'/api/address/{address}') + return self.get_json(f"/api/address/{address}") - def get_address_txs(self, address: Address, after_txid: Optional[str] = None, limit: Optional[float] = None) -> List[Txid]: + def get_address_txs( + self, + address: Address, + after_txid: Optional[str] = None, + limit: Optional[float] = None, + ) -> List[Txid]: """Address transaction IDs. Get transaction IDs for an address, newest first. Use after_txid for pagination. @@ -4769,13 +6894,20 @@ class BrkClient(BrkClientBase): Endpoint: `GET /api/address/{address}/txs`""" params = [] - if after_txid is not None: params.append(f'after_txid={after_txid}') - if limit is not None: params.append(f'limit={limit}') - query = '&'.join(params) - path = f'/api/address/{address}/txs{"?" + query if query else ""}' + if after_txid is not None: + params.append(f"after_txid={after_txid}") + if limit is not None: + params.append(f"limit={limit}") + query = "&".join(params) + path = f"/api/address/{address}/txs{'?' + query if query else ''}" return self.get_json(path) - def get_address_confirmed_txs(self, address: Address, after_txid: Optional[str] = None, limit: Optional[float] = None) -> List[Txid]: + def get_address_confirmed_txs( + self, + address: Address, + after_txid: Optional[str] = None, + limit: Optional[float] = None, + ) -> List[Txid]: """Address confirmed transactions. Get confirmed transaction IDs for an address, 25 per page. Use ?after_txid= for pagination. @@ -4784,10 +6916,12 @@ class BrkClient(BrkClientBase): Endpoint: `GET /api/address/{address}/txs/chain`""" params = [] - if after_txid is not None: params.append(f'after_txid={after_txid}') - if limit is not None: params.append(f'limit={limit}') - query = '&'.join(params) - path = f'/api/address/{address}/txs/chain{"?" + query if query else ""}' + if after_txid is not None: + params.append(f"after_txid={after_txid}") + if limit is not None: + params.append(f"limit={limit}") + query = "&".join(params) + path = f"/api/address/{address}/txs/chain{'?' + query if query else ''}" return self.get_json(path) def get_address_mempool_txs(self, address: Address) -> List[Txid]: @@ -4798,7 +6932,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-transactions-mempool)* Endpoint: `GET /api/address/{address}/txs/mempool`""" - return self.get_json(f'/api/address/{address}/txs/mempool') + return self.get_json(f"/api/address/{address}/txs/mempool") def get_address_utxos(self, address: Address) -> List[Utxo]: """Address UTXOs. @@ -4808,7 +6942,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-utxo)* Endpoint: `GET /api/address/{address}/utxo`""" - return self.get_json(f'/api/address/{address}/utxo') + return self.get_json(f"/api/address/{address}/utxo") def get_block_by_height(self, height: Height) -> BlockInfo: """Block by height. @@ -4818,7 +6952,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-height)* Endpoint: `GET /api/block-height/{height}`""" - return self.get_json(f'/api/block-height/{height}') + return self.get_json(f"/api/block-height/{height}") def get_block(self, hash: BlockHash) -> BlockInfo: """Block information. @@ -4828,7 +6962,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block)* Endpoint: `GET /api/block/{hash}`""" - return self.get_json(f'/api/block/{hash}') + return self.get_json(f"/api/block/{hash}") def get_block_raw(self, hash: BlockHash) -> List[float]: """Raw block. @@ -4838,7 +6972,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-raw)* Endpoint: `GET /api/block/{hash}/raw`""" - return self.get_json(f'/api/block/{hash}/raw') + return self.get_json(f"/api/block/{hash}/raw") def get_block_status(self, hash: BlockHash) -> BlockStatus: """Block status. @@ -4848,7 +6982,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-status)* Endpoint: `GET /api/block/{hash}/status`""" - return self.get_json(f'/api/block/{hash}/status') + return self.get_json(f"/api/block/{hash}/status") def get_block_txid(self, hash: BlockHash, index: TxIndex) -> Txid: """Transaction ID at index. @@ -4858,7 +6992,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-transaction-id)* Endpoint: `GET /api/block/{hash}/txid/{index}`""" - return self.get_json(f'/api/block/{hash}/txid/{index}') + return self.get_json(f"/api/block/{hash}/txid/{index}") def get_block_txids(self, hash: BlockHash) -> List[Txid]: """Block transaction IDs. @@ -4868,7 +7002,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-transaction-ids)* Endpoint: `GET /api/block/{hash}/txids`""" - return self.get_json(f'/api/block/{hash}/txids') + return self.get_json(f"/api/block/{hash}/txids") def get_block_txs(self, hash: BlockHash, start_index: TxIndex) -> List[Transaction]: """Block transactions (paginated). @@ -4878,7 +7012,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-transactions)* Endpoint: `GET /api/block/{hash}/txs/{start_index}`""" - return self.get_json(f'/api/block/{hash}/txs/{start_index}') + return self.get_json(f"/api/block/{hash}/txs/{start_index}") def get_blocks(self) -> List[BlockInfo]: """Recent blocks. @@ -4888,7 +7022,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-blocks)* Endpoint: `GET /api/blocks`""" - return self.get_json('/api/blocks') + return self.get_json("/api/blocks") def get_blocks_from_height(self, height: Height) -> List[BlockInfo]: """Blocks from height. @@ -4898,7 +7032,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-blocks)* Endpoint: `GET /api/blocks/{height}`""" - return self.get_json(f'/api/blocks/{height}') + return self.get_json(f"/api/blocks/{height}") def get_mempool(self) -> MempoolInfo: """Mempool statistics. @@ -4908,7 +7042,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool)* Endpoint: `GET /api/mempool/info`""" - return self.get_json('/api/mempool/info') + return self.get_json("/api/mempool/info") def get_mempool_txids(self) -> List[Txid]: """Mempool transaction IDs. @@ -4918,7 +7052,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool-transaction-ids)* Endpoint: `GET /api/mempool/txids`""" - return self.get_json('/api/mempool/txids') + return self.get_json("/api/mempool/txids") def get_metric_info(self, metric: Metric) -> List[Index]: """Get supported indexes for a metric. @@ -4926,22 +7060,34 @@ class BrkClient(BrkClientBase): 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}`""" - return self.get_json(f'/api/metric/{metric}') + return self.get_json(f"/api/metric/{metric}") - def get_metric(self, metric: Metric, index: Index, start: Optional[float] = None, end: Optional[float] = None, limit: Optional[str] = None, format: Optional[Format] = None) -> Union[AnyMetricData, str]: + def get_metric( + self, + 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}`""" params = [] - if start is not None: params.append(f'start={start}') - if end is not None: params.append(f'end={end}') - if limit is not None: params.append(f'limit={limit}') - if format is not None: params.append(f'format={format}') - query = '&'.join(params) - path = f'/api/metric/{metric}/{index}{"?" + query if query else ""}' - if format == 'csv': + if start is not None: + params.append(f"start={start}") + if end is not None: + params.append(f"end={end}") + if limit is not None: + params.append(f"limit={limit}") + if format is not None: + params.append(f"format={format}") + query = "&".join(params) + path = f"/api/metric/{metric}/{index}{'?' + query if query else ''}" + if format == "csv": return self.get_text(path) return self.get_json(path) @@ -4951,24 +7097,36 @@ class BrkClient(BrkClientBase): Returns the complete hierarchical catalog of available metrics organized as a tree structure. Metrics are grouped by categories and subcategories. Endpoint: `GET /api/metrics`""" - return self.get_json('/api/metrics') + return self.get_json("/api/metrics") - def get_metrics(self, metrics: Metrics, index: Index, start: Optional[float] = None, end: Optional[float] = None, limit: Optional[str] = None, format: Optional[Format] = None) -> Union[List[AnyMetricData], str]: + def get_metrics( + self, + metrics: Metrics, + index: Index, + start: Optional[float] = None, + end: Optional[float] = None, + limit: Optional[str] = None, + format: Optional[Format] = None, + ) -> Union[List[AnyMetricData], str]: """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`""" params = [] - params.append(f'metrics={metrics}') - params.append(f'index={index}') - if start is not None: params.append(f'start={start}') - if end is not None: params.append(f'end={end}') - if limit is not None: params.append(f'limit={limit}') - if format is not None: params.append(f'format={format}') - query = '&'.join(params) - path = f'/api/metrics/bulk{"?" + query if query else ""}' - if format == 'csv': + params.append(f"metrics={metrics}") + params.append(f"index={index}") + if start is not None: + params.append(f"start={start}") + if end is not None: + params.append(f"end={end}") + if limit is not None: + params.append(f"limit={limit}") + if format is not None: + params.append(f"format={format}") + query = "&".join(params) + path = f"/api/metrics/bulk{'?' + query if query else ''}" + if format == "csv": return self.get_text(path) return self.get_json(path) @@ -4978,7 +7136,7 @@ class BrkClient(BrkClientBase): Returns the number of metrics available per index type. Endpoint: `GET /api/metrics/count`""" - return self.get_json('/api/metrics/count') + return self.get_json("/api/metrics/count") def get_indexes(self) -> List[IndexInfo]: """List available indexes. @@ -4986,7 +7144,7 @@ class BrkClient(BrkClientBase): Returns all available indexes with their accepted query aliases. Use any alias when querying metrics. Endpoint: `GET /api/metrics/indexes`""" - return self.get_json('/api/metrics/indexes') + return self.get_json("/api/metrics/indexes") def list_metrics(self, page: Optional[float] = None) -> PaginatedMetrics: """Metrics list. @@ -4995,21 +7153,25 @@ class BrkClient(BrkClientBase): Endpoint: `GET /api/metrics/list`""" params = [] - if page is not None: params.append(f'page={page}') - query = '&'.join(params) - path = f'/api/metrics/list{"?" + query if query else ""}' + if page is not None: + params.append(f"page={page}") + query = "&".join(params) + path = f"/api/metrics/list{'?' + query if query else ''}" return self.get_json(path) - def search_metrics(self, metric: Metric, limit: Optional[Limit] = None) -> List[Metric]: + def search_metrics( + self, metric: Metric, limit: Optional[Limit] = None + ) -> List[Metric]: """Search metrics. Fuzzy search for metrics by name. Supports partial matches and typos. Endpoint: `GET /api/metrics/search/{metric}`""" params = [] - if limit is not None: params.append(f'limit={limit}') - query = '&'.join(params) - path = f'/api/metrics/search/{metric}{"?" + query if query else ""}' + if limit is not None: + params.append(f"limit={limit}") + query = "&".join(params) + path = f"/api/metrics/search/{metric}{'?' + query if query else ''}" return self.get_json(path) def get_disk_usage(self) -> DiskUsage: @@ -5018,7 +7180,7 @@ class BrkClient(BrkClientBase): Returns the disk space used by BRK and Bitcoin data. Endpoint: `GET /api/server/disk`""" - return self.get_json('/api/server/disk') + return self.get_json("/api/server/disk") def get_sync_status(self) -> SyncStatus: """Sync status. @@ -5026,7 +7188,7 @@ class BrkClient(BrkClientBase): Returns the sync status of the indexer, including indexed height, tip height, blocks behind, and last indexed timestamp. Endpoint: `GET /api/server/sync`""" - return self.get_json('/api/server/sync') + return self.get_json("/api/server/sync") def get_tx(self, txid: Txid) -> Transaction: """Transaction information. @@ -5036,7 +7198,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction)* Endpoint: `GET /api/tx/{txid}`""" - return self.get_json(f'/api/tx/{txid}') + return self.get_json(f"/api/tx/{txid}") def get_tx_hex(self, txid: Txid) -> Hex: """Transaction hex. @@ -5046,7 +7208,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-hex)* Endpoint: `GET /api/tx/{txid}/hex`""" - return self.get_json(f'/api/tx/{txid}/hex') + return self.get_json(f"/api/tx/{txid}/hex") def get_tx_outspend(self, txid: Txid, vout: Vout) -> TxOutspend: """Output spend status. @@ -5056,7 +7218,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-outspend)* Endpoint: `GET /api/tx/{txid}/outspend/{vout}`""" - return self.get_json(f'/api/tx/{txid}/outspend/{vout}') + return self.get_json(f"/api/tx/{txid}/outspend/{vout}") def get_tx_outspends(self, txid: Txid) -> List[TxOutspend]: """All output spend statuses. @@ -5066,7 +7228,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-outspends)* Endpoint: `GET /api/tx/{txid}/outspends`""" - return self.get_json(f'/api/tx/{txid}/outspends') + return self.get_json(f"/api/tx/{txid}/outspends") def get_tx_status(self, txid: Txid) -> TxStatus: """Transaction status. @@ -5076,7 +7238,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-transaction-status)* Endpoint: `GET /api/tx/{txid}/status`""" - return self.get_json(f'/api/tx/{txid}/status') + return self.get_json(f"/api/tx/{txid}/status") def get_difficulty_adjustment(self) -> DifficultyAdjustment: """Difficulty adjustment. @@ -5086,7 +7248,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-difficulty-adjustment)* Endpoint: `GET /api/v1/difficulty-adjustment`""" - return self.get_json('/api/v1/difficulty-adjustment') + return self.get_json("/api/v1/difficulty-adjustment") def get_mempool_blocks(self) -> List[MempoolBlock]: """Projected mempool blocks. @@ -5096,7 +7258,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-mempool-blocks-fees)* Endpoint: `GET /api/v1/fees/mempool-blocks`""" - return self.get_json('/api/v1/fees/mempool-blocks') + return self.get_json("/api/v1/fees/mempool-blocks") def get_recommended_fees(self) -> RecommendedFees: """Recommended fees. @@ -5106,7 +7268,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-recommended-fees)* Endpoint: `GET /api/v1/fees/recommended`""" - return self.get_json('/api/v1/fees/recommended') + return self.get_json("/api/v1/fees/recommended") def get_block_fee_rates(self, time_period: TimePeriod) -> Any: """Block fee rates (WIP). @@ -5116,7 +7278,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-feerates)* Endpoint: `GET /api/v1/mining/blocks/fee-rates/{time_period}`""" - return self.get_json(f'/api/v1/mining/blocks/fee-rates/{time_period}') + return self.get_json(f"/api/v1/mining/blocks/fee-rates/{time_period}") def get_block_fees(self, time_period: TimePeriod) -> List[BlockFeesEntry]: """Block fees. @@ -5126,7 +7288,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-fees)* Endpoint: `GET /api/v1/mining/blocks/fees/{time_period}`""" - return self.get_json(f'/api/v1/mining/blocks/fees/{time_period}') + return self.get_json(f"/api/v1/mining/blocks/fees/{time_period}") def get_block_rewards(self, time_period: TimePeriod) -> List[BlockRewardsEntry]: """Block rewards. @@ -5136,7 +7298,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-rewards)* Endpoint: `GET /api/v1/mining/blocks/rewards/{time_period}`""" - return self.get_json(f'/api/v1/mining/blocks/rewards/{time_period}') + return self.get_json(f"/api/v1/mining/blocks/rewards/{time_period}") def get_block_sizes_weights(self, time_period: TimePeriod) -> BlockSizesWeights: """Block sizes and weights. @@ -5146,7 +7308,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-sizes-weights)* Endpoint: `GET /api/v1/mining/blocks/sizes-weights/{time_period}`""" - return self.get_json(f'/api/v1/mining/blocks/sizes-weights/{time_period}') + return self.get_json(f"/api/v1/mining/blocks/sizes-weights/{time_period}") def get_block_by_timestamp(self, timestamp: Timestamp) -> BlockTimestamp: """Block by timestamp. @@ -5156,7 +7318,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-block-timestamp)* Endpoint: `GET /api/v1/mining/blocks/timestamp/{timestamp}`""" - return self.get_json(f'/api/v1/mining/blocks/timestamp/{timestamp}') + return self.get_json(f"/api/v1/mining/blocks/timestamp/{timestamp}") def get_difficulty_adjustments(self) -> List[DifficultyAdjustmentEntry]: """Difficulty adjustments (all time). @@ -5166,9 +7328,11 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-difficulty-adjustments)* Endpoint: `GET /api/v1/mining/difficulty-adjustments`""" - return self.get_json('/api/v1/mining/difficulty-adjustments') + return self.get_json("/api/v1/mining/difficulty-adjustments") - def get_difficulty_adjustments_by_period(self, time_period: TimePeriod) -> List[DifficultyAdjustmentEntry]: + def get_difficulty_adjustments_by_period( + self, time_period: TimePeriod + ) -> List[DifficultyAdjustmentEntry]: """Difficulty adjustments. Get historical difficulty adjustments for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y. @@ -5176,7 +7340,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-difficulty-adjustments)* Endpoint: `GET /api/v1/mining/difficulty-adjustments/{time_period}`""" - return self.get_json(f'/api/v1/mining/difficulty-adjustments/{time_period}') + return self.get_json(f"/api/v1/mining/difficulty-adjustments/{time_period}") def get_hashrate(self) -> HashrateSummary: """Network hashrate (all time). @@ -5186,7 +7350,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-hashrate)* Endpoint: `GET /api/v1/mining/hashrate`""" - return self.get_json('/api/v1/mining/hashrate') + return self.get_json("/api/v1/mining/hashrate") def get_hashrate_by_period(self, time_period: TimePeriod) -> HashrateSummary: """Network hashrate. @@ -5196,7 +7360,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-hashrate)* Endpoint: `GET /api/v1/mining/hashrate/{time_period}`""" - return self.get_json(f'/api/v1/mining/hashrate/{time_period}') + return self.get_json(f"/api/v1/mining/hashrate/{time_period}") def get_pool(self, slug: PoolSlug) -> PoolDetail: """Mining pool details. @@ -5206,7 +7370,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-mining-pool)* Endpoint: `GET /api/v1/mining/pool/{slug}`""" - return self.get_json(f'/api/v1/mining/pool/{slug}') + return self.get_json(f"/api/v1/mining/pool/{slug}") def get_pools(self) -> List[PoolInfo]: """List all mining pools. @@ -5216,7 +7380,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-mining-pools)* Endpoint: `GET /api/v1/mining/pools`""" - return self.get_json('/api/v1/mining/pools') + return self.get_json("/api/v1/mining/pools") def get_pool_stats(self, time_period: TimePeriod) -> PoolsSummary: """Mining pool statistics. @@ -5226,7 +7390,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-mining-pools)* Endpoint: `GET /api/v1/mining/pools/{time_period}`""" - return self.get_json(f'/api/v1/mining/pools/{time_period}') + return self.get_json(f"/api/v1/mining/pools/{time_period}") def get_reward_stats(self, block_count: float) -> RewardStats: """Mining reward statistics. @@ -5236,7 +7400,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-reward-stats)* Endpoint: `GET /api/v1/mining/reward-stats/{block_count}`""" - return self.get_json(f'/api/v1/mining/reward-stats/{block_count}') + return self.get_json(f"/api/v1/mining/reward-stats/{block_count}") def validate_address(self, address: str) -> AddressValidation: """Validate address. @@ -5246,7 +7410,7 @@ class BrkClient(BrkClientBase): *[Mempool.space docs](https://mempool.space/docs/api/rest#get-address-validate)* Endpoint: `GET /api/v1/validate-address/{address}`""" - return self.get_json(f'/api/v1/validate-address/{address}') + return self.get_json(f"/api/v1/validate-address/{address}") def get_health(self) -> Health: """Health check. @@ -5254,7 +7418,7 @@ class BrkClient(BrkClientBase): Returns the health status of the API server, including uptime information. Endpoint: `GET /health`""" - return self.get_json('/health') + return self.get_json("/health") def get_version(self) -> str: """API version. @@ -5262,5 +7426,4 @@ class BrkClient(BrkClientBase): Returns the current version of the API server Endpoint: `GET /version`""" - return self.get_json('/version') - + return self.get_json("/version") diff --git a/packages/brk_client/scripts/publish.sh b/packages/brk_client/scripts/publish.sh deleted file mode 100755 index e4bb6f2c9..000000000 --- a/packages/brk_client/scripts/publish.sh +++ /dev/null @@ -1,4 +0,0 @@ -uv run pytest tests/basic.py -s -uvx pydoc-markdown > DOCS.md -uv build -uvx uv-publish diff --git a/packages/brk_client/tests/basic.py b/packages/brk_client/tests/test_basic.py similarity index 100% rename from packages/brk_client/tests/basic.py rename to packages/brk_client/tests/test_basic.py diff --git a/packages/brk_client/tests/tree.py b/packages/brk_client/tests/test_tree.py similarity index 90% rename from packages/brk_client/tests/tree.py rename to packages/brk_client/tests/test_tree.py index feab8e53b..b845e4bf6 100644 --- a/packages/brk_client/tests/tree.py +++ b/packages/brk_client/tests/test_tree.py @@ -20,8 +20,10 @@ def get_all_metrics(obj, path=""): metrics = [] for attr_name in dir(obj): - # Skip dunder methods and internal attributes like _client - if attr_name.startswith("__") or attr_name == "_client": + # Skip dunder methods and internal attributes (_letter), but allow _digit (e.g., _10y, _2017) + if attr_name.startswith("__"): + continue + if attr_name.startswith("_") and len(attr_name) > 1 and attr_name[1].isalpha(): continue try: diff --git a/scripts/.gitignore b/scripts/.gitignore new file mode 100644 index 000000000..b339fe19b --- /dev/null +++ b/scripts/.gitignore @@ -0,0 +1 @@ +.tokens diff --git a/scripts/js-docs.sh b/scripts/js-docs.sh new file mode 100755 index 000000000..dfa1c74f1 --- /dev/null +++ b/scripts/js-docs.sh @@ -0,0 +1,8 @@ +#!/bin/bash +set -e + +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" +ROOT_DIR="$SCRIPT_DIR/.." + +cd "$ROOT_DIR/modules/brk-client" +npx -y -p typedoc -p typedoc-plugin-markdown typedoc index.js --plugin typedoc-plugin-markdown --out docs --excludeNotDocumented diff --git a/scripts/js-publish.sh b/scripts/js-publish.sh new file mode 100755 index 000000000..071909fa1 --- /dev/null +++ b/scripts/js-publish.sh @@ -0,0 +1,19 @@ +#!/bin/bash +set -e + +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" +ROOT_DIR="$SCRIPT_DIR/.." + +VERSION="$1" +if [ -z "$VERSION" ]; then + echo "Usage: $0 " + exit 1 +fi + +cd "$ROOT_DIR/modules/brk-client" + +# Update version in package.json +sed -i '' 's/"version": "[^"]*"/"version": "'"$VERSION"'"/' package.json +echo "Updated package.json to $VERSION" + +npm publish --access public diff --git a/scripts/publish-all.sh b/scripts/publish-all.sh deleted file mode 100755 index d6ac087de..000000000 --- a/scripts/publish-all.sh +++ /dev/null @@ -1,40 +0,0 @@ -#!/bin/bash -set -e - -SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" -ROOT_DIR="$SCRIPT_DIR/.." - -echo "=== Publishing all BRK packages ===" - -# Get version from Cargo.toml -VERSION=$(grep 'package.version' "$ROOT_DIR/Cargo.toml" | sed 's/.*= *"//' | sed 's/".*//') -echo "Version: $VERSION" - -# Update JS package.json version -sed -i '' 's/"version": "[^"]*"/"version": "'"$VERSION"'"/' "$ROOT_DIR/modules/brk-client/package.json" - -# Update Python pyproject.toml version -sed -i '' 's/^version = "[^"]*"/version = "'"$VERSION"'"/' "$ROOT_DIR/packages/brk_client/pyproject.toml" - -# 1. Publish Rust crates -echo "" -echo "=== Rust crates ===" -"$SCRIPT_DIR/publish.sh" - -# 2. Publish JavaScript package -echo "" -echo "=== JavaScript package ===" -cd "$ROOT_DIR/modules/brk-client" -./scripts/docs.sh -npm publish --access public - -# 3. Publish Python package -echo "" -echo "=== Python package ===" -cd "$ROOT_DIR/packages/brk_client" -uvx pydoc-markdown > docs/API.md -uv build -uv publish - -echo "" -echo "=== Done! ===" diff --git a/scripts/python-docs.sh b/scripts/python-docs.sh new file mode 100755 index 000000000..c4d5b22cd --- /dev/null +++ b/scripts/python-docs.sh @@ -0,0 +1,8 @@ +#!/bin/bash +set -e + +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" +ROOT_DIR="$SCRIPT_DIR/.." + +cd "$ROOT_DIR/packages/brk_client" +uvx pydoc-markdown > DOCS.md diff --git a/scripts/python-publish.sh b/scripts/python-publish.sh new file mode 100755 index 000000000..9d0ac8f72 --- /dev/null +++ b/scripts/python-publish.sh @@ -0,0 +1,20 @@ +#!/bin/bash +set -e + +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" +ROOT_DIR="$SCRIPT_DIR/.." + +VERSION="$1" +if [ -z "$VERSION" ]; then + echo "Usage: $0 " + exit 1 +fi + +cd "$ROOT_DIR/packages/brk_client" + +# Update version in pyproject.toml +sed -i '' 's/^version = "[^"]*"/version = "'"$VERSION"'"/' pyproject.toml +echo "Updated pyproject.toml to $VERSION" + +uv build +uv publish diff --git a/scripts/release.sh b/scripts/release.sh new file mode 100755 index 000000000..35cc776cb --- /dev/null +++ b/scripts/release.sh @@ -0,0 +1,152 @@ +#!/bin/bash +set -e + +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" +ROOT_DIR="$SCRIPT_DIR/.." + +echo "=== BRK Release ===" +echo "" + +# Check if version argument provided +if [ -z "$1" ]; then + echo "Usage: $0 " + echo "Examples:" + echo " $0 0.1.0-alpha.3" + echo " $0 patch" + echo " $0 minor" + echo " $0 major" + exit 1 +fi + +RELEASE_ARG="$1" +echo "Release argument: $RELEASE_ARG" +echo "" + +# Load tokens +if [ -f "$SCRIPT_DIR/.tokens" ]; then + source "$SCRIPT_DIR/.tokens" +fi + +# ============================================================================ +# 0. VERIFY TOKENS +# ============================================================================ + +echo "=== Verifying tokens ===" +echo "" + +echo "--- npm ---" +npm whoami || { echo "npm not authenticated. Run: npm login"; exit 1; } +echo "" + +echo "--- PyPI ---" +if [ -z "$UV_PUBLISH_TOKEN" ]; then + echo "UV_PUBLISH_TOKEN not set. Add it to scripts/.tokens" + exit 1 +fi +echo "OK" +echo "" + +# ============================================================================ +# 1. TESTS +# ============================================================================ + +echo "=== Running tests ===" +echo "" + +echo "--- Rust ---" +cd "$ROOT_DIR" +cargo test --workspace +echo "" + +echo "--- JavaScript ---" +cd "$ROOT_DIR/modules/brk-client" +npm test +echo "" + +echo "--- Python ---" +cd "$ROOT_DIR/packages/brk_client" +uv run pytest tests/ -s +echo "" + +# ============================================================================ +# 2. BUILD +# ============================================================================ + +echo "=== Building ===" +echo "" + +echo "--- Rust ---" +cd "$ROOT_DIR" +cargo build --workspace --release +echo "" + +echo "--- JavaScript ---" +cd "$ROOT_DIR/modules/brk-client" +# JS doesn't need build step, just verify it loads +node -e "import('./index.js')" +echo "OK" +echo "" + +echo "--- Python ---" +cd "$ROOT_DIR/packages/brk_client" +uv build +echo "" + +# ============================================================================ +# 3. GENERATE DOCS +# ============================================================================ + +echo "=== Generating docs ===" +echo "" + +echo "--- JavaScript ---" +"$SCRIPT_DIR/js-docs.sh" +echo "" + +echo "--- Python ---" +"$SCRIPT_DIR/python-docs.sh" +echo "" + +# ============================================================================ +# 4. CARGO RELEASE (Rust crates) +# ============================================================================ + +echo "=== Rust release ===" +echo "" + +cd "$ROOT_DIR" +# Version bump, commit, and tag (but don't publish yet) +cargo release "$RELEASE_ARG" --execute --no-publish --allow-dirty + +# Publish crates with retry logic for rate limits +"$SCRIPT_DIR/rust-publish.sh" + +# Extract actual version from Cargo.toml after release +VERSION=$(grep '^package.version' "$ROOT_DIR/Cargo.toml" | sed 's/.*= *"//' | sed 's/".*//') +echo "" +echo "Released Rust crates at version: $VERSION" + +# ============================================================================ +# 5. JAVASCRIPT PACKAGE +# ============================================================================ + +echo "" +echo "=== JavaScript package ===" +"$SCRIPT_DIR/js-publish.sh" "$VERSION" +echo "" + +# ============================================================================ +# 6. PYTHON PACKAGE +# ============================================================================ + +echo "" +echo "=== Python package ===" +"$SCRIPT_DIR/python-publish.sh" "$VERSION" +echo "" + +# ============================================================================ +# DONE +# ============================================================================ + +echo "=== Done! ===" +echo "Released v$VERSION" diff --git a/scripts/publish.sh b/scripts/rust-publish.sh similarity index 89% rename from scripts/publish.sh rename to scripts/rust-publish.sh index dff3f16c4..4a8ac0dee 100755 --- a/scripts/publish.sh +++ b/scripts/rust-publish.sh @@ -3,9 +3,9 @@ set -e # Order determined by topological sort of dependency graph CRATES=( + brk_alloc brk_error brk_logger - brk_traversable_derive brk_types brk_fetcher brk_rpc @@ -13,13 +13,14 @@ CRATES=( brk_reader brk_iterator brk_store + brk_traversable_derive brk_traversable brk_grouper brk_bencher brk_indexer brk_computer brk_query - brk_binder + brk_bindgen brk_mcp brk_server brk @@ -34,7 +35,7 @@ echo "Working from: $(pwd)" for crate in "${CRATES[@]}"; do cd "$crate" - cargo publish --color=always 2>&1 | tee /tmp/publish_$$.log + cargo publish --allow-dirty --color=always 2>&1 | tee /tmp/publish_$$.log if [ ${PIPESTATUS[0]} -ne 0 ]; then if ! grep -q "already exists on" /tmp/publish_$$.log; then rm -f /tmp/publish_$$.log diff --git a/website/index.html b/website/index.html index 9bab8fc55..388830193 100644 --- a/website/index.html +++ b/website/index.html @@ -1520,7 +1520,138 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +