@xyo-network/sdk-js 3.14.15 → 3.14.17

package/docs/classes/ResolveHelper.md

@@ -0,0 +1,217 @@
+[@xyo-network/sdk-js](../README.md) / ResolveHelper
+
+# Class: ResolveHelper
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:17
+
+## Extends
+
+- `ResolveHelperStatic`
+
+## Constructors
+
+### Constructor
+
+> **new ResolveHelper**(): `ResolveHelper`
+
+#### Returns
+
+`ResolveHelper`
+
+#### Inherited from
+
+`ResolveHelperStatic.constructor`
+
+## Properties
+
+### defaultLogger?
+
+> `readonly` `static` `optional` **defaultLogger**: `Logger`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelperStatic.d.ts:4
+
+#### Inherited from
+
+`ResolveHelperStatic.defaultLogger`
+
+***
+
+### transformers
+
+> `static` **transformers**: [`ModuleIdentifierTransformer`](../interfaces/ModuleIdentifierTransformer.md)[]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelperStatic.d.ts:5
+
+#### Inherited from
+
+`ResolveHelperStatic.transformers`
+
+## Methods
+
+### resolve()
+
+#### Call Signature
+
+> `static` **resolve**\<`T`\>(`config`, `all`, `options?`): `Promise`\<`T`[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:18
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### config
+
+[`ResolveHelperConfig`](../interfaces/ResolveHelperConfig.md)
+
+###### all
+
+`"*"`
+
+###### options?
+
+[`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promise`\<`T`[]\>
+
+#### Call Signature
+
+> `static` **resolve**\<`T`\>(`config`, `id`, `options?`): `Promise`\<`undefined` \| `T`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:19
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### config
+
+[`ResolveHelperConfig`](../interfaces/ResolveHelperConfig.md)
+
+###### id
+
+`string`
+
+###### options?
+
+[`ModuleFilterOptions`](../interfaces/ModuleFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+***
+
+### resolveModuleIdentifier()
+
+> `static` **resolveModuleIdentifier**\<`T`\>(`resolver`, `path`, `required?`): `Promise`\<`undefined` \| `T`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:20
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+#### Parameters
+
+##### resolver
+
+[`ModuleResolver`](../interfaces/ModuleResolver.md)
+
+##### path
+
+`string`
+
+##### required?
+
+`boolean`
+
+#### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+***
+
+### traceModuleIdentifier()
+
+> `static` **traceModuleIdentifier**(`resolver`, `path`): `Promise`\<`Lowercase`\<`string`\>[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:21
+
+#### Parameters
+
+##### resolver
+
+[`ModuleResolver`](../interfaces/ModuleResolver.md)
+
+##### path
+
+`string`
+
+#### Returns
+
+`Promise`\<`Lowercase`\<`string`\>[]\>
+
+***
+
+### transformModuleIdentifier()
+
+> `static` **transformModuleIdentifier**(`identifier`, `transformers?`): `Promise`\<`undefined` \| `string`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:22
+
+#### Parameters
+
+##### identifier
+
+`string`
+
+##### transformers?
+
+[`ModuleIdentifierTransformer`](../interfaces/ModuleIdentifierTransformer.md)[]
+
+#### Returns
+
+`Promise`\<`undefined` \| `string`\>
+
+***
+
+### validateRequiredResolve()
+
+> `static` **validateRequiredResolve**(`required`, `result`, `id`, `logger?`): `void`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/ResolveHelper.d.ts:23
+
+#### Parameters
+
+##### required
+
+`boolean` | `"warn"` | `"log"`
+
+##### result
+
+`undefined` | [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\> | [`ModuleInstance`](../interfaces/ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>[]
+
+##### id
+
+`string`
+
+##### logger?
+
+`Logger`
+
+#### Returns
+
+`void`

package/docs/classes/SequenceParser.md

@@ -0,0 +1,469 @@
+[@xyo-network/sdk-js](../README.md) / SequenceParser
+
+# Class: SequenceParser
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:3
+
+## Accessors
+
+### address
+
+#### Get Signature
+
+> **get** **address**(): `Lowercase`\<`string`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:7
+
+##### Returns
+
+`Lowercase`\<`string`\>
+
+***
+
+### epoch
+
+#### Get Signature
+
+> **get** **epoch**(): `Lowercase`\<`string`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:8
+
+##### Returns
+
+`Lowercase`\<`string`\>
+
+***
+
+### localSequence
+
+#### Get Signature
+
+> **get** **localSequence**(): `Lowercase`\<`string`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:9
+
+##### Returns
+
+`Lowercase`\<`string`\>
+
+***
+
+### nonce
+
+#### Get Signature
+
+> **get** **nonce**(): `Lowercase`\<`string`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:10
+
+##### Returns
+
+`Lowercase`\<`string`\>
+
+***
+
+### qualifiedSequence
+
+#### Get Signature
+
+> **get** **qualifiedSequence**(): `Lowercase`\<`string`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:11
+
+##### Returns
+
+`Lowercase`\<`string`\>
+
+## Methods
+
+### from()
+
+#### Call Signature
+
+> `static` **from**(`sequence`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:12
+
+##### Parameters
+
+###### sequence
+
+`Lowercase`\<`string`\>
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `hash`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:13
+
+##### Parameters
+
+###### timestamp
+
+`Lowercase`\<`string`\>
+
+###### hash
+
+`Lowercase`\<`string`\>
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `hash`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:14
+
+##### Parameters
+
+###### timestamp
+
+`Lowercase`\<`string`\>
+
+###### hash
+
+`Lowercase`\<`string`\>
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `nonce`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:15
+
+##### Parameters
+
+###### timestamp
+
+`Lowercase`\<`string`\>
+
+###### nonce
+
+`Lowercase`\<`string`\>
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `hash`, `index?`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:16
+
+##### Parameters
+
+###### timestamp
+
+`Lowercase`\<`string`\>
+
+###### hash
+
+`Lowercase`\<`string`\>
+
+###### index?
+
+`number`
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `hash`, `index?`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:17
+
+##### Parameters
+
+###### timestamp
+
+`Lowercase`\<`string`\>
+
+###### hash
+
+`Lowercase`\<`string`\>
+
+###### index?
+
+`number`
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `nonce`, `index?`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:18
+
+##### Parameters
+
+###### timestamp
+
+`Lowercase`\<`string`\>
+
+###### nonce
+
+`Lowercase`\<`string`\>
+
+###### index?
+
+`number`
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `hash`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:19
+
+##### Parameters
+
+###### timestamp
+
+`number`
+
+###### hash
+
+`Lowercase`\<`string`\>
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `hash`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:20
+
+##### Parameters
+
+###### timestamp
+
+`number`
+
+###### hash
+
+`Lowercase`\<`string`\>
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `nonce`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:21
+
+##### Parameters
+
+###### timestamp
+
+`number`
+
+###### nonce
+
+`Lowercase`\<`string`\>
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `hash`, `index?`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:22
+
+##### Parameters
+
+###### timestamp
+
+`number`
+
+###### hash
+
+`Lowercase`\<`string`\>
+
+###### index?
+
+`number`
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `hash`, `index?`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:23
+
+##### Parameters
+
+###### timestamp
+
+`number`
+
+###### hash
+
+`Lowercase`\<`string`\>
+
+###### index?
+
+`number`
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+#### Call Signature
+
+> `static` **from**(`timestamp`, `nonce`, `index?`, `address?`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:24
+
+##### Parameters
+
+###### timestamp
+
+`number`
+
+###### nonce
+
+`Lowercase`\<`string`\>
+
+###### index?
+
+`number`
+
+###### address?
+
+`Lowercase`\<`string`\>
+
+##### Returns
+
+`SequenceParser`
+
+***
+
+### parse()
+
+> `static` **parse**(`value`): `SequenceParser`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:25
+
+#### Parameters
+
+##### value
+
+`string` | `ArrayBufferLike`
+
+#### Returns
+
+`SequenceParser`
+
+***
+
+### toEpoch()
+
+> `static` **toEpoch**(`value`): `Lowercase`\<`string`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:26
+
+#### Parameters
+
+##### value
+
+`number` | `Lowercase`\<`string`\>
+
+#### Returns
+
+`Lowercase`\<`string`\>
+
+***
+
+### toNonce()
+
+> `static` **toNonce**(`value`, `index?`): `Lowercase`\<`string`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Parser.d.ts:27
+
+#### Parameters
+
+##### value
+
+`Lowercase`\<`string`\>
+
+##### index?
+
+`number`
+
+#### Returns
+
+`Lowercase`\<`string`\>