@xyo-network/sdk-js 4.3.0 → 5.0.1

package/docs/interfaces/WitnessModule.md

@@ -1,485 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / WitnessModule
-
-# Interface: WitnessModule\<TParams, TEvents\>
-
-Defined in: packages/modules/packages/witness/packages/model/dist/types/Module.d.ts:4
-
-## Extends
-
-- [`Module`](Module.md)\<`TParams`, `TEvents`\>
-
-## Extended by
-
-- [`WitnessInstance`](WitnessInstance.md)
-
-## Type Parameters
-
-### TParams
-
-`TParams` *extends* [`WitnessParams`](../type-aliases/WitnessParams.md) = [`WitnessParams`](../type-aliases/WitnessParams.md)
-
-### TEvents
-
-`TEvents` *extends* [`WitnessModuleEventData`](../type-aliases/WitnessModuleEventData.md) = [`WitnessModuleEventData`](../type-aliases/WitnessModuleEventData.md)
-
-## Properties
-
-### address
-
-> **address**: `Lowercase`\<`string`\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:10
-
-#### Inherited from
-
-[`Module`](Module.md).[`address`](Module.md#address)
-
-***
-
-### config
-
-> **config**: `TParams`\[`"config"`\]
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:11
-
-#### Inherited from
-
-[`Module`](Module.md).[`config`](Module.md#config)
-
-***
-
-### eventData
-
-> **eventData**: `TEvents`
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:11
-
-#### Inherited from
-
-[`Module`](Module.md).[`eventData`](Module.md#eventdata)
-
-***
-
-### id
-
-> **id**: `string`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:13
-
-The name (if specified) or address of the module
-
-#### Inherited from
-
-[`Module`](Module.md).[`id`](Module.md#id)
-
-***
-
-### modName?
-
-> `optional` **modName**: `string`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:14
-
-#### Inherited from
-
-[`Module`](Module.md).[`modName`](Module.md#modname)
-
-***
-
-### params
-
-> **params**: `TParams`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:15
-
-#### Inherited from
-
-[`Module`](Module.md).[`params`](Module.md#params)
-
-***
-
-### previousHash()
-
-> **previousHash**: () => `Promisable`\<`undefined` \| `string`\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:16
-
-#### Returns
-
-`Promisable`\<`undefined` \| `string`\>
-
-#### Inherited from
-
-[`Module`](Module.md).[`previousHash`](Module.md#previoushash)
-
-***
-
-### queries
-
-> **queries**: `string`[]
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:17
-
-#### Inherited from
-
-[`Module`](Module.md).[`queries`](Module.md#queries)
-
-***
-
-### query()
-
-> **query**: \<`T`, `TConf`\>(`query`, `payloads?`, `queryConfig?`) => `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:18
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
-
-##### TConf
-
-`TConf` *extends* [`ModuleConfig`](../type-aliases/ModuleConfig.md) = [`ModuleConfig`](../type-aliases/ModuleConfig.md)
-
-#### Parameters
-
-##### query
-
-`T`
-
-##### payloads?
-
-[`Payload`](../type-aliases/Payload.md)[]
-
-##### queryConfig?
-
-`TConf`
-
-#### Returns
-
-`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
-
-#### Inherited from
-
-[`Module`](Module.md).[`query`](Module.md#query)
-
-***
-
-### queryable()
-
-> **queryable**: \<`T`, `TConf`\>(`query`, `payloads?`, `queryConfig?`) => `Promisable`\<`boolean`\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:19
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
-
-##### TConf
-
-`TConf` *extends* [`ModuleConfig`](../type-aliases/ModuleConfig.md) = [`ModuleConfig`](../type-aliases/ModuleConfig.md)
-
-#### Parameters
-
-##### query
-
-`T`
-
-##### payloads?
-
-[`Payload`](../type-aliases/Payload.md)[]
-
-##### queryConfig?
-
-`TConf`
-
-#### Returns
-
-`Promisable`\<`boolean`\>
-
-#### Inherited from
-
-[`Module`](Module.md).[`queryable`](Module.md#queryable)
-
-***
-
-### start()?
-
-> `optional` **start**: () => `Promisable`\<`boolean`\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:20
-
-#### Returns
-
-`Promisable`\<`boolean`\>
-
-#### Inherited from
-
-[`Module`](Module.md).[`start`](Module.md#start)
-
-***
-
-### stop()?
-
-> `optional` **stop**: () => `Promisable`\<`boolean`\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:21
-
-#### Returns
-
-`Promisable`\<`boolean`\>
-
-#### Inherited from
-
-[`Module`](Module.md).[`stop`](Module.md#stop)
-
-## Methods
-
-### clearListeners()
-
-> **clearListeners**(`eventNames`): `void`
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:12
-
-#### Parameters
-
-##### eventNames
-
-keyof `TEvents` | keyof `TEvents`[]
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`Module`](Module.md).[`clearListeners`](Module.md#clearlisteners)
-
-***
-
-### emit()
-
-> **emit**\<`TEventName`\>(`eventName`, `eventArgs`): `Promise`\<`void`\>
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:13
-
-#### Type Parameters
-
-##### TEventName
-
-`TEventName` *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-##### eventName
-
-`TEventName`
-
-##### eventArgs
-
-`TEvents`\[`TEventName`\]
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Inherited from
-
-[`Module`](Module.md).[`emit`](Module.md#emit)
-
-***
-
-### emitSerial()
-
-> **emitSerial**\<`TEventName`\>(`eventName`, `eventArgs`): `Promise`\<`void`\>
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:14
-
-#### Type Parameters
-
-##### TEventName
-
-`TEventName` *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-##### eventName
-
-`TEventName`
-
-##### eventArgs
-
-`TEvents`\[`TEventName`\]
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Inherited from
-
-[`Module`](Module.md).[`emitSerial`](Module.md#emitserial)
-
-***
-
-### listenerCount()
-
-> **listenerCount**(`eventNames`): `number`
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:15
-
-#### Parameters
-
-##### eventNames
-
-keyof `TEvents` | keyof `TEvents`[]
-
-#### Returns
-
-`number`
-
-#### Inherited from
-
-[`Module`](Module.md).[`listenerCount`](Module.md#listenercount)
-
-***
-
-### off()
-
-> **off**\<`TEventName`\>(`eventNames`, `listener`): `void`
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:16
-
-#### Type Parameters
-
-##### TEventName
-
-`TEventName` *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-##### eventNames
-
-`TEventName` | `TEventName`[]
-
-##### listener
-
-[`EventListener`](../type-aliases/EventListener.md)\<`TEvents`\[`TEventName`\]\>
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`Module`](Module.md).[`off`](Module.md#off)
-
-***
-
-### offAny()
-
-> **offAny**(`listener`): `void`
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:17
-
-#### Parameters
-
-##### listener
-
-`Promise`\<`void`\> | [`EventAnyListener`](../type-aliases/EventAnyListener.md)\<[`EventArgs`](../type-aliases/EventArgs.md)\>
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`Module`](Module.md).[`offAny`](Module.md#offany)
-
-***
-
-### on()
-
-> **on**\<`TEventName`\>(`eventNames`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:18
-
-#### Type Parameters
-
-##### TEventName
-
-`TEventName` *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-##### eventNames
-
-`TEventName` | `TEventName`[]
-
-##### listener
-
-[`EventListener`](../type-aliases/EventListener.md)\<`TEvents`\[`TEventName`\]\>
-
-#### Returns
-
-[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
-
-#### Inherited from
-
-[`Module`](Module.md).[`on`](Module.md#on)
-
-***
-
-### onAny()
-
-> **onAny**(`listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:19
-
-#### Parameters
-
-##### listener
-
-[`EventAnyListener`](../type-aliases/EventAnyListener.md)
-
-#### Returns
-
-[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
-
-#### Inherited from
-
-[`Module`](Module.md).[`onAny`](Module.md#onany)
-
-***
-
-### once()
-
-> **once**\<`TEventName`\>(`eventName`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:20
-
-#### Type Parameters
-
-##### TEventName
-
-`TEventName` *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-##### eventName
-
-`TEventName`
-
-##### listener
-
-[`EventListener`](../type-aliases/EventListener.md)\<`TEvents`\[`TEventName`\]\>
-
-#### Returns
-
-[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
-
-#### Inherited from
-
-[`Module`](Module.md).[`once`](Module.md#once)

package/docs/interfaces/WitnessQueryFunctions.md

@@ -1,59 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / WitnessQueryFunctions
-
-# Interface: WitnessQueryFunctions\<TIn, TOut\>
-
-Defined in: packages/modules/packages/witness/packages/model/dist/types/QueryFunctions.d.ts:5
-
-## Extended by
-
-- [`WitnessInstance`](WitnessInstance.md)
-
-## Type Parameters
-
-### TIn
-
-`TIn` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-### TOut
-
-`TOut` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-## Properties
-
-### observe()
-
-> **observe**: (`payloads?`) => `Promisable`\<[`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<`TOut`\>[]\>
-
-Defined in: packages/modules/packages/witness/packages/model/dist/types/QueryFunctions.d.ts:6
-
-#### Parameters
-
-##### payloads?
-
-`TIn`[]
-
-#### Returns
-
-`Promisable`\<[`WithoutPrivateStorageMeta`](../type-aliases/WithoutPrivateStorageMeta.md)\<`TOut`\>[]\>
-
-***
-
-### observeQuery()
-
-> **observeQuery**: (`payloads?`, `account?`) => `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<`TOut`\>\>
-
-Defined in: packages/modules/packages/witness/packages/model/dist/types/QueryFunctions.d.ts:7
-
-#### Parameters
-
-##### payloads?
-
-`TIn`[]
-
-##### account?
-
-`AccountInstance`
-
-#### Returns
-
-`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<`TOut`\>\>

package/docs/interfaces/WriteArchivist.md

@@ -1,92 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / WriteArchivist
-
-# Interface: WriteArchivist\<TReadResponse, TWriteResponse, TWrite, TId\>
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/PayloadArchivist.d.ts:8
-
-## Extends
-
-- [`WriteArchivistFunctions`](WriteArchivistFunctions.md)\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>, `TWriteResponse`, `TWrite`, `TId`\>
-
-## Extended by
-
-- [`ReadWriteArchivist`](ReadWriteArchivist.md)
-- [`Archivist`](Archivist.md)
-
-## Type Parameters
-
-### TReadResponse
-
-`TReadResponse` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-### TWriteResponse
-
-`TWriteResponse` *extends* [`Payload`](../type-aliases/Payload.md) = `TReadResponse`
-
-### TWrite
-
-`TWrite` *extends* [`Payload`](../type-aliases/Payload.md) = `TReadResponse`
-
-### TId
-
-`TId` = `Hash`
-
-## Methods
-
-### clear()
-
-> **clear**(): `Promisable`\<`void`\>
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:11
-
-#### Returns
-
-`Promisable`\<`void`\>
-
-#### Inherited from
-
-[`WriteArchivistFunctions`](WriteArchivistFunctions.md).[`clear`](WriteArchivistFunctions.md#clear)
-
-***
-
-### delete()
-
-> **delete**(`ids`): `PromisableArray`\<`TId`\>
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:12
-
-#### Parameters
-
-##### ids
-
-`TId`[]
-
-#### Returns
-
-`PromisableArray`\<`TId`\>
-
-#### Inherited from
-
-[`WriteArchivistFunctions`](WriteArchivistFunctions.md).[`delete`](WriteArchivistFunctions.md#delete)
-
-***
-
-### insert()
-
-> **insert**(`item`): `PromisableArray`\<`TWriteResponse`\>
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:13
-
-#### Parameters
-
-##### item
-
-`TWrite`[]
-
-#### Returns
-
-`PromisableArray`\<`TWriteResponse`\>
-
-#### Inherited from
-
-[`WriteArchivistFunctions`](WriteArchivistFunctions.md).[`insert`](WriteArchivistFunctions.md#insert)

package/docs/interfaces/WriteArchivistFunctions.md

@@ -1,75 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / WriteArchivistFunctions
-
-# Interface: WriteArchivistFunctions\<TReadResponse, TWriteResponse, TWrite, TId\>
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:10
-
-## Extended by
-
-- [`WriteArchivist`](WriteArchivist.md)
-
-## Type Parameters
-
-### TReadResponse
-
-`TReadResponse`
-
-### TWriteResponse
-
-`TWriteResponse` = `TReadResponse`
-
-### TWrite
-
-`TWrite` = `TReadResponse`
-
-### TId
-
-`TId` = `string`
-
-## Methods
-
-### clear()
-
-> **clear**(): `Promisable`\<`void`\>
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:11
-
-#### Returns
-
-`Promisable`\<`void`\>
-
-***
-
-### delete()
-
-> **delete**(`ids`): `PromisableArray`\<`TId`\>
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:12
-
-#### Parameters
-
-##### ids
-
-`TId`[]
-
-#### Returns
-
-`PromisableArray`\<`TId`\>
-
-***
-
-### insert()
-
-> **insert**(`item`): `PromisableArray`\<`TWriteResponse`\>
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:13
-
-#### Parameters
-
-##### item
-
-`TWrite`[]
-
-#### Returns
-
-`PromisableArray`\<`TWriteResponse`\>

package/docs/type-aliases/AddressChildPayload.md

@@ -1,7 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / AddressChildPayload
-
-# Type Alias: AddressChildPayload
-
-> **AddressChildPayload** = [`Payload`](Payload.md)\<[`AddressChildFields`](../interfaces/AddressChildFields.md), [`AddressChildSchema`](AddressChildSchema.md)\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/Payload/Address.d.ts:30

package/docs/type-aliases/AddressChildSchema.md

@@ -1,7 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / AddressChildSchema
-
-# Type Alias: AddressChildSchema
-
-> **AddressChildSchema** = *typeof* [`AddressChildSchema`](../variables/AddressChildSchema.md)
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/Payload/Address.d.ts:5