@xyo-network/xl1-wrappers 1.7.15

package/README.md

@@ -0,0 +1,2531 @@
+# @xyo-network/chain-wrappers
+
+[![logo][]](https://xyo.network)
+
+[![npm-badge][]][npm-link]
+[![npm-downloads-badge][]][npm-link]
+[![jsdelivr-badge][]][jsdelivr-link]
+[![npm-license-badge][]](LICENSE)
+[![socket-badge][]][socket-link]
+
+XYO Layer One SDK Wrappers
+
+
+
+## Reference
+
+**@xyo-network/chain-wrappers**
+
+***
+
+## Classes
+
+- [FeesWrapper](#classes/FeesWrapper)
+- [SignatureWrapper](#classes/SignatureWrapper)
+- [ShiftedBigInt](#classes/ShiftedBigInt)
+- [XL1Amount](#classes/XL1Amount)
+- [HydratedBlockWrapper](#classes/HydratedBlockWrapper)
+- [IndexedHydratedBlockRangeStore](#classes/IndexedHydratedBlockRangeStore)
+- [HydratedTransactionWrapper](#classes/HydratedTransactionWrapper)
+
+## Interfaces
+
+- [XL1AmountInstance](#interfaces/XL1AmountInstance)
+- [HydratedBlockStoreInstance](#interfaces/HydratedBlockStoreInstance)
+- [IndexedHydratedBlockStoreInstance](#interfaces/IndexedHydratedBlockStoreInstance)
+- [HydratedBlockRangeStoreParams](#interfaces/HydratedBlockRangeStoreParams)
+- [IndexedHydratedBlockRangeStoreInstance](#interfaces/IndexedHydratedBlockRangeStoreInstance)
+
+## Type Aliases
+
+- [HydratedBlockStoreParams](#type-aliases/HydratedBlockStoreParams)
+
+## Functions
+
+- [splitOnDecimal](#functions/splitOnDecimal)
+- [splitOnDecimalToString](#functions/splitOnDecimalToString)
+
+### classes
+
+  ### <a id="FeesWrapper"></a>FeesWrapper
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Implements
+
+- `TransactionFeesInstance`
+
+## Constructors
+
+### Constructor
+
+```ts
+new FeesWrapper(__namedParameters): FeesWrapper;
+```
+
+### Parameters
+
+#### \_\_namedParameters
+
+`TransactionFeesHex` | `TransactionFeesBigInt`
+
+### Returns
+
+`FeesWrapper`
+
+## Properties
+
+### base
+
+```ts
+base: AttoXL1;
+```
+
+### Implementation of
+
+```ts
+TransactionFeesInstance.base
+```
+
+***
+
+### gasLimit
+
+```ts
+gasLimit: AttoXL1;
+```
+
+### Implementation of
+
+```ts
+TransactionFeesInstance.gasLimit
+```
+
+***
+
+### gasPrice
+
+```ts
+gasPrice: AttoXL1;
+```
+
+### Implementation of
+
+```ts
+TransactionFeesInstance.gasPrice
+```
+
+***
+
+### priority
+
+```ts
+priority: AttoXL1;
+```
+
+### Implementation of
+
+```ts
+TransactionFeesInstance.priority
+```
+
+## Methods
+
+### validate()
+
+```ts
+static validate(__namedParameters): Promisable<Error[]>;
+```
+
+### Parameters
+
+#### \_\_namedParameters
+
+`TransactionFeesHex` | `TransactionFeesBigInt`
+
+### Returns
+
+`Promisable`\<`Error`[]\>
+
+***
+
+### validate()
+
+```ts
+validate(): Promise<Error[]>;
+```
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+### Implementation of
+
+```ts
+TransactionFeesInstance.validate
+```
+
+  ### <a id="HydratedBlockWrapper"></a>HydratedBlockWrapper
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Type Parameters
+
+### T
+
+`T` *extends* `HydratedBlock`
+
+## Implements
+
+- `HydratedBlockInstance`\<\[`WithHashStorageMeta`\<`T`\[`0`\]\>, `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>[]\]\>
+
+## Constructors
+
+### Constructor
+
+```ts
+protected new HydratedBlockWrapper<T>(data): HydratedBlockWrapper<T>;
+```
+
+### Parameters
+
+#### data
+
+\[`WithHashStorageMeta`\<`T`\[`0`\]\>, `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>[]\]
+
+### Returns
+
+`HydratedBlockWrapper`\<`T`\>
+
+## Properties
+
+### data
+
+```ts
+data: [WithHashStorageMeta<T[0]>, WithHashStorageMeta<T[1][number]>[]];
+```
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.data
+```
+
+***
+
+### allPayloadsCache
+
+```ts
+protected allPayloadsCache: WithHashStorageMeta<WithHashStorageMeta<T[1][number]>>[] = [];
+```
+
+***
+
+### transactionsCache
+
+```ts
+protected transactionsCache: HydratedTransactionInstance<HydratedTransaction, AllowedBlockPayload>[] = [];
+```
+
+## Accessors
+
+### block
+
+### Get Signature
+
+```ts
+get block(): number;
+```
+
+#### Returns
+
+`number`
+
+***
+
+### boundWitness
+
+### Get Signature
+
+```ts
+get boundWitness(): WithHashStorageMeta<T[0]>;
+```
+
+#### Returns
+
+`WithHashStorageMeta`\<`T`\[`0`\]\>
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.boundWitness
+```
+
+***
+
+### chain
+
+### Get Signature
+
+```ts
+get chain(): Lowercase<string>;
+```
+
+#### Returns
+
+`Lowercase`\<`string`\>
+
+***
+
+### payloadCount
+
+### Get Signature
+
+```ts
+get payloadCount(): number;
+```
+
+#### Returns
+
+`number`
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.payloadCount
+```
+
+***
+
+### payloads
+
+### Get Signature
+
+```ts
+get payloads(): T[1][number][];
+```
+
+#### Returns
+
+`T`\[`1`\]\[`number`\][]
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.payloads
+```
+
+***
+
+### reward
+
+### Get Signature
+
+```ts
+get reward(): bigint;
+```
+
+#### Returns
+
+`bigint`
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.reward
+```
+
+***
+
+### signatureCount
+
+### Get Signature
+
+```ts
+get signatureCount(): number;
+```
+
+#### Returns
+
+`number`
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.signatureCount
+```
+
+***
+
+### signatures
+
+### Get Signature
+
+```ts
+get signatures(): SignatureInstance[];
+```
+
+#### Returns
+
+`SignatureInstance`[]
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.signatures
+```
+
+***
+
+### stepHashes
+
+### Get Signature
+
+```ts
+get stepHashes(): Lowercase<string>[];
+```
+
+#### Returns
+
+`Lowercase`\<`string`\>[]
+
+***
+
+### transactionCount
+
+### Get Signature
+
+```ts
+get transactionCount(): number;
+```
+
+#### Returns
+
+`number`
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.transactionCount
+```
+
+***
+
+### transactions
+
+### Get Signature
+
+```ts
+get transactions(): HydratedTransactionInstance<HydratedTransaction, AllowedBlockPayload>[];
+```
+
+#### Returns
+
+`HydratedTransactionInstance`\<`HydratedTransaction`, `AllowedBlockPayload`\>[]
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.transactions
+```
+
+## Methods
+
+### parse()
+
+```ts
+static parse<T>(block, validate): Promise<HydratedBlockInstance<HydratedBlock>>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `HydratedBlock`
+
+### Parameters
+
+#### block
+
+`T`
+
+#### validate
+
+`boolean` = `false`
+
+### Returns
+
+`Promise`\<`HydratedBlockInstance`\<`HydratedBlock`\>\>
+
+***
+
+### payload()
+
+```ts
+payload(index): undefined | WithHashStorageMeta<T[1][number]>;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.payload
+```
+
+***
+
+### signature()
+
+```ts
+signature(index): undefined | SignatureInstance;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| `SignatureInstance`
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.signature
+```
+
+***
+
+### transaction()
+
+```ts
+transaction(index): 
+  | undefined
+| HydratedTransactionInstance<HydratedTransaction, AllowedBlockPayload>;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+  \| `undefined`
+  \| `HydratedTransactionInstance`\<`HydratedTransaction`, `AllowedBlockPayload`\>
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.transaction
+```
+
+***
+
+### validate()
+
+```ts
+validate(): Promise<Error[]>;
+```
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+### Implementation of
+
+```ts
+HydratedBlockInstance.validate
+```
+
+***
+
+### validateState()
+
+```ts
+validateState(services): Promise<Error[]>;
+```
+
+### Parameters
+
+#### services
+
+##### accountBalance
+
+`AccountBalanceServiceV2`
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+***
+
+### parse()
+
+```ts
+protected parse(validate): Promise<HydratedBlockInstance<[WithHashStorageMeta<T[0]>, WithHashStorageMeta<T[1][number]>[]]>>;
+```
+
+### Parameters
+
+#### validate
+
+`boolean` = `false`
+
+### Returns
+
+`Promise`\<`HydratedBlockInstance`\<\[`WithHashStorageMeta`\<`T`\[`0`\]\>, `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>[]\]\>\>
+
+  ### <a id="HydratedTransactionWrapper"></a>HydratedTransactionWrapper
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Type Parameters
+
+### T
+
+`T` *extends* `HydratedTransaction`
+
+## Implements
+
+- `HydratedTransactionInstance`\<\[`T`\[`0`\], `T`\[`1`\]\[`number`\][]\]\>
+
+## Constructors
+
+### Constructor
+
+```ts
+protected new HydratedTransactionWrapper<T>(data): HydratedTransactionWrapper<T>;
+```
+
+### Parameters
+
+#### data
+
+`T`
+
+### Returns
+
+`HydratedTransactionWrapper`\<`T`\>
+
+## Properties
+
+### data
+
+```ts
+data: T;
+```
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.data
+```
+
+***
+
+### fees
+
+```ts
+fees: TransactionFeesInstance;
+```
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.fees
+```
+
+***
+
+### payloadsCache
+
+```ts
+protected payloadsCache: WithStorageMeta<Payload>[] = [];
+```
+
+## Accessors
+
+### boundWitness
+
+### Get Signature
+
+```ts
+get boundWitness(): T[0];
+```
+
+#### Returns
+
+`T`\[`0`\]
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.boundWitness
+```
+
+***
+
+### elevatedPayloadCount
+
+### Get Signature
+
+```ts
+get elevatedPayloadCount(): number;
+```
+
+#### Returns
+
+`number`
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.elevatedPayloadCount
+```
+
+***
+
+### elevatedPayloads
+
+### Get Signature
+
+```ts
+get elevatedPayloads(): WithStorageMeta<AllowedBlockPayload>[];
+```
+
+#### Returns
+
+`WithStorageMeta`\<`AllowedBlockPayload`\>[]
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.elevatedPayloads
+```
+
+***
+
+### externalPayloads
+
+### Get Signature
+
+```ts
+get externalPayloads(): Record<Hash, Schema | Payload>;
+```
+
+#### Returns
+
+`Record`\<`Hash`, `Schema` \| `Payload`\>
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.externalPayloads
+```
+
+***
+
+### from
+
+### Get Signature
+
+```ts
+get from(): Lowercase<string>;
+```
+
+#### Returns
+
+`Lowercase`\<`string`\>
+
+***
+
+### payloadCount
+
+### Get Signature
+
+```ts
+get payloadCount(): number;
+```
+
+#### Returns
+
+`number`
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.payloadCount
+```
+
+***
+
+### payloads
+
+### Get Signature
+
+```ts
+get payloads(): WithHashStorageMeta<WithStorageMeta<T[1][number]>>[];
+```
+
+#### Returns
+
+`WithHashStorageMeta`\<`WithStorageMeta`\<`T`\[`1`\]\[`number`\]\>\>[]
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.payloads
+```
+
+***
+
+### privateExternalPayloads
+
+### Get Signature
+
+```ts
+get privateExternalPayloads(): Record<Hash, Schema>;
+```
+
+#### Returns
+
+`Record`\<`Hash`, `Schema`\>
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.privateExternalPayloads
+```
+
+***
+
+### publicExternalPayloads
+
+### Get Signature
+
+```ts
+get publicExternalPayloads(): Payload[];
+```
+
+#### Returns
+
+`Payload`[]
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.publicExternalPayloads
+```
+
+***
+
+### signatureCount
+
+### Get Signature
+
+```ts
+get signatureCount(): number;
+```
+
+#### Returns
+
+`number`
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.signatureCount
+```
+
+***
+
+### signatures
+
+### Get Signature
+
+```ts
+get signatures(): SignatureInstance[];
+```
+
+#### Returns
+
+`SignatureInstance`[]
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.signatures
+```
+
+## Methods
+
+### parse()
+
+```ts
+static parse<T>(transaction, validate): Promise<HydratedTransactionInstance<[T[0], T[1][number][]], AllowedBlockPayload>>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `HydratedTransaction`
+
+### Parameters
+
+#### transaction
+
+`T`
+
+#### validate
+
+`boolean` = `false`
+
+### Returns
+
+`Promise`\<`HydratedTransactionInstance`\<\[`T`\[`0`\], `T`\[`1`\]\[`number`\][]\], `AllowedBlockPayload`\>\>
+
+***
+
+### elevatedPayload()
+
+```ts
+elevatedPayload(index): 
+  | undefined
+| WithHashStorageMeta<AllowedBlockPayload & T[1][number]>;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+  \| `undefined`
+  \| `WithHashStorageMeta`\<AllowedBlockPayload & T\[1\]\[number\]\>
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.elevatedPayload
+```
+
+***
+
+### gasRequired()
+
+```ts
+gasRequired(): bigint;
+```
+
+### Returns
+
+`bigint`
+
+***
+
+### payload()
+
+```ts
+payload(index): undefined | WithStorageMeta<Payload>;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| `WithStorageMeta`\<`Payload`\>
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.payload
+```
+
+***
+
+### reward()
+
+```ts
+reward(): bigint;
+```
+
+### Returns
+
+`bigint`
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.reward
+```
+
+***
+
+### signature()
+
+```ts
+signature(index): undefined | SignatureInstance;
+```
+
+### Parameters
+
+#### index
+
+`number`
+
+### Returns
+
+`undefined` \| `SignatureInstance`
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.signature
+```
+
+***
+
+### validate()
+
+```ts
+validate(): Promise<Error[]>;
+```
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+### Implementation of
+
+```ts
+HydratedTransactionInstance.validate
+```
+
+***
+
+### parse()
+
+```ts
+protected parse(validate): Promise<HydratedTransactionInstance<[WithHashStorageMeta<T[0]>, WithHashStorageMeta<T[1][number]>[]], AllowedBlockPayload>>;
+```
+
+### Parameters
+
+#### validate
+
+`boolean` = `false`
+
+### Returns
+
+`Promise`\<`HydratedTransactionInstance`\<\[`WithHashStorageMeta`\<`T`\[`0`\]\>, `WithHashStorageMeta`\<`T`\[`1`\]\[`number`\]\>[]\], `AllowedBlockPayload`\>\>
+
+  ### <a id="IndexedHydratedBlockRangeStore"></a>IndexedHydratedBlockRangeStore
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Extends
+
+- `BaseEmitter`\<[`HydratedBlockRangeStoreParams`](#../interfaces/HydratedBlockRangeStoreParams)\>
+
+## Implements
+
+- [`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance)
+
+## Constructors
+
+### Constructor
+
+```ts
+protected new IndexedHydratedBlockRangeStore(
+   params, 
+   firstNumber, 
+   lastNumber): IndexedHydratedBlockRangeStore;
+```
+
+### Parameters
+
+#### params
+
+[`HydratedBlockRangeStoreParams`](#../interfaces/HydratedBlockRangeStoreParams)
+
+#### firstNumber
+
+`number`
+
+#### lastNumber
+
+`number`
+
+### Returns
+
+`IndexedHydratedBlockRangeStore`
+
+### Overrides
+
+```ts
+BaseEmitter<HydratedBlockRangeStoreParams>.constructor
+```
+
+## Accessors
+
+### count
+
+### Get Signature
+
+```ts
+get count(): number;
+```
+
+#### Returns
+
+`number`
+
+### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`count`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#count)
+
+***
+
+### numberRange
+
+### Get Signature
+
+```ts
+get numberRange(): [number, number];
+```
+
+#### Returns
+
+\[`number`, `number`\]
+
+### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`numberRange`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#numberrange)
+
+***
+
+### range
+
+### Get Signature
+
+```ts
+get range(): [Lowercase<string>, Lowercase<string>];
+```
+
+#### Returns
+
+\[`Lowercase`\<`string`\>, `Lowercase`\<`string`\>\]
+
+### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`range`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#range)
+
+## Methods
+
+### create()
+
+```ts
+static create(params): Promise<IndexedHydratedBlockRangeStore>;
+```
+
+### Parameters
+
+#### params
+
+[`HydratedBlockRangeStoreParams`](#../interfaces/HydratedBlockRangeStoreParams)
+
+### Returns
+
+`Promise`\<`IndexedHydratedBlockRangeStore`\>
+
+***
+
+### first()
+
+```ts
+first(): Promise<HydratedBlock>;
+```
+
+### Returns
+
+`Promise`\<`HydratedBlock`\>
+
+### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`first`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#first)
+
+***
+
+### fromHash()
+
+```ts
+fromHash(hash): Promise<undefined | HydratedBlock>;
+```
+
+### Parameters
+
+#### hash
+
+`Lowercase`\<`string`\>
+
+### Returns
+
+`Promise`\<`undefined` \| `HydratedBlock`\>
+
+### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`fromHash`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#fromhash)
+
+***
+
+### fromNumber()
+
+```ts
+fromNumber(number): Promisable<undefined | HydratedBlock>;
+```
+
+### Parameters
+
+#### number
+
+`number`
+
+### Returns
+
+`Promisable`\<`undefined` \| `HydratedBlock`\>
+
+### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`fromNumber`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#fromnumber)
+
+***
+
+### last()
+
+```ts
+last(): Promise<HydratedBlock>;
+```
+
+### Returns
+
+`Promise`\<`HydratedBlock`\>
+
+### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`last`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#last)
+
+***
+
+### next()
+
+### Call Signature
+
+```ts
+next(from): Promise<undefined | HydratedBlock>;
+```
+
+#### Parameters
+
+##### from
+
+`HydratedBlock`
+
+#### Returns
+
+`Promise`\<`undefined` \| `HydratedBlock`\>
+
+#### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`next`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#next)
+
+### Call Signature
+
+```ts
+next(from, count): Promise<HydratedBlock[]>;
+```
+
+#### Parameters
+
+##### from
+
+`HydratedBlock`
+
+##### count
+
+`number`
+
+#### Returns
+
+`Promise`\<`HydratedBlock`[]\>
+
+#### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`next`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#next)
+
+***
+
+### prev()
+
+### Call Signature
+
+```ts
+prev(from): Promise<undefined | HydratedBlock>;
+```
+
+#### Parameters
+
+##### from
+
+`HydratedBlock`
+
+#### Returns
+
+`Promise`\<`undefined` \| `HydratedBlock`\>
+
+#### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`prev`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#prev)
+
+### Call Signature
+
+```ts
+prev(from, count): Promise<HydratedBlock[]>;
+```
+
+#### Parameters
+
+##### from
+
+`HydratedBlock`
+
+##### count
+
+`number`
+
+#### Returns
+
+`Promise`\<`HydratedBlock`[]\>
+
+#### Implementation of
+
+[`IndexedHydratedBlockRangeStoreInstance`](#../interfaces/IndexedHydratedBlockRangeStoreInstance).[`prev`](../interfaces/IndexedHydratedBlockRangeStoreInstance.md#prev)
+
+  ### <a id="ShiftedBigInt"></a>ShiftedBigInt
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new ShiftedBigInt(value, config): ShiftedBigInt;
+```
+
+### Parameters
+
+#### value
+
+`bigint` | `ShiftedBigInt`
+
+#### config
+
+`Partial`\<`ShiftedBigIntConfig`\> = `{}`
+
+### Returns
+
+`ShiftedBigInt`
+
+## Properties
+
+### defaultConfig
+
+```ts
+readonly static defaultConfig: ShiftedBigIntConfig;
+```
+
+***
+
+### config
+
+```ts
+config: ShiftedBigIntConfig;
+```
+
+***
+
+### value
+
+```ts
+value: bigint;
+```
+
+## Accessors
+
+### locale
+
+### Get Signature
+
+```ts
+get locale(): LocalesArgument;
+```
+
+#### Returns
+
+`LocalesArgument`
+
+***
+
+### maxCharacters
+
+### Get Signature
+
+```ts
+get maxCharacters(): number;
+```
+
+#### Returns
+
+`number`
+
+***
+
+### maxDecimal
+
+### Get Signature
+
+```ts
+get maxDecimal(): number;
+```
+
+#### Returns
+
+`number`
+
+***
+
+### minDecimals
+
+### Get Signature
+
+```ts
+get minDecimals(): number;
+```
+
+#### Returns
+
+`number`
+
+***
+
+### places
+
+### Get Signature
+
+```ts
+get places(): number;
+```
+
+#### Returns
+
+`number`
+
+## Methods
+
+### toFullString()
+
+```ts
+toFullString(): string;
+```
+
+### Returns
+
+`string`
+
+***
+
+### toShortString()
+
+```ts
+toShortString(): string;
+```
+
+### Returns
+
+`string`
+
+***
+
+### toString()
+
+```ts
+toString(): string;
+```
+
+### Returns
+
+`string`
+
+  ### <a id="SignatureWrapper"></a>SignatureWrapper
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Implements
+
+- `SignatureInstance`
+
+## Constructors
+
+### Constructor
+
+```ts
+new SignatureWrapper(
+   signature, 
+   address, 
+   hash): SignatureWrapper;
+```
+
+### Parameters
+
+#### signature
+
+`Lowercase`\<`string`\>
+
+#### address
+
+`Lowercase`\<`string`\>
+
+#### hash
+
+`Lowercase`\<`string`\>
+
+### Returns
+
+`SignatureWrapper`
+
+## Properties
+
+### address
+
+```ts
+address: Lowercase<string>;
+```
+
+### Implementation of
+
+```ts
+SignatureInstance.address
+```
+
+***
+
+### hash
+
+```ts
+hash: Lowercase<string>;
+```
+
+### Implementation of
+
+```ts
+SignatureInstance.hash
+```
+
+***
+
+### signature
+
+```ts
+signature: Lowercase<string>;
+```
+
+### Implementation of
+
+```ts
+SignatureInstance.signature
+```
+
+## Methods
+
+### validate()
+
+```ts
+static validate(
+   hash, 
+   address, 
+signature): Promise<Error[]>;
+```
+
+### Parameters
+
+#### hash
+
+`Lowercase`\<`string`\>
+
+#### address
+
+`Lowercase`\<`string`\>
+
+#### signature
+
+`Lowercase`\<`string`\>
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+***
+
+### validate()
+
+```ts
+validate(): Promise<Error[]>;
+```
+
+### Returns
+
+`Promise`\<`Error`[]\>
+
+### Implementation of
+
+```ts
+SignatureInstance.validate
+```
+
+  ### <a id="XL1Amount"></a>XL1Amount
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Implements
+
+- [`XL1AmountInstance`](#../interfaces/XL1AmountInstance)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XL1Amount(value, locale): XL1Amount;
+```
+
+### Parameters
+
+#### value
+
+`bigint`
+
+#### locale
+
+`LocalesArgument` = `'en-US'`
+
+### Returns
+
+`XL1Amount`
+
+## Properties
+
+### value
+
+```ts
+value: AttoXL1;
+```
+
+### Implementation of
+
+[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`value`](../interfaces/XL1AmountInstance.md#value)
+
+## Accessors
+
+### milli
+
+### Get Signature
+
+```ts
+get milli(): MilliXL1;
+```
+
+#### Returns
+
+`MilliXL1`
+
+### Implementation of
+
+[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`milli`](../interfaces/XL1AmountInstance.md#milli)
+
+***
+
+### micro
+
+### Get Signature
+
+```ts
+get micro(): MicroXL1;
+```
+
+#### Returns
+
+`MicroXL1`
+
+### Implementation of
+
+[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`micro`](../interfaces/XL1AmountInstance.md#micro)
+
+***
+
+### nano
+
+### Get Signature
+
+```ts
+get nano(): NanoXL1;
+```
+
+#### Returns
+
+`NanoXL1`
+
+### Implementation of
+
+[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`nano`](../interfaces/XL1AmountInstance.md#nano)
+
+***
+
+### pico
+
+### Get Signature
+
+```ts
+get pico(): PicoXL1;
+```
+
+#### Returns
+
+`PicoXL1`
+
+### Implementation of
+
+[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`pico`](../interfaces/XL1AmountInstance.md#pico)
+
+***
+
+### femto
+
+### Get Signature
+
+```ts
+get femto(): FemtoXL1;
+```
+
+#### Returns
+
+`FemtoXL1`
+
+### Implementation of
+
+[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`femto`](../interfaces/XL1AmountInstance.md#femto)
+
+***
+
+### atto
+
+### Get Signature
+
+```ts
+get atto(): AttoXL1;
+```
+
+#### Returns
+
+`AttoXL1`
+
+### Implementation of
+
+[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`atto`](../interfaces/XL1AmountInstance.md#atto)
+
+## Methods
+
+### from()
+
+```ts
+static from(value, places): XL1Amount;
+```
+
+### Parameters
+
+#### value
+
+`bigint`
+
+#### places
+
+`bigint` = `XL1Places.atto`
+
+### Returns
+
+`XL1Amount`
+
+***
+
+### fromMilli()
+
+```ts
+static fromMilli(value): XL1Amount;
+```
+
+### Parameters
+
+#### value
+
+`MilliXL1`
+
+### Returns
+
+`XL1Amount`
+
+***
+
+### fromMicro()
+
+```ts
+static fromMicro(value): XL1Amount;
+```
+
+### Parameters
+
+#### value
+
+`MicroXL1`
+
+### Returns
+
+`XL1Amount`
+
+***
+
+### fromNano()
+
+```ts
+static fromNano(value): XL1Amount;
+```
+
+### Parameters
+
+#### value
+
+`NanoXL1`
+
+### Returns
+
+`XL1Amount`
+
+***
+
+### fromPico()
+
+```ts
+static fromPico(value): XL1Amount;
+```
+
+### Parameters
+
+#### value
+
+`PicoXL1`
+
+### Returns
+
+`XL1Amount`
+
+***
+
+### fromFemto()
+
+```ts
+static fromFemto(value): XL1Amount;
+```
+
+### Parameters
+
+#### value
+
+`FemtoXL1`
+
+### Returns
+
+`XL1Amount`
+
+***
+
+### fromAtto()
+
+```ts
+static fromAtto(value): XL1Amount;
+```
+
+### Parameters
+
+#### value
+
+`AttoXL1`
+
+### Returns
+
+`XL1Amount`
+
+***
+
+### to()
+
+```ts
+to(places): bigint;
+```
+
+### Parameters
+
+#### places
+
+`number` | `bigint`
+
+### Returns
+
+`bigint`
+
+### Implementation of
+
+[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`to`](../interfaces/XL1AmountInstance.md#to)
+
+***
+
+### toString()
+
+```ts
+toString(places, config): string;
+```
+
+### Parameters
+
+#### places
+
+`number` = `...`
+
+#### config
+
+`Partial`\<`ShiftedBigIntConfig`\> = `{}`
+
+### Returns
+
+`string`
+
+### Implementation of
+
+[`XL1AmountInstance`](#../interfaces/XL1AmountInstance).[`toString`](../interfaces/XL1AmountInstance.md#tostring)
+
+### functions
+
+  ### <a id="splitOnDecimal"></a>splitOnDecimal
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+```ts
+function splitOnDecimal(value, places): [bigint, bigint];
+```
+
+## Parameters
+
+### value
+
+`bigint`
+
+### places
+
+`number` = `18`
+
+## Returns
+
+\[`bigint`, `bigint`\]
+
+  ### <a id="splitOnDecimalToString"></a>splitOnDecimalToString
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+```ts
+function splitOnDecimalToString(
+   value, 
+   places, 
+   maxDecimal, 
+   maxCharacters, 
+   minDecimals, 
+   locale): string;
+```
+
+## Parameters
+
+### value
+
+`bigint`
+
+### places
+
+`number` = `18`
+
+### maxDecimal
+
+`number` = `places`
+
+### maxCharacters
+
+`number` = `9`
+
+### minDecimals
+
+`number` = `1`
+
+### locale
+
+`LocalesArgument` = `'en-US'`
+
+## Returns
+
+`string`
+
+### interfaces
+
+  ### <a id="HydratedBlockRangeStoreParams"></a>HydratedBlockRangeStoreParams
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Extends
+
+- [`HydratedBlockStoreParams`](#../type-aliases/HydratedBlockStoreParams)\<\{
+  `first`: `Hash`;
+  `last`: `Hash`;
+  `snapshotArchivist`: `ArchivistInstance`;
+\}\>
+
+## Properties
+
+### sourceArchivist
+
+```ts
+sourceArchivist: ArchivistInstance;
+```
+
+### Inherited from
+
+```ts
+HydratedBlockStoreParams.sourceArchivist
+```
+
+***
+
+### first
+
+```ts
+first: Lowercase<string>;
+```
+
+### Inherited from
+
+```ts
+HydratedBlockStoreParams.first
+```
+
+***
+
+### last
+
+```ts
+last: Lowercase<string>;
+```
+
+### Inherited from
+
+```ts
+HydratedBlockStoreParams.last
+```
+
+***
+
+### snapshotArchivist
+
+```ts
+snapshotArchivist: ArchivistInstance;
+```
+
+### Inherited from
+
+```ts
+HydratedBlockStoreParams.snapshotArchivist
+```
+
+  ### <a id="HydratedBlockStoreInstance"></a>HydratedBlockStoreInstance
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Extended by
+
+- [`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance)
+
+## Methods
+
+### fromHash()
+
+```ts
+fromHash(hash): Promisable<undefined | HydratedBlock>;
+```
+
+### Parameters
+
+#### hash
+
+`Lowercase`\<`string`\>
+
+### Returns
+
+`Promisable`\<`undefined` \| `HydratedBlock`\>
+
+  ### <a id="IndexedHydratedBlockRangeStoreInstance"></a>IndexedHydratedBlockRangeStoreInstance
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Extends
+
+- `BlockWindowInstance`.[`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance)
+
+## Properties
+
+### count
+
+```ts
+count: number;
+```
+
+### Inherited from
+
+```ts
+BlockWindowInstance.count
+```
+
+***
+
+### numberRange
+
+```ts
+numberRange: [number, number];
+```
+
+### Inherited from
+
+```ts
+BlockWindowInstance.numberRange
+```
+
+***
+
+### range
+
+```ts
+range: [Lowercase<string>, Lowercase<string>];
+```
+
+### Inherited from
+
+```ts
+BlockWindowInstance.range
+```
+
+## Methods
+
+### fromHash()
+
+```ts
+fromHash(hash): Promisable<undefined | HydratedBlock>;
+```
+
+### Parameters
+
+#### hash
+
+`Lowercase`\<`string`\>
+
+### Returns
+
+`Promisable`\<`undefined` \| `HydratedBlock`\>
+
+### Inherited from
+
+[`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance).[`fromHash`](IndexedHydratedBlockStoreInstance.md#fromhash)
+
+***
+
+### fromNumber()
+
+```ts
+fromNumber(number): Promisable<undefined | HydratedBlock>;
+```
+
+### Parameters
+
+#### number
+
+`number`
+
+### Returns
+
+`Promisable`\<`undefined` \| `HydratedBlock`\>
+
+### Inherited from
+
+[`IndexedHydratedBlockStoreInstance`](#IndexedHydratedBlockStoreInstance).[`fromNumber`](IndexedHydratedBlockStoreInstance.md#fromnumber)
+
+***
+
+### first()
+
+```ts
+first(): Promisable<HydratedBlock>;
+```
+
+### Returns
+
+`Promisable`\<`HydratedBlock`\>
+
+***
+
+### last()
+
+```ts
+last(): Promisable<HydratedBlock>;
+```
+
+### Returns
+
+`Promisable`\<`HydratedBlock`\>
+
+***
+
+### next()
+
+### Call Signature
+
+```ts
+next(from): Promisable<undefined | HydratedBlock>;
+```
+
+#### Parameters
+
+##### from
+
+`HydratedBlock`
+
+#### Returns
+
+`Promisable`\<`undefined` \| `HydratedBlock`\>
+
+### Call Signature
+
+```ts
+next(from, count): Promisable<HydratedBlock[]>;
+```
+
+#### Parameters
+
+##### from
+
+`HydratedBlock`
+
+##### count
+
+`number`
+
+#### Returns
+
+`Promisable`\<`HydratedBlock`[]\>
+
+***
+
+### prev()
+
+### Call Signature
+
+```ts
+prev(from): Promisable<undefined | HydratedBlock>;
+```
+
+#### Parameters
+
+##### from
+
+`HydratedBlock`
+
+#### Returns
+
+`Promisable`\<`undefined` \| `HydratedBlock`\>
+
+### Call Signature
+
+```ts
+prev(from, count): Promisable<HydratedBlock[]>;
+```
+
+#### Parameters
+
+##### from
+
+`HydratedBlock`
+
+##### count
+
+`number`
+
+#### Returns
+
+`Promisable`\<`HydratedBlock`[]\>
+
+  ### <a id="IndexedHydratedBlockStoreInstance"></a>IndexedHydratedBlockStoreInstance
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+## Extends
+
+- [`HydratedBlockStoreInstance`](#HydratedBlockStoreInstance)
+
+## Extended by
+
+- [`IndexedHydratedBlockRangeStoreInstance`](#IndexedHydratedBlockRangeStoreInstance)
+
+## Methods
+
+### fromHash()
+
+```ts
+fromHash(hash): Promisable<undefined | HydratedBlock>;
+```
+
+### Parameters
+
+#### hash
+
+`Lowercase`\<`string`\>
+
+### Returns
+
+`Promisable`\<`undefined` \| `HydratedBlock`\>
+
+### Inherited from
+
+[`HydratedBlockStoreInstance`](#HydratedBlockStoreInstance).[`fromHash`](HydratedBlockStoreInstance.md#fromhash)
+
+***
+
+### fromNumber()
+
+```ts
+fromNumber(number): Promisable<undefined | HydratedBlock>;
+```
+
+### Parameters
+
+#### number
+
+`number`
+
+### Returns
+
+`Promisable`\<`undefined` \| `HydratedBlock`\>
+
+  ### <a id="XL1AmountInstance"></a>XL1AmountInstance
+
+[**@xyo-network/chain-wrappers**](#../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`\>
+
+### Returns
+
+`string`
+
+### type-aliases
+
+  ### <a id="HydratedBlockStoreParams"></a>HydratedBlockStoreParams
+
+[**@xyo-network/chain-wrappers**](#../README)
+
+***
+
+```ts
+type HydratedBlockStoreParams<TAdditionalParams> = BaseParams<object & TAdditionalParams>;
+```
+
+## Type Parameters
+
+### TAdditionalParams
+
+`TAdditionalParams` *extends* `EmptyObject` = `EmptyObject`
+
+
+## Maintainers
+
+-   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
+-   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
+-   [Jordan Trouw](https://github.com/jordantrouw)
+
+## License
+
+> See the [LICENSE](LICENSE) file for license details
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO](https://xyo.network)
+
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/chain-wrappers.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/chain-wrappers
+
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xyo-network/chain-wrappers
+[npm-license-badge]: https://img.shields.io/npm/l/@xyo-network/chain-wrappers
+
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xyo-network/chain-wrappers/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xyo-network/chain-wrappers
+
+[socket-badge]: https://socket.dev/api/badge/npm/package/@xyo-network/chain-wrappers
+[socket-link]: https://socket.dev/npm/package/@xyo-network/chain-wrappers