@xyo-network/xl1-protocol-sdk 1.7.6 → 1.7.8

package/README.md

@@ -8,13 +8,3297 @@
 [![npm-license-badge][]](LICENSE)
 [![socket-badge][]][socket-link]
 
-Version: 1.7.3
-
 XYO Layer One SDK Protocol
 
 ## Documentation
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__xl1-protocol-sdk)
+## Reference
+
+**@xyo-network/xl1-protocol-sdk**
+
+***
+
+## Interfaces
+
+- [~~ChainServiceCollection~~](#interfaces/ChainServiceCollection)
+- [ChainServiceCollectionV2](#interfaces/ChainServiceCollectionV2)
+- [NegativeBigInt](#interfaces/NegativeBigInt)
+- [PositiveBigInt](#interfaces/PositiveBigInt)
+- [ChainContext](#interfaces/ChainContext)
+- [ChainSummaryContext](#interfaces/ChainSummaryContext)
+- [BalanceStepSummaryContext](#interfaces/BalanceStepSummaryContext)
+- [StepSummaryFields](#interfaces/StepSummaryFields)
+- [ChainWindow](#interfaces/ChainWindow)
+- [AddressInstance](#interfaces/AddressInstance)
+- [AddressStateInstance](#interfaces/AddressStateInstance)
+- [BoundWitnessInstance](#interfaces/BoundWitnessInstance)
+- [DataInstance](#interfaces/DataInstance)
+- [TransactionFeesInstance](#interfaces/TransactionFeesInstance)
+- [ObjectInstance](#interfaces/ObjectInstance)
+- [PayloadInstance](#interfaces/PayloadInstance)
+- [ShiftedBigIntConfig](#interfaces/ShiftedBigIntConfig)
+- [SignatureInstance](#interfaces/SignatureInstance)
+- [XL1AmountInstance](#interfaces/XL1AmountInstance)
+- [HydratedBlockInstance](#interfaces/HydratedBlockInstance)
+- [BlockWindowInstance](#interfaces/BlockWindowInstance)
+- [BlockWindowStateInstance](#interfaces/BlockWindowStateInstance)
+- [SignedInstance](#interfaces/SignedInstance)
+- [ValidatableInstance](#interfaces/ValidatableInstance)
+- [HydratedTransactionInstance](#interfaces/HydratedTransactionInstance)
+
+## Type Aliases
+
+- [SignedBigInt](#type-aliases/SignedBigInt)
+- [BlockNumberRange](#type-aliases/BlockNumberRange)
+- [StepSummarySchema](#type-aliases/StepSummarySchema)
+- [StepSummary](#type-aliases/StepSummary)
+- [BalancesStepSummarySchema](#type-aliases/BalancesStepSummarySchema)
+- [BalancesStepSummary](#type-aliases/BalancesStepSummary)
+- [Config](#type-aliases/Config)
+- [MnemonicString](#type-aliases/MnemonicString)
+
+## Variables
+
+- [StepSummarySchema](#variables/StepSummarySchema)
+- [BalancesStepSummarySchema](#variables/BalancesStepSummarySchema)
+- [isBalancesStepSummary](#variables/isBalancesStepSummary)
+- [asBalancesStepSummary](#variables/asBalancesStepSummary)
+- [asBalancesStepSummaryWithStorageMeta](#variables/asBalancesStepSummaryWithStorageMeta)
+- [Xl1CommonConfigSchema](#variables/Xl1CommonConfigSchema)
+- [ConfigSchema](#variables/ConfigSchema)
+- [TODO](#variables/TODO)
+- [MnemonicStringSchema](#variables/MnemonicStringSchema)
+
+## Functions
+
+- [isNegativeBigInt](#functions/isNegativeBigInt)
+- [isPositiveBigInt](#functions/isPositiveBigInt)
+- [parseSignedBigInt](#functions/parseSignedBigInt)
+- [toSignedBigInt](#functions/toSignedBigInt)
+- [toPositiveBigInt](#functions/toPositiveBigInt)
+- [allHashesPresent](#functions/allHashesPresent)
+- [tryHydrateBlock](#functions/tryHydrateBlock)
+- [hydrateBlock](#functions/hydrateBlock)
+- [flattenHydratedBlock](#functions/flattenHydratedBlock)
+- [flattenHydratedBlocks](#functions/flattenHydratedBlocks)
+- [transactionsFromHydratedBlock](#functions/transactionsFromHydratedBlock)
+- [blockPayloadsFromHydratedBlock](#functions/blockPayloadsFromHydratedBlock)
+- [balanceStepSummaryFromRange](#functions/balanceStepSummaryFromRange)
+- [balanceSummary](#functions/balanceSummary)
+- [calculateFramesFromRange](#functions/calculateFramesFromRange)
+- [deepCalculateFramesFromRange](#functions/deepCalculateFramesFromRange)
+- [hashFromBlockNumber](#functions/hashFromBlockNumber)
+- [isBalancesStepSummaryWithStorageMeta](#functions/isBalancesStepSummaryWithStorageMeta)
+- [getDefaultConfig](#functions/getDefaultConfig)
+- [netBalancesForPayloads](#functions/netBalancesForPayloads)
+- [buildTransaction](#functions/buildTransaction)
+- [tryHydrateTransaction](#functions/tryHydrateTransaction)
+- [hydrateTransaction](#functions/hydrateTransaction)
+- [flattenHydratedTransaction](#functions/flattenHydratedTransaction)
+- [flattenHydratedTransactions](#functions/flattenHydratedTransactions)
+- [tryHydrateElevatedTransaction](#functions/tryHydrateElevatedTransaction)
+- [hydrateElevatedTransaction](#functions/hydrateElevatedTransaction)
+- [transactionBlockByteCount](#functions/transactionBlockByteCount)
+- [transactionElevatedPayloadHashes](#functions/transactionElevatedPayloadHashes)
+- [transactionElevatedPayloads](#functions/transactionElevatedPayloads)
+- [crackOperation](#functions/crackOperation)
+- [crackOperations](#functions/crackOperations)
+- [transactionBytesRequiredGas](#functions/transactionBytesRequiredGas)
+- [transactionRequiredGas](#functions/transactionRequiredGas)
+- [getUrl](#functions/getUrl)
+- [isLocalhost](#functions/isLocalhost)
+
+### functions
+
+  ### <a id="allHashesPresent"></a>allHashesPresent
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function allHashesPresent(hashes, payloads): boolean;
+```
+
+## Parameters
+
+### hashes
+
+`Lowercase`\<`string`\>[]
+
+### payloads
+
+`WithStorageMeta`\<`Payload`\>[]
+
+## Returns
+
+`boolean`
+
+  ### <a id="balanceStepSummaryFromRange"></a>balanceStepSummaryFromRange
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function balanceStepSummaryFromRange(context, range): Promise<WithStorageMeta<BalancesStepSummary>>;
+```
+
+## Parameters
+
+### context
+
+[`BalanceStepSummaryContext`](#../interfaces/BalanceStepSummaryContext)
+
+### range
+
+[`BlockNumberRange`](#../type-aliases/BlockNumberRange)
+
+## Returns
+
+`Promise`\<`WithStorageMeta`\<[`BalancesStepSummary`](#../type-aliases/BalancesStepSummary)\>\>
+
+  ### <a id="balanceSummary"></a>balanceSummary
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function balanceSummary(context): Promise<Partial<Record<Lowercase<string>, bigint>>>;
+```
+
+## Parameters
+
+### context
+
+[`BalanceStepSummaryContext`](#../interfaces/BalanceStepSummaryContext)
+
+## Returns
+
+`Promise`\<`Partial`\<`Record`\<`Lowercase`\<`string`\>, `bigint`\>\>\>
+
+  ### <a id="blockPayloadsFromHydratedBlock"></a>blockPayloadsFromHydratedBlock
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function blockPayloadsFromHydratedBlock(block): WithStorageMeta<Payload>[];
+```
+
+## Parameters
+
+### block
+
+`HydratedBlock`
+
+## Returns
+
+`WithStorageMeta`\<`Payload`\>[]
+
+  ### <a id="buildTransaction"></a>buildTransaction
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function buildTransaction(
+   chain, 
+   elevatedPayloads, 
+   additionalPayloads, 
+   signer, 
+   nbf, 
+   exp, 
+   from?, 
+fees?): Promise<HydratedTransaction>;
+```
+
+## Parameters
+
+### chain
+
+`Lowercase`\<`string`\>
+
+### elevatedPayloads
+
+`AllowedBlockPayload`[]
+
+### additionalPayloads
+
+`Payload`[]
+
+### signer
+
+`AccountInstance` | `AccountInstance`[]
+
+### nbf
+
+`number`
+
+### exp
+
+`number`
+
+### from?
+
+`Lowercase`\<`string`\>
+
+### fees?
+
+`TransactionFeesBigInt` = `defaultTransactionFees`
+
+## Returns
+
+`Promise`\<`HydratedTransaction`\>
+
+  ### <a id="calculateFramesFromRange"></a>calculateFramesFromRange
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function calculateFramesFromRange(range, step): [BlockNumberRange[], BlockNumberRange[]];
+```
+
+## Parameters
+
+### range
+
+[`BlockNumberRange`](#../type-aliases/BlockNumberRange)
+
+### step
+
+`number`
+
+## Returns
+
+\[[`BlockNumberRange`](#../type-aliases/BlockNumberRange)[], [`BlockNumberRange`](#../type-aliases/BlockNumberRange)[]\]
+
+  ### <a id="crackOperation"></a>crackOperation
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function crackOperation(operation): [string, string[]];
+```
+
+## Parameters
+
+### operation
+
+`string`
+
+## Returns
+
+\[`string`, `string`[]\]
+
+  ### <a id="crackOperations"></a>crackOperations
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function crackOperations(operations): [string, string[]][];
+```
+
+## Parameters
+
+### operations
+
+`string`[]
+
+## Returns
+
+\[`string`, `string`[]\][]
+
+  ### <a id="deepCalculateFramesFromRange"></a>deepCalculateFramesFromRange
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function deepCalculateFramesFromRange(range, startingStep): BlockNumberRange[];
+```
+
+## Parameters
+
+### range
+
+[`BlockNumberRange`](#../type-aliases/BlockNumberRange)
+
+### startingStep
+
+`number` = `...`
+
+## Returns
+
+[`BlockNumberRange`](#../type-aliases/BlockNumberRange)[]
+
+  ### <a id="flattenHydratedBlock"></a>flattenHydratedBlock
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function flattenHydratedBlock(hydratedBlock): WithStorageMeta<Payload>[];
+```
+
+## Parameters
+
+### hydratedBlock
+
+`HydratedBlock`
+
+## Returns
+
+`WithStorageMeta`\<`Payload`\>[]
+
+  ### <a id="flattenHydratedBlocks"></a>flattenHydratedBlocks
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function flattenHydratedBlocks(hydratedBlocks): WithStorageMeta<Payload>[];
+```
+
+## Parameters
+
+### hydratedBlocks
+
+`HydratedBlock`[]
+
+## Returns
+
+`WithStorageMeta`\<`Payload`\>[]
+
+  ### <a id="flattenHydratedTransaction"></a>flattenHydratedTransaction
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function flattenHydratedTransaction(hydratedTransaction): Payload[];
+```
+
+## Parameters
+
+### hydratedTransaction
+
+`HydratedTransaction`
+
+## Returns
+
+`Payload`[]
+
+  ### <a id="flattenHydratedTransactions"></a>flattenHydratedTransactions
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function flattenHydratedTransactions(hydratedTransactions): Payload[];
+```
+
+## Parameters
+
+### hydratedTransactions
+
+`HydratedTransaction`[]
+
+## Returns
+
+`Payload`[]
+
+  ### <a id="getDefaultConfig"></a>getDefaultConfig
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function getDefaultConfig(): object;
+```
+
+## Returns
+
+`object`
+
+### silent
+
+```ts
+silent: boolean;
+```
+
+### logLevel
+
+```ts
+logLevel: "error" | "warn" | "info" | "log" | "debug" | "trace";
+```
+
+### api
+
+```ts
+api: object;
+```
+
+### api.mnemonic?
+
+```ts
+optional mnemonic: string;
+```
+
+### api.host
+
+```ts
+host: string;
+```
+
+### api.port
+
+```ts
+port: number;
+```
+
+### app
+
+```ts
+app: object;
+```
+
+### app.port
+
+```ts
+port: number;
+```
+
+### chain
+
+```ts
+chain: object;
+```
+
+### chain.id?
+
+```ts
+optional id: string;
+```
+
+### evm
+
+```ts
+evm: object;
+```
+
+### evm.chainId?
+
+```ts
+optional chainId: string;
+```
+
+### evm.infura?
+
+```ts
+optional infura: object;
+```
+
+### evm.infura.projectId?
+
+```ts
+optional projectId: string;
+```
+
+### evm.infura.projectSecret?
+
+```ts
+optional projectSecret: string;
+```
+
+### evm.jsonRpc?
+
+```ts
+optional jsonRpc: object;
+```
+
+### evm.jsonRpc.url?
+
+```ts
+optional url: string;
+```
+
+### producer
+
+```ts
+producer: object;
+```
+
+### producer.healthCheckPort?
+
+```ts
+optional healthCheckPort: number;
+```
+
+### producer.minStake
+
+```ts
+minStake: number;
+```
+
+### producer.mnemonic?
+
+```ts
+optional mnemonic: string;
+```
+
+### producer.port
+
+```ts
+port: number;
+```
+
+### producer.disableIntentRedeclaration?
+
+```ts
+optional disableIntentRedeclaration: boolean;
+```
+
+### producer.rewardAddress?
+
+```ts
+optional rewardAddress: string;
+```
+
+### storage
+
+```ts
+storage: object;
+```
+
+### storage.mongo?
+
+```ts
+optional mongo: object;
+```
+
+### storage.mongo.connectionString?
+
+```ts
+optional connectionString: string;
+```
+
+### storage.mongo.database?
+
+```ts
+optional database: string;
+```
+
+### storage.mongo.domain?
+
+```ts
+optional domain: string;
+```
+
+### storage.mongo.password?
+
+```ts
+optional password: string;
+```
+
+### storage.mongo.username?
+
+```ts
+optional username: string;
+```
+
+### storage.root?
+
+```ts
+optional root: string;
+```
+
+### telemetry
+
+```ts
+telemetry: object;
+```
+
+### telemetry.otel?
+
+```ts
+optional otel: object;
+```
+
+### telemetry.otel.otlpEndpoint?
+
+```ts
+optional otlpEndpoint: string;
+```
+
+  ### <a id="getUrl"></a>getUrl
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function getUrl(host, port): string;
+```
+
+## Parameters
+
+### host
+
+`string`
+
+### port
+
+`number`
+
+## Returns
+
+`string`
+
+  ### <a id="hashFromBlockNumber"></a>hashFromBlockNumber
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function hashFromBlockNumber(context, blockNumber): Promise<Lowercase<string>>;
+```
+
+## Parameters
+
+### context
+
+[`ChainContext`](#../interfaces/ChainContext)
+
+### blockNumber
+
+`number`
+
+## Returns
+
+`Promise`\<`Lowercase`\<`string`\>\>
+
+  ### <a id="hydrateBlock"></a>hydrateBlock
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function hydrateBlock(
+   archivist, 
+   hash, 
+   maxDepth, 
+minDepth): Promise<HydratedBlock>;
+```
+
+## Parameters
+
+### archivist
+
+`ReadArchivist`
+
+### hash
+
+`Lowercase`\<`string`\>
+
+### maxDepth
+
+`number` = `1`
+
+### minDepth
+
+`number` = `maxDepth`
+
+## Returns
+
+`Promise`\<`HydratedBlock`\>
+
+  ### <a id="hydrateElevatedTransaction"></a>hydrateElevatedTransaction
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function hydrateElevatedTransaction(archivist, hash): Promise<HydratedTransaction>;
+```
+
+## Parameters
+
+### archivist
+
+`ReadArchivist`
+
+### hash
+
+`Lowercase`\<`string`\>
+
+## Returns
+
+`Promise`\<`HydratedTransaction`\>
+
+  ### <a id="hydrateTransaction"></a>hydrateTransaction
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function hydrateTransaction(archivist, hash): Promise<HydratedTransaction>;
+```
+
+## Parameters
+
+### archivist
+
+`ReadArchivist`
+
+### hash
+
+`Lowercase`\<`string`\>
+
+## Returns
+
+`Promise`\<`HydratedTransaction`\>
+
+  ### <a id="isBalancesStepSummaryWithStorageMeta"></a>isBalancesStepSummaryWithStorageMeta
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function isBalancesStepSummaryWithStorageMeta(value): value is WithStorageMeta<BalancesStepSummary>;
+```
+
+Identity function for determining if an object is an BalancesStepSummary with Storage Meta
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is WithStorageMeta<BalancesStepSummary>`
+
+  ### <a id="isLocalhost"></a>isLocalhost
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function isLocalhost(hostname): boolean;
+```
+
+## Parameters
+
+### hostname
+
+`string`
+
+## Returns
+
+`boolean`
+
+  ### <a id="isNegativeBigInt"></a>isNegativeBigInt
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function isNegativeBigInt(value): value is NegativeBigInt;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is NegativeBigInt`
+
+  ### <a id="isPositiveBigInt"></a>isPositiveBigInt
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function isPositiveBigInt(value): value is PositiveBigInt;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is PositiveBigInt`
+
+  ### <a id="netBalancesForPayloads"></a>netBalancesForPayloads
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function netBalancesForPayloads(payloads): Record<Lowercase<string>, bigint>;
+```
+
+## Parameters
+
+### payloads
+
+`Payload`[]
+
+## Returns
+
+`Record`\<`Lowercase`\<`string`\>, `bigint`\>
+
+  ### <a id="parseSignedBigInt"></a>parseSignedBigInt
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function parseSignedBigInt(value): bigint;
+```
+
+## Parameters
+
+### value
+
+[`SignedBigInt`](#../type-aliases/SignedBigInt)
+
+## Returns
+
+`bigint`
+
+  ### <a id="toPositiveBigInt"></a>toPositiveBigInt
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function toPositiveBigInt(value): PositiveBigInt;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+[`PositiveBigInt`](#../interfaces/PositiveBigInt)
+
+  ### <a id="toSignedBigInt"></a>toSignedBigInt
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function toSignedBigInt(value): SignedBigInt;
+```
+
+## Parameters
+
+### value
+
+`bigint`
+
+## Returns
+
+[`SignedBigInt`](#../type-aliases/SignedBigInt)
+
+  ### <a id="transactionBlockByteCount"></a>transactionBlockByteCount
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function transactionBlockByteCount(__namedParameters): number;
+```
+
+The number of bytes that a transaction and its payloads will take up in a block
+
+## Parameters
+
+### \_\_namedParameters
+
+`HydratedTransaction`
+
+## Returns
+
+`number`
+
+  ### <a id="transactionBytesRequiredGas"></a>transactionBytesRequiredGas
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function transactionBytesRequiredGas(__namedParameters): AttoXL1;
+```
+
+The required gas for the byte storage on the block chain for a transaction
+
+## Parameters
+
+### \_\_namedParameters
+
+`HydratedTransaction`
+
+## Returns
+
+`AttoXL1`
+
+  ### <a id="transactionElevatedPayloadHashes"></a>transactionElevatedPayloadHashes
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function transactionElevatedPayloadHashes(transaction): Lowercase<string>[];
+```
+
+## Parameters
+
+### transaction
+
+`TransactionBoundWitness`
+
+## Returns
+
+`Lowercase`\<`string`\>[]
+
+  ### <a id="transactionElevatedPayloads"></a>transactionElevatedPayloads
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function transactionElevatedPayloads(__namedParameters): WithHashStorageMeta<Payload>[];
+```
+
+## Parameters
+
+### \_\_namedParameters
+
+`HydratedTransaction`
+
+## Returns
+
+`WithHashStorageMeta`\<`Payload`\>[]
+
+  ### <a id="transactionRequiredGas"></a>transactionRequiredGas
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function transactionRequiredGas(hydratedTransaction): AttoXL1;
+```
+
+## Parameters
+
+### hydratedTransaction
+
+`HydratedTransaction`
+
+## Returns
+
+`AttoXL1`
+
+  ### <a id="transactionsFromHydratedBlock"></a>transactionsFromHydratedBlock
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function transactionsFromHydratedBlock(block): WithStorageMeta<TransactionBoundWitness>[];
+```
+
+## Parameters
+
+### block
+
+`HydratedBlock`
+
+## Returns
+
+`WithStorageMeta`\<`TransactionBoundWitness`\>[]
+
+  ### <a id="tryHydrateBlock"></a>tryHydrateBlock
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function tryHydrateBlock(
+   archivist, 
+   hash, 
+maxDepth): Promise<undefined | HydratedBlock>;
+```
+
+## Parameters
+
+### archivist
+
+`ReadArchivist`
+
+### hash
+
+`Lowercase`\<`string`\>
+
+### maxDepth
+
+`number` = `1`
+
+## Returns
+
+`Promise`\<`undefined` \| `HydratedBlock`\>
+
+  ### <a id="tryHydrateElevatedTransaction"></a>tryHydrateElevatedTransaction
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function tryHydrateElevatedTransaction(archivist, hash): Promise<undefined | HydratedTransaction>;
+```
+
+## Parameters
+
+### archivist
+
+`ReadArchivist`
+
+### hash
+
+`Lowercase`\<`string`\>
+
+## Returns
+
+`Promise`\<`undefined` \| `HydratedTransaction`\>
+
+  ### <a id="tryHydrateTransaction"></a>tryHydrateTransaction
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+function tryHydrateTransaction(archivist, hash): Promise<undefined | HydratedTransaction>;
+```
+
+## Parameters
+
+### archivist
+
+`ReadArchivist`
+
+### hash
+
+`Lowercase`\<`string`\>
+
+## Returns
+
+`Promise`\<`undefined` \| `HydratedTransaction`\>
+
+### interfaces
+
+  ### <a id="AddressInstance"></a>AddressInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- [`ValidatableInstance`](#ValidatableInstance)
+
+## Extended by
+
+- [`AddressStateInstance`](#AddressStateInstance)
+
+## Properties
+
+### address
+
+```ts
+address: Lowercase<string>;
+```
+
+## Methods
+
+### validate()
+
+```ts
+validate(): Promisable<Error[]>;
+```
+
+### Returns
+
+`Promisable`\<`Error`[]\>
+
+### Inherited from
+
+[`ValidatableInstance`](#ValidatableInstance).[`validate`](ValidatableInstance.md#validate)
+
+  ### <a id="AddressStateInstance"></a>AddressStateInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- [`AddressInstance`](#AddressInstance).[`BlockWindowStateInstance`](#BlockWindowStateInstance)
+
+## Properties
+
+### address
+
+```ts
+address: Lowercase<string>;
+```
+
+### Inherited from
+
+[`AddressInstance`](#AddressInstance).[`address`](AddressInstance.md#address)
+
+***
+
+### blockWindow
+
+```ts
+blockWindow: BlockWindowInstance;
+```
+
+### Inherited from
+
+[`BlockWindowStateInstance`](#BlockWindowStateInstance).[`blockWindow`](BlockWindowStateInstance.md#blockwindow)
+
+## Methods
+
+### balance()
+
+```ts
+balance(): Promisable<[XL1AmountInstance, BlockWindowInstance]>;
+```
+
+### Returns
+
+`Promisable`\<\[[`XL1AmountInstance`](#XL1AmountInstance), [`BlockWindowInstance`](#BlockWindowInstance)\]\>
+
+***
+
+### validate()
+
+```ts
+validate(): Promisable<Error[]>;
+```
+
+### Returns
+
+`Promisable`\<`Error`[]\>
+
+### Inherited from
+
+[`AddressInstance`](#AddressInstance).[`validate`](AddressInstance.md#validate)
+
+  ### <a id="BalanceStepSummaryContext"></a>BalanceStepSummaryContext
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- [`ChainSummaryContext`](#ChainSummaryContext)\<[`BalancesStepSummary`](#../type-aliases/BalancesStepSummary)\>
+
+## Properties
+
+### chainArchivist
+
+```ts
+chainArchivist: ReadArchivist;
+```
+
+### Inherited from
+
+[`ChainSummaryContext`](#ChainSummaryContext).[`chainArchivist`](ChainSummaryContext.md#chainarchivist)
+
+***
+
+### head
+
+```ts
+head: Lowercase<string>;
+```
+
+### Inherited from
+
+[`ChainSummaryContext`](#ChainSummaryContext).[`head`](ChainSummaryContext.md#head)
+
+***
+
+### windowSize?
+
+```ts
+optional windowSize: number;
+```
+
+### Inherited from
+
+[`ChainSummaryContext`](#ChainSummaryContext).[`windowSize`](ChainSummaryContext.md#windowsize)
+
+***
+
+### summaryRepository
+
+```ts
+summaryRepository: PayloadRepository<Lowercase<string>, BalancesStepSummary>;
+```
+
+### Inherited from
+
+[`ChainSummaryContext`](#ChainSummaryContext).[`summaryRepository`](ChainSummaryContext.md#summaryrepository)
+
+  ### <a id="BlockWindowInstance"></a>BlockWindowInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Properties
+
+### count
+
+```ts
+count: number;
+```
+
+***
+
+### numberRange
+
+```ts
+numberRange: [number, number];
+```
+
+***
+
+### range
+
+```ts
+range: [Lowercase<string>, Lowercase<string>];
+```
+
+  ### <a id="BlockWindowStateInstance"></a>BlockWindowStateInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extended by
+
+- [`AddressStateInstance`](#AddressStateInstance)
+
+## Properties
+
+### blockWindow
+
+```ts
+blockWindow: BlockWindowInstance;
+```
+
+  ### <a id="BoundWitnessInstance"></a>BoundWitnessInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- [`PayloadInstance`](#PayloadInstance)\<`TBoundWitness`\>
+
+## Type Parameters
+
+### TBoundWitness
+
+`TBoundWitness` *extends* `BoundWitness` = `BoundWitness`
+
+### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+## Properties
+
+### payloadCount
+
+```ts
+payloadCount: number;
+```
+
+***
+
+### payloads
+
+```ts
+payloads: PayloadInstance<TPayload>[];
+```
+
+***
+
+### data
+
+```ts
+data: TBoundWitness;
+```
+
+### Inherited from
+
+[`PayloadInstance`](#PayloadInstance).[`data`](PayloadInstance.md#data)
+
+## Methods
+
+### payload()
+
+```ts
+payload(index): undefined | PayloadInstance<TPayload>;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| [`PayloadInstance`](#PayloadInstance)\<`TPayload`\>
+
+***
+
+### validate()
+
+```ts
+validate(): Promisable<Error[]>;
+```
+
+### Returns
+
+`Promisable`\<`Error`[]\>
+
+### Inherited from
+
+[`PayloadInstance`](#PayloadInstance).[`validate`](PayloadInstance.md#validate)
+
+  ### <a id="ChainContext"></a>ChainContext
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extended by
+
+- [`ChainSummaryContext`](#ChainSummaryContext)
+
+## Properties
+
+### chainArchivist
+
+```ts
+chainArchivist: ReadArchivist;
+```
+
+***
+
+### head
+
+```ts
+head: Lowercase<string>;
+```
+
+***
+
+### windowSize?
+
+```ts
+optional windowSize: number;
+```
+
+  ### <a id="ChainServiceCollection"></a>ChainServiceCollection
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Deprecated
+
+use ChainServiceCollectionV2
+
+## Properties
+
+### ~~account~~
+
+```ts
+account: WalletInstance;
+```
+
+The account which is used to sign transactions
+
+***
+
+### ~~balanceService~~
+
+```ts
+balanceService: AccountBalanceService;
+```
+
+Services for working with account balances
+
+***
+
+### ~~chainArchivist~~
+
+```ts
+chainArchivist: ArchivistInstance;
+```
+
+The archivist which the chain data is stored in
+
+***
+
+### ~~chainContractViewer~~
+
+```ts
+chainContractViewer: ChainContractViewer;
+```
+
+Service for viewing codified chain information
+from a contract
+
+***
+
+### ~~chainIterator?~~
+
+```ts
+optional chainIterator: EventingChainBlockNumberIterator;
+```
+
+The chain iterator
+
+***
+
+### ~~chainStakeViewer~~
+
+```ts
+chainStakeViewer: ChainStakeViewer;
+```
+
+Service for viewing stake information
+
+***
+
+### ~~chainStaker~~
+
+```ts
+chainStaker: ChainStaker;
+```
+
+Service for staking
+
+***
+
+### ~~chainSubmissionsArchivistWrite~~
+
+```ts
+chainSubmissionsArchivistWrite: WriteArchivist;
+```
+
+The archivist which the chain submissions are stored in
+
+***
+
+### ~~electionService~~
+
+```ts
+electionService: ElectionService;
+```
+
+Service for determining leader election
+
+***
+
+### ~~pendingBundledTransactionsArchivistWrite~~
+
+```ts
+pendingBundledTransactionsArchivistWrite: ArchivistInstance;
+```
+
+The archivist which the pending transactions are stored
+as bundled transactions
+
+***
+
+### ~~producer~~
+
+```ts
+producer: BlockProducerService;
+```
+
+The block producer service
+
+***
+
+### ~~rewardService~~
+
+```ts
+rewardService: BlockRewardService;
+```
+
+Service response for calculating block rewards
+
+***
+
+### ~~stakeIntentService~~
+
+```ts
+stakeIntentService: StakeIntentService;
+```
+
+Services for working with staked intents
+
+  ### <a id="ChainServiceCollectionV2"></a>ChainServiceCollectionV2
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Properties
+
+### account
+
+```ts
+account: WalletInstance;
+```
+
+The account which is used to sign transactions
+
+***
+
+### balanceService
+
+```ts
+balanceService: AccountBalanceServiceV2;
+```
+
+Services for working with account balances
+
+***
+
+### chainArchivist
+
+```ts
+chainArchivist: ArchivistInstance;
+```
+
+The archivist which the chain data is stored in
+
+***
+
+### chainContractViewer
+
+```ts
+chainContractViewer: ChainContractViewer;
+```
+
+Service for viewing codified chain information
+from a contract
+
+***
+
+### chainIterator?
+
+```ts
+optional chainIterator: EventingChainBlockNumberIterator;
+```
+
+The chain iterator
+
+***
+
+### chainStakeViewer
+
+```ts
+chainStakeViewer: ChainStakeViewer;
+```
+
+Service for viewing stake information
+
+***
+
+### chainStaker
+
+```ts
+chainStaker: ChainStaker;
+```
+
+Service for staking
+
+***
+
+### chainSubmissionsArchivistWrite
+
+```ts
+chainSubmissionsArchivistWrite: WriteArchivist;
+```
+
+The archivist which the chain submissions are stored in
+
+***
+
+### electionService
+
+```ts
+electionService: ElectionService;
+```
+
+Service for determining leader election
+
+***
+
+### pendingBundledTransactionsArchivistWrite
+
+```ts
+pendingBundledTransactionsArchivistWrite: ArchivistInstance;
+```
+
+The archivist which the pending transactions are stored
+as bundled transactions
+
+***
+
+### pendingTransactionsService
+
+```ts
+pendingTransactionsService: PendingTransactionsService;
+```
+
+Service for managing pending transactions
+
+***
+
+### producer
+
+```ts
+producer: BlockProducerService;
+```
+
+The block producer service
+
+***
+
+### rewardService
+
+```ts
+rewardService: BlockRewardService;
+```
+
+Service response for calculating block rewards
+
+***
+
+### stakeIntentService
+
+```ts
+stakeIntentService: StakeIntentService;
+```
+
+Services for working with staked intents
+
+  ### <a id="ChainSummaryContext"></a>ChainSummaryContext
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- [`ChainContext`](#ChainContext)
+
+## Extended by
+
+- [`BalanceStepSummaryContext`](#BalanceStepSummaryContext)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload`
+
+## Properties
+
+### chainArchivist
+
+```ts
+chainArchivist: ReadArchivist;
+```
+
+### Inherited from
+
+[`ChainContext`](#ChainContext).[`chainArchivist`](ChainContext.md#chainarchivist)
+
+***
+
+### head
+
+```ts
+head: Lowercase<string>;
+```
+
+### Inherited from
+
+[`ChainContext`](#ChainContext).[`head`](ChainContext.md#head)
+
+***
+
+### windowSize?
+
+```ts
+optional windowSize: number;
+```
+
+### Inherited from
+
+[`ChainContext`](#ChainContext).[`windowSize`](ChainContext.md#windowsize)
+
+***
+
+### summaryRepository
+
+```ts
+summaryRepository: PayloadRepository<Lowercase<string>, T>;
+```
+
+  ### <a id="ChainWindow"></a>ChainWindow
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Properties
+
+### depth
+
+```ts
+depth: number;
+```
+
+***
+
+### head
+
+```ts
+head: Lowercase<string>;
+```
+
+  ### <a id="DataInstance"></a>DataInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extended by
+
+- [`ObjectInstance`](#ObjectInstance)
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### data
+
+```ts
+data: T;
+```
+
+  ### <a id="HydratedBlockInstance"></a>HydratedBlockInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- `BlockFieldsInstance`\<[`HydratedTransactionInstance`](#HydratedTransactionInstance)\>.`HydratedBoundWitnessInstance`\<`T`\>.[`SignedInstance`](#SignedInstance)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `HydratedBlock` = `HydratedBlock`
+
+## Properties
+
+### data
+
+```ts
+data: T;
+```
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.data
+```
+
+***
+
+### boundWitness
+
+```ts
+boundWitness: T[0];
+```
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.boundWitness
+```
+
+***
+
+### payloadCount
+
+```ts
+payloadCount: number;
+```
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.payloadCount
+```
+
+***
+
+### payloads
+
+```ts
+payloads: T[1][number][];
+```
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.payloads
+```
+
+***
+
+### reward
+
+```ts
+reward: bigint;
+```
+
+### Inherited from
+
+```ts
+BlockFieldsInstance.reward
+```
+
+***
+
+### signatureCount
+
+```ts
+signatureCount: number;
+```
+
+### Inherited from
+
+[`SignedInstance`](#SignedInstance).[`signatureCount`](SignedInstance.md#signaturecount)
+
+***
+
+### signatures
+
+```ts
+signatures: SignatureInstance[];
+```
+
+### Inherited from
+
+[`SignedInstance`](#SignedInstance).[`signatures`](SignedInstance.md#signatures)
+
+***
+
+### transactionCount
+
+```ts
+transactionCount: number;
+```
+
+### Inherited from
+
+```ts
+BlockFieldsInstance.transactionCount
+```
+
+***
+
+### transactions
+
+```ts
+transactions: HydratedTransactionInstance<HydratedTransaction, AllowedBlockPayload>[];
+```
+
+### Inherited from
+
+```ts
+BlockFieldsInstance.transactions
+```
+
+## Methods
+
+### payload()
+
+```ts
+payload(index): undefined | T[1][number];
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| `T`\[`1`\]\[`number`\]
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.payload
+```
+
+***
+
+### signature()
+
+```ts
+signature(index): undefined | SignatureInstance;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| [`SignatureInstance`](#SignatureInstance)
+
+### Inherited from
+
+[`SignedInstance`](#SignedInstance).[`signature`](SignedInstance.md#signature)
+
+***
+
+### transaction()
+
+```ts
+transaction(index): 
+  | undefined
+| HydratedTransactionInstance<HydratedTransaction, AllowedBlockPayload>;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+  \| `undefined`
+  \| [`HydratedTransactionInstance`](#HydratedTransactionInstance)\<`HydratedTransaction`, `AllowedBlockPayload`\>
+
+### Inherited from
+
+```ts
+BlockFieldsInstance.transaction
+```
+
+***
+
+### validate()
+
+```ts
+validate(): Promisable<Error[]>;
+```
+
+### Returns
+
+`Promisable`\<`Error`[]\>
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.validate
+```
+
+  ### <a id="HydratedTransactionInstance"></a>HydratedTransactionInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- `TransactionFieldsInstance`\<`T`\[`1`\]\[`number`\] & `TElevatedPayload`\>.`HydratedBoundWitnessInstance`\<`T`\>.[`SignedInstance`](#SignedInstance)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `HydratedTransaction` = `HydratedTransaction`
+
+### TElevatedPayload
+
+`TElevatedPayload` *extends* `AllowedBlockPayload` = `AllowedBlockPayload`
+
+## Properties
+
+### data
+
+```ts
+data: T;
+```
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.data
+```
+
+***
+
+### boundWitness
+
+```ts
+boundWitness: T[0];
+```
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.boundWitness
+```
+
+***
+
+### payloadCount
+
+```ts
+payloadCount: number;
+```
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.payloadCount
+```
+
+***
+
+### payloads
+
+```ts
+payloads: T[1][number][];
+```
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.payloads
+```
+
+***
+
+### signatureCount
+
+```ts
+signatureCount: number;
+```
+
+### Inherited from
+
+[`SignedInstance`](#SignedInstance).[`signatureCount`](SignedInstance.md#signaturecount)
+
+***
+
+### signatures
+
+```ts
+signatures: SignatureInstance[];
+```
+
+### Inherited from
+
+[`SignedInstance`](#SignedInstance).[`signatures`](SignedInstance.md#signatures)
+
+***
+
+### elevatedPayloadCount
+
+```ts
+elevatedPayloadCount: number;
+```
+
+### Inherited from
+
+```ts
+TransactionFieldsInstance.elevatedPayloadCount
+```
+
+***
+
+### elevatedPayloads
+
+```ts
+elevatedPayloads: WithStorageMeta<T[1][number] & TElevatedPayload>[];
+```
+
+### Inherited from
+
+```ts
+TransactionFieldsInstance.elevatedPayloads
+```
+
+***
+
+### externalPayloads
+
+```ts
+externalPayloads: Record<Hash, Schema | Payload>;
+```
+
+### Inherited from
+
+```ts
+TransactionFieldsInstance.externalPayloads
+```
+
+***
+
+### fees
+
+```ts
+fees: TransactionFeesInstance;
+```
+
+### Inherited from
+
+```ts
+TransactionFieldsInstance.fees
+```
+
+***
+
+### privateExternalPayloads
+
+```ts
+privateExternalPayloads: Record<Hash, Schema>;
+```
+
+### Inherited from
+
+```ts
+TransactionFieldsInstance.privateExternalPayloads
+```
+
+***
+
+### publicExternalPayloads
+
+```ts
+publicExternalPayloads: Payload[];
+```
+
+### Inherited from
+
+```ts
+TransactionFieldsInstance.publicExternalPayloads
+```
+
+## Methods
+
+### payload()
+
+```ts
+payload(index): undefined | T[1][number];
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| `T`\[`1`\]\[`number`\]
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.payload
+```
+
+***
+
+### signature()
+
+```ts
+signature(index): undefined | SignatureInstance;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| [`SignatureInstance`](#SignatureInstance)
+
+### Inherited from
+
+[`SignedInstance`](#SignedInstance).[`signature`](SignedInstance.md#signature)
+
+***
+
+### validate()
+
+```ts
+validate(): Promisable<Error[]>;
+```
+
+### Returns
+
+`Promisable`\<`Error`[]\>
+
+### Inherited from
+
+```ts
+HydratedBoundWitnessInstance.validate
+```
+
+***
+
+### elevatedPayload()
+
+```ts
+elevatedPayload(index): undefined | T[1][number] & TElevatedPayload;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| `T`\[`1`\]\[`number`\] & `TElevatedPayload`
+
+### Inherited from
+
+```ts
+TransactionFieldsInstance.elevatedPayload
+```
+
+***
+
+### reward()
+
+```ts
+reward(): bigint;
+```
+
+### Returns
+
+`bigint`
+
+### Inherited from
+
+```ts
+TransactionFieldsInstance.reward
+```
+
+  ### <a id="NegativeBigInt"></a>NegativeBigInt
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Properties
+
+### negative
+
+```ts
+negative: Lowercase<string>;
+```
+
+  ### <a id="ObjectInstance"></a>ObjectInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- [`DataInstance`](#DataInstance)\<`T`\>
+
+## Extended by
+
+- [`PayloadInstance`](#PayloadInstance)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject` = `EmptyObject`
+
+## Properties
+
+### data
+
+```ts
+data: T;
+```
+
+### Inherited from
+
+[`DataInstance`](#DataInstance).[`data`](DataInstance.md#data)
+
+  ### <a id="PayloadInstance"></a>PayloadInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- [`ObjectInstance`](#ObjectInstance)\<`TPayload`\>.[`ValidatableInstance`](#ValidatableInstance)
+
+## Extended by
+
+- [`BoundWitnessInstance`](#BoundWitnessInstance)
+
+## Type Parameters
+
+### TPayload
+
+`TPayload` *extends* `Payload` = `Payload`
+
+## Properties
+
+### data
+
+```ts
+data: TPayload;
+```
+
+### Inherited from
+
+[`ObjectInstance`](#ObjectInstance).[`data`](ObjectInstance.md#data)
+
+## Methods
+
+### validate()
+
+```ts
+validate(): Promisable<Error[]>;
+```
+
+### Returns
+
+`Promisable`\<`Error`[]\>
+
+### Inherited from
+
+[`ValidatableInstance`](#ValidatableInstance).[`validate`](ValidatableInstance.md#validate)
+
+  ### <a id="PositiveBigInt"></a>PositiveBigInt
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Properties
+
+### positive
+
+```ts
+positive: Lowercase<string>;
+```
+
+  ### <a id="ShiftedBigIntConfig"></a>ShiftedBigIntConfig
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Properties
+
+### locale
+
+```ts
+locale: LocalesArgument;
+```
+
+***
+
+### maxCharacters
+
+```ts
+maxCharacters: number;
+```
+
+***
+
+### maxDecimal
+
+```ts
+maxDecimal: number;
+```
+
+***
+
+### minDecimals
+
+```ts
+minDecimals: number;
+```
+
+***
+
+### places
+
+```ts
+places: number;
+```
+
+  ### <a id="SignatureInstance"></a>SignatureInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- [`ValidatableInstance`](#ValidatableInstance)
+
+## Properties
+
+### address
+
+```ts
+address: Lowercase<string>;
+```
+
+***
+
+### hash
+
+```ts
+hash: Lowercase<string>;
+```
+
+***
+
+### signature
+
+```ts
+signature: Lowercase<string>;
+```
+
+## Methods
+
+### validate()
+
+```ts
+validate(): Promisable<Error[]>;
+```
+
+### Returns
+
+`Promisable`\<`Error`[]\>
+
+### Inherited from
+
+[`ValidatableInstance`](#ValidatableInstance).[`validate`](ValidatableInstance.md#validate)
+
+  ### <a id="SignedInstance"></a>SignedInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extended by
+
+- [`HydratedBlockInstance`](#HydratedBlockInstance)
+- [`HydratedTransactionInstance`](#HydratedTransactionInstance)
+
+## Properties
+
+### signatureCount
+
+```ts
+signatureCount: number;
+```
+
+***
+
+### signatures
+
+```ts
+signatures: SignatureInstance[];
+```
+
+## Methods
+
+### signature()
+
+```ts
+signature(index): undefined | SignatureInstance;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| [`SignatureInstance`](#SignatureInstance)
+
+  ### <a id="StepSummaryFields"></a>StepSummaryFields
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Properties
+
+### hash
+
+```ts
+hash: Lowercase<string>;
+```
+
+***
+
+### stepSize
+
+```ts
+stepSize: number;
+```
+
+  ### <a id="TransactionFeesInstance"></a>TransactionFeesInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extends
+
+- [`ValidatableInstance`](#ValidatableInstance)
+
+## Properties
+
+### base
+
+```ts
+base: bigint;
+```
+
+***
+
+### gasLimit
+
+```ts
+gasLimit: bigint;
+```
+
+***
+
+### gasPrice
+
+```ts
+gasPrice: bigint;
+```
+
+***
+
+### priority
+
+```ts
+priority: bigint;
+```
+
+## Methods
+
+### validate()
+
+```ts
+validate(): Promisable<Error[]>;
+```
+
+### Returns
+
+`Promisable`\<`Error`[]\>
+
+### Inherited from
+
+[`ValidatableInstance`](#ValidatableInstance).[`validate`](ValidatableInstance.md#validate)
+
+  ### <a id="ValidatableInstance"></a>ValidatableInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Extended by
+
+- [`AddressInstance`](#AddressInstance)
+- [`TransactionFeesInstance`](#TransactionFeesInstance)
+- [`PayloadInstance`](#PayloadInstance)
+- [`SignatureInstance`](#SignatureInstance)
+
+## Methods
+
+### validate()
+
+```ts
+validate(): Promisable<Error[]>;
+```
+
+### Returns
+
+`Promisable`\<`Error`[]\>
+
+  ### <a id="XL1AmountInstance"></a>XL1AmountInstance
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+## Properties
+
+### value
+
+```ts
+value: AttoXL1;
+```
+
+***
+
+### milli
+
+```ts
+milli: MilliXL1;
+```
+
+***
+
+### micro
+
+```ts
+micro: MicroXL1;
+```
+
+***
+
+### nano
+
+```ts
+nano: NanoXL1;
+```
+
+***
+
+### pico
+
+```ts
+pico: PicoXL1;
+```
+
+***
+
+### femto
+
+```ts
+femto: FemtoXL1;
+```
+
+***
+
+### atto
+
+```ts
+atto: AttoXL1;
+```
+
+## Methods
+
+### to()
+
+```ts
+to(places): bigint;
+```
+
+### Parameters
+
+#### places
+
+`number` | `bigint`
+
+### Returns
+
+`bigint`
+
+***
+
+### toString()
+
+```ts
+toString(places, config): string;
+```
+
+### Parameters
+
+#### places
+
+`number`
+
+#### config
+
+`Partial`\<[`ShiftedBigIntConfig`](#ShiftedBigIntConfig)\>
+
+### Returns
+
+`string`
+
+### type-aliases
+
+  ### <a id="BalancesStepSummary"></a>BalancesStepSummary
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+type BalancesStepSummary = StepSummary<{
+  balances: Record<Address, SignedBigInt>;
+}, BalancesStepSummarySchema>;
+```
+
+  ### <a id="BalancesStepSummarySchema"></a>BalancesStepSummarySchema
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+type BalancesStepSummarySchema = typeof BalancesStepSummarySchema;
+```
+
+  ### <a id="BlockNumberRange"></a>BlockNumberRange
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+type BlockNumberRange = [number, number];
+```
+
+  ### <a id="Config"></a>Config
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+type Config = z.infer<typeof ConfigSchema>;
+```
+
+  ### <a id="MnemonicString"></a>MnemonicString
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+type MnemonicString = z.infer<typeof MnemonicStringSchema>;
+```
+
+  ### <a id="SignedBigInt"></a>SignedBigInt
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+type SignedBigInt = 
+  | NegativeBigInt
+  | PositiveBigInt;
+```
+
+  ### <a id="StepSummary"></a>StepSummary
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+type StepSummary<TAdditionalFields, TSchema> = Payload<TAdditionalFields extends void ? StepSummaryFields : TAdditionalFields & StepSummaryFields, TSchema extends void ? StepSummarySchema : TSchema>;
+```
+
+## Type Parameters
+
+### TAdditionalFields
+
+`TAdditionalFields` *extends* `EmptyObject` \| `void` = `void`
+
+### TSchema
+
+`TSchema` *extends* `Schema` \| `void` = `void`
+
+  ### <a id="StepSummarySchema"></a>StepSummarySchema
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+type StepSummarySchema = typeof StepSummarySchema;
+```
+
+### variables
+
+  ### <a id="BalancesStepSummarySchema"></a>BalancesStepSummarySchema
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+const BalancesStepSummarySchema: Schema = 'network.xyo.step.summary.balances';
+```
+
+  ### <a id="ConfigSchema"></a>ConfigSchema
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+const ConfigSchema: ZodObject<{
+  silent: ZodDefault<ZodBoolean>;
+  logLevel: ZodDefault<ZodEnum<["error" | "warn" | "info" | "log" | "debug" | "trace", ...("error" | "warn" | "info" | "log" | "debug" | "trace")[]]>>;
+  api: ZodDefault<ZodObject<{
+     mnemonic: ZodOptional<ZodEffects<ZodEffects<ZodString, string, string>, string, string>>;
+     host: ZodDefault<ZodString>;
+     port: ZodDefault<ZodNumber>;
+   }, "strip", ZodTypeAny, {
+     mnemonic?: string;
+     host: string;
+     port: number;
+   }, {
+     mnemonic?: string;
+     host?: string;
+     port?: number;
+  }>>;
+  app: ZodDefault<ZodObject<{
+     port: ZodDefault<ZodNumber>;
+   }, "strip", ZodTypeAny, {
+     port: number;
+   }, {
+     port?: number;
+  }>>;
+  chain: ZodDefault<ZodObject<{
+     id: ZodOptional<ZodString>;
+   }, "strip", ZodTypeAny, {
+     id?: string;
+   }, {
+     id?: string;
+  }>>;
+  evm: ZodDefault<ZodObject<{
+     chainId: ZodOptional<ZodString>;
+     infura: ZodOptional<ZodObject<{
+        projectId: ZodOptional<ZodString>;
+        projectSecret: ZodOptional<ZodString>;
+      }, "strip", ZodTypeAny, {
+        projectId?: string;
+        projectSecret?: string;
+      }, {
+        projectId?: string;
+        projectSecret?: string;
+     }>>;
+     jsonRpc: ZodOptional<ZodObject<{
+        url: ZodOptional<ZodString>;
+      }, "strip", ZodTypeAny, {
+        url?: string;
+      }, {
+        url?: string;
+     }>>;
+   }, "strip", ZodTypeAny, {
+     chainId?: string;
+     infura?: {
+        projectId?: string;
+        projectSecret?: string;
+     };
+     jsonRpc?: {
+        url?: string;
+     };
+   }, {
+     chainId?: string;
+     infura?: {
+        projectId?: string;
+        projectSecret?: string;
+     };
+     jsonRpc?: {
+        url?: string;
+     };
+  }>>;
+  producer: ZodDefault<ZodObject<{
+     healthCheckPort: ZodOptional<ZodNumber>;
+     minStake: ZodDefault<ZodNumber>;
+     mnemonic: ZodOptional<ZodEffects<ZodEffects<ZodString, string, string>, string, string>>;
+     port: ZodDefault<ZodNumber>;
+     disableIntentRedeclaration: ZodOptional<ZodBoolean>;
+     rewardAddress: ZodOptional<ZodString>;
+   }, "strip", ZodTypeAny, {
+     healthCheckPort?: number;
+     minStake: number;
+     mnemonic?: string;
+     port: number;
+     disableIntentRedeclaration?: boolean;
+     rewardAddress?: string;
+   }, {
+     healthCheckPort?: number;
+     minStake?: number;
+     mnemonic?: string;
+     port?: number;
+     disableIntentRedeclaration?: boolean;
+     rewardAddress?: string;
+  }>>;
+  storage: ZodDefault<ZodObject<{
+     mongo: ZodOptional<ZodObject<{
+        connectionString: ZodOptional<ZodString>;
+        database: ZodOptional<ZodString>;
+        domain: ZodOptional<ZodString>;
+        password: ZodOptional<ZodString>;
+        username: ZodOptional<ZodString>;
+      }, "strip", ZodTypeAny, {
+        connectionString?: string;
+        database?: string;
+        domain?: string;
+        password?: string;
+        username?: string;
+      }, {
+        connectionString?: string;
+        database?: string;
+        domain?: string;
+        password?: string;
+        username?: string;
+     }>>;
+     root: ZodOptional<ZodString>;
+   }, "strip", ZodTypeAny, {
+     mongo?: {
+        connectionString?: string;
+        database?: string;
+        domain?: string;
+        password?: string;
+        username?: string;
+     };
+     root?: string;
+   }, {
+     mongo?: {
+        connectionString?: string;
+        database?: string;
+        domain?: string;
+        password?: string;
+        username?: string;
+     };
+     root?: string;
+  }>>;
+  telemetry: ZodDefault<ZodObject<{
+     otel: ZodOptional<ZodObject<{
+        otlpEndpoint: ZodOptional<ZodString>;
+      }, "strip", ZodTypeAny, {
+        otlpEndpoint?: string;
+      }, {
+        otlpEndpoint?: string;
+     }>>;
+   }, "strip", ZodTypeAny, {
+     otel?: {
+        otlpEndpoint?: string;
+     };
+   }, {
+     otel?: {
+        otlpEndpoint?: string;
+     };
+  }>>;
+}, "strip", ZodTypeAny, {
+  silent: boolean;
+  logLevel: "error" | "warn" | "info" | "log" | "debug" | "trace";
+  api: {
+     mnemonic?: string;
+     host: string;
+     port: number;
+  };
+  app: {
+     port: number;
+  };
+  chain: {
+     id?: string;
+  };
+  evm: {
+     chainId?: string;
+     infura?: {
+        projectId?: string;
+        projectSecret?: string;
+     };
+     jsonRpc?: {
+        url?: string;
+     };
+  };
+  producer: {
+     healthCheckPort?: number;
+     minStake: number;
+     mnemonic?: string;
+     port: number;
+     disableIntentRedeclaration?: boolean;
+     rewardAddress?: string;
+  };
+  storage: {
+     mongo?: {
+        connectionString?: string;
+        database?: string;
+        domain?: string;
+        password?: string;
+        username?: string;
+     };
+     root?: string;
+  };
+  telemetry: {
+     otel?: {
+        otlpEndpoint?: string;
+     };
+  };
+}, {
+  silent?: boolean;
+  logLevel?: "error" | "warn" | "info" | "log" | "debug" | "trace";
+  api?: {
+     mnemonic?: string;
+     host?: string;
+     port?: number;
+  };
+  app?: {
+     port?: number;
+  };
+  chain?: {
+     id?: string;
+  };
+  evm?: {
+     chainId?: string;
+     infura?: {
+        projectId?: string;
+        projectSecret?: string;
+     };
+     jsonRpc?: {
+        url?: string;
+     };
+  };
+  producer?: {
+     healthCheckPort?: number;
+     minStake?: number;
+     mnemonic?: string;
+     port?: number;
+     disableIntentRedeclaration?: boolean;
+     rewardAddress?: string;
+  };
+  storage?: {
+     mongo?: {
+        connectionString?: string;
+        database?: string;
+        domain?: string;
+        password?: string;
+        username?: string;
+     };
+     root?: string;
+  };
+  telemetry?: {
+     otel?: {
+        otlpEndpoint?: string;
+     };
+  };
+}>;
+```
+
+  ### <a id="MnemonicStringSchema"></a>MnemonicStringSchema
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+const MnemonicStringSchema: ZodEffects<ZodEffects<ZodString, string, string>, string, string>;
+```
+
+Validates a single string containing a BIP-39 mnemonic.
+
+• Trims leading/trailing whitespace.
+• Collapses any run of whitespace (spaces, tabs, new-lines) to a single space.
+• Splits on spaces → array of words.
+• Checks that the word-count is 12, 15, 18, 21, or 24.
+
+  ### <a id="StepSummarySchema"></a>StepSummarySchema
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+const StepSummarySchema: Schema = 'network.xyo.step.summary';
+```
+
+  ### <a id="TODO"></a>TODO
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+const TODO: true = true;
+```
+
+  ### <a id="Xl1CommonConfigSchema"></a>Xl1CommonConfigSchema
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+const Xl1CommonConfigSchema: ZodObject<{
+  silent: ZodDefault<ZodBoolean>;
+  logLevel: ZodDefault<ZodEnum<["error" | "warn" | "info" | "log" | "debug" | "trace", ...("error" | "warn" | "info" | "log" | "debug" | "trace")[]]>>;
+}, "strip", ZodTypeAny, {
+  silent: boolean;
+  logLevel: "error" | "warn" | "info" | "log" | "debug" | "trace";
+}, {
+  silent?: boolean;
+  logLevel?: "error" | "warn" | "info" | "log" | "debug" | "trace";
+}>;
+```
+
+  ### <a id="asBalancesStepSummary"></a>asBalancesStepSummary
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+const asBalancesStepSummary: AsTypeFunction<BalancesStepSummary>;
+```
+
+  ### <a id="asBalancesStepSummaryWithStorageMeta"></a>asBalancesStepSummaryWithStorageMeta
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+const asBalancesStepSummaryWithStorageMeta: AsTypeFunction<WithStorageMeta<BalancesStepSummary>>;
+```
+
+  ### <a id="isBalancesStepSummary"></a>isBalancesStepSummary
+
+[**@xyo-network/xl1-protocol-sdk**](#../README)
+
+***
+
+```ts
+const isBalancesStepSummary: (x?) => x is BalancesStepSummary;
+```
+
+Identity function for determining if an object is an BalancesStepSummary
+
+## Parameters
+
+### x?
+
+`unknown`
+
+## Returns
+
+`x is BalancesStepSummary`
+
 
 ## Maintainers