diff --git a/.eslintrc.js b/.eslintrc.js index 1570dfd5c..bf7ba3845 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1297,6 +1297,9 @@ module.exports = { "unicorn/prefer-string-slice": [ "error" ], + "unicorn/prefer-switch": [ + "off" + ], "unicorn/prefer-text-content": [ "error" ], diff --git a/README.md b/README.md index 2f492cd4e..a8ba36256 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,9 @@ # About -Experimental client library for IOTA Chrysalis network. Implemeted in TypeScript to strongly type the objects sent and received from the API. +> This library is functionally complete, but it is recommended to use [iota.rs](https://github.com/iotaledger/iota.rs). The rust library will be more heavily maintained and is much more performant. + +Client library for IOTA Chrysalis network, implemeted in TypeScript to strongly type the objects sent and received from the API. Also includes High Level operations and MQTT support. diff --git a/docs/classes/addresstypes_ed25519address.ed25519address.md b/docs/classes/addresstypes_ed25519address.ed25519address.md index eaaabd86f..bd4cd7406 100644 --- a/docs/classes/addresstypes_ed25519address.ed25519address.md +++ b/docs/classes/addresstypes_ed25519address.ed25519address.md @@ -31,9 +31,9 @@ Create a new instance of Ed25519Address. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`publicKey` | *Uint8Array* | The public key for the address. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `publicKey` | *Uint8Array* | The public key for the address. | **Returns:** [*Ed25519Address*](addresstypes_ed25519address.ed25519address.md) @@ -61,9 +61,9 @@ Use the public key to validate the address. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`address` | *Uint8Array* | The address to verify. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `address` | *Uint8Array* | The address to verify. | **Returns:** *boolean* diff --git a/docs/classes/clients_mqttclient.mqttclient.md b/docs/classes/clients_mqttclient.mqttclient.md index b51ff6cf4..f0d3d2bf9 100644 --- a/docs/classes/clients_mqttclient.mqttclient.md +++ b/docs/classes/clients_mqttclient.mqttclient.md @@ -46,10 +46,10 @@ Create a new instace of MqttClient. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`endpoints` | *string* \| *string*[] | - | The endpoint or endpoints list to connect to. | -`keepAliveTimeoutSeconds` | *number* | 30 | Timeout to reconnect if no messages received. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `endpoints` | *string* \| *string*[] | - | The endpoint or endpoints list to connect to. | +| `keepAliveTimeoutSeconds` | *number* | 30 | Timeout to reconnect if no messages received. | **Returns:** [*MqttClient*](clients_mqttclient.mqttclient.md) @@ -63,10 +63,10 @@ Subscribe to the ed25519 address for output updates. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressEd25519` | *string* | The address to monitor. | -`callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressEd25519` | *string* | The address to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -84,10 +84,10 @@ Subscribe to the address for output updates. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressBech32` | *string* | The address to monitor. | -`callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressBech32` | *string* | The address to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -105,10 +105,10 @@ Subscribe to get all messages for the specified index in object form. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`index` | *string* \| *Uint8Array* | The index to monitor. | -`callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | *string* \| *Uint8Array* | The index to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -126,10 +126,10 @@ Subscribe to get all messages for the specified index in binary form. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`index` | *string* \| *Uint8Array* | The index to monitor. | -`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | *string* \| *Uint8Array* | The index to monitor. | +| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -147,10 +147,10 @@ Subscribe to metadata updates for a specific message. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`messageId` | *string* | The message to monitor. | -`callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | *string* | The message to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -168,9 +168,9 @@ Subscribe to get all messages in object form. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -188,9 +188,9 @@ Subscribe to get the metadata for all the messages. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -208,9 +208,9 @@ Subscribe to get all messages in binary form. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -228,9 +228,9 @@ Subscribe to the latest confirmed milestone updates. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](../interfaces/models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](../interfaces/models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -248,9 +248,9 @@ Subscribe to the latest milestone updates. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](../interfaces/models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](../interfaces/models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -268,10 +268,10 @@ Subscribe to updates for a specific output. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`outputId` | *string* | The output to monitor. | -`callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `outputId` | *string* | The output to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -289,9 +289,9 @@ Subscribe to changes in the client state. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`data`: [*IMqttStatus*](../interfaces/models_imqttstatus.imqttstatus.md)) => *void* | Callback called when the state has changed. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`data`: [*IMqttStatus*](../interfaces/models_imqttstatus.imqttstatus.md)) => *void* | Callback called when the state has changed. | **Returns:** *string* @@ -309,16 +309,16 @@ Subscribe to another type of message as json. #### Type parameters: -Name | -:------ | -`T` | +| Name | +| :------ | +| `T` | #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`customTopic` | *string* | The topic to subscribe to. | -`callback` | (`topic`: *string*, `data`: T) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `customTopic` | *string* | The topic to subscribe to. | +| `callback` | (`topic`: *string*, `data`: T) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -336,10 +336,10 @@ Subscribe to another type of message as raw data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`customTopic` | *string* | The topic to subscribe to. | -`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `customTopic` | *string* | The topic to subscribe to. | +| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -357,10 +357,10 @@ Subscribe to message updates for a specific transactionId. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`transactionId` | *string* | The message to monitor. | -`callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `transactionId` | *string* | The message to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IMessage*](../interfaces/models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -378,10 +378,10 @@ Subscribe to message updates for a specific transactionId. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`transactionId` | *string* | The message to monitor. | -`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `transactionId` | *string* | The message to monitor. | +| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -399,9 +399,9 @@ Remove a subscription. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`subscriptionId` | *string* | The subscription to remove. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `subscriptionId` | *string* | The subscription to remove. | **Returns:** *void* diff --git a/docs/classes/clients_singlenodeclient.singlenodeclient.md b/docs/classes/clients_singlenodeclient.singlenodeclient.md index d6d42cd3d..81ef1a33a 100644 --- a/docs/classes/clients_singlenodeclient.singlenodeclient.md +++ b/docs/classes/clients_singlenodeclient.singlenodeclient.md @@ -57,10 +57,10 @@ Create a new instance of client. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`endpoint` | *string* | The endpoint. | -`options?` | SingleNodeClientOptions | Options for the client. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `endpoint` | *string* | The endpoint. | +| `options?` | SingleNodeClientOptions | Options for the client. | **Returns:** [*SingleNodeClient*](clients_singlenodeclient.singlenodeclient.md) @@ -74,9 +74,9 @@ Get the address details. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressBech32` | *string* | The address to get the details for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressBech32` | *string* | The address to get the details for. | **Returns:** *Promise*<[*IAddressResponse*](../interfaces/models_api_iaddressresponse.iaddressresponse.md)\> @@ -94,9 +94,9 @@ Get the address detail using ed25519 address. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressEd25519` | *string* | The address to get the details for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressEd25519` | *string* | The address to get the details for. | **Returns:** *Promise*<[*IAddressResponse*](../interfaces/models_api_iaddressresponse.iaddressresponse.md)\> @@ -114,11 +114,11 @@ Get the address outputs using ed25519 address. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressEd25519` | *string* | The address to get the outputs for. | -`type?` | *number* | Filter the type of outputs you are looking up, defaults to all. | -`includeSpent?` | *boolean* | Filter the type of outputs you are looking up, defaults to false. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressEd25519` | *string* | The address to get the outputs for. | +| `type?` | *number* | Filter the type of outputs you are looking up, defaults to all. | +| `includeSpent?` | *boolean* | Filter the type of outputs you are looking up, defaults to false. | **Returns:** *Promise*<[*IAddressOutputsResponse*](../interfaces/models_api_iaddressoutputsresponse.iaddressoutputsresponse.md)\> @@ -136,11 +136,11 @@ Get the address outputs. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressBech32` | *string* | The address to get the outputs for. | -`type?` | *number* | Filter the type of outputs you are looking up, defaults to all. | -`includeSpent?` | *boolean* | Filter the type of outputs you are looking up, defaults to false. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressBech32` | *string* | The address to get the outputs for. | +| `type?` | *number* | Filter the type of outputs you are looking up, defaults to all. | +| `includeSpent?` | *boolean* | Filter the type of outputs you are looking up, defaults to false. | **Returns:** *Promise*<[*IAddressOutputsResponse*](../interfaces/models_api_iaddressoutputsresponse.iaddressoutputsresponse.md)\> @@ -158,9 +158,9 @@ Combine the query params. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`queryParams` | *string*[] | The quer params to combine. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `queryParams` | *string*[] | The quer params to combine. | **Returns:** *string* @@ -170,23 +170,23 @@ ___ ### fetchBinary -▸ **fetchBinary**(`method`: *get* \| *post*, `route`: *string*, `requestData?`: *Uint8Array*): *Promise* +▸ **fetchBinary**(`method`: ``"get"`` \| ``"post"``, `route`: *string*, `requestData?`: *Uint8Array*): *Promise* Perform a request for binary data. #### Type parameters: -Name | -:------ | -`T` | +| Name | +| :------ | +| `T` | #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`method` | *get* \| *post* | The http method. | -`route` | *string* | The route of the request. | -`requestData?` | *Uint8Array* | Request to send to the endpoint. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `method` | ``"get"`` \| ``"post"`` | The http method. | +| `route` | *string* | The route of the request. | +| `requestData?` | *Uint8Array* | Request to send to the endpoint. | **Returns:** *Promise* @@ -196,24 +196,24 @@ ___ ### fetchJson -▸ **fetchJson**(`method`: *get* \| *post* \| *delete*, `route`: *string*, `requestData?`: T): *Promise* +▸ **fetchJson**(`method`: ``"get"`` \| ``"post"`` \| ``"delete"``, `route`: *string*, `requestData?`: T): *Promise* Perform a request in json format. #### Type parameters: -Name | -:------ | -`T` | -`U` | +| Name | +| :------ | +| `T` | +| `U` | #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`method` | *get* \| *post* \| *delete* | The http method. | -`route` | *string* | The route of the request. | -`requestData?` | T | Request to send to the endpoint. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `method` | ``"get"`` \| ``"post"`` \| ``"delete"`` | The http method. | +| `route` | *string* | The route of the request. | +| `requestData?` | T | Request to send to the endpoint. | **Returns:** *Promise* @@ -229,9 +229,9 @@ Perform a request and just return the status. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`route` | *string* | The route of the request. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `route` | *string* | The route of the request. | **Returns:** *Promise* @@ -275,9 +275,9 @@ Get the message data by id. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`messageId` | *string* | The message to get the data for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | *string* | The message to get the data for. | **Returns:** *Promise*<[*IMessage*](../interfaces/models_imessage.imessage.md)\> @@ -295,9 +295,9 @@ Get the children of a message. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`messageId` | *string* | The id of the message to get the children for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | *string* | The id of the message to get the children for. | **Returns:** *Promise*<[*IChildrenResponse*](../interfaces/models_api_ichildrenresponse.ichildrenresponse.md)\> @@ -315,9 +315,9 @@ Get the message metadata by id. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`messageId` | *string* | The message to get the metadata for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | *string* | The message to get the metadata for. | **Returns:** *Promise*<[*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md)\> @@ -335,9 +335,9 @@ Get the message raw data by id. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`messageId` | *string* | The message to get the data for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | *string* | The message to get the data for. | **Returns:** *Promise* @@ -355,9 +355,9 @@ Submit message. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | [*IMessage*](../interfaces/models_imessage.imessage.md) | The message to submit. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | [*IMessage*](../interfaces/models_imessage.imessage.md) | The message to submit. | **Returns:** *Promise* @@ -375,9 +375,9 @@ Submit message in raw format. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | *Uint8Array* | The message to submit. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | *Uint8Array* | The message to submit. | **Returns:** *Promise* @@ -395,9 +395,9 @@ Find messages by index. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`indexationKey` | *string* \| *Uint8Array* | The index value as a byte array or UTF8 string. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexationKey` | *string* \| *Uint8Array* | The index value as a byte array or UTF8 string. | **Returns:** *Promise*<[*IMessagesResponse*](../interfaces/models_api_imessagesresponse.imessagesresponse.md)\> @@ -415,9 +415,9 @@ Get the requested milestone. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`index` | *number* | The index of the milestone to get. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | *number* | The index of the milestone to get. | **Returns:** *Promise*<[*IMilestoneResponse*](../interfaces/models_api_imilestoneresponse.imilestoneresponse.md)\> @@ -435,9 +435,9 @@ Get the requested milestone utxo changes. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`index` | *number* | The index of the milestone to request the changes for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | *number* | The index of the milestone to request the changes for. | **Returns:** *Promise*<[*IMilestoneUtxoChangesResponse*](../interfaces/models_api_imilestoneutxochangesresponse.imilestoneutxochangesresponse.md)\> @@ -455,9 +455,9 @@ Find an output by its identifier. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`outputId` | *string* | The id of the output to get. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `outputId` | *string* | The id of the output to get. | **Returns:** *Promise*<[*IOutputResponse*](../interfaces/models_api_ioutputresponse.ioutputresponse.md)\> @@ -475,9 +475,9 @@ Get a peer. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`peerId` | *string* | The peer to delete. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `peerId` | *string* | The peer to delete. | **Returns:** *Promise*<[*IPeer*](../interfaces/models_ipeer.ipeer.md)\> @@ -495,10 +495,10 @@ Add a new peer. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`multiAddress` | *string* | The address of the peer to add. | -`alias?` | *string* | An optional alias for the peer. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `multiAddress` | *string* | The address of the peer to add. | +| `alias?` | *string* | An optional alias for the peer. | **Returns:** *Promise*<[*IPeer*](../interfaces/models_ipeer.ipeer.md)\> @@ -516,9 +516,9 @@ Delete a peer. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`peerId` | *string* | The peer to delete. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `peerId` | *string* | The peer to delete. | **Returns:** *Promise* @@ -550,9 +550,9 @@ Get all the stored receipts or those for a given migrated at index. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`migratedAt?` | *number* | The index the receipts were migrated at, if not supplied returns all stored receipts. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `migratedAt?` | *number* | The index the receipts were migrated at, if not supplied returns all stored receipts. | **Returns:** *Promise*<[*IReceiptsResponse*](../interfaces/models_api_ireceiptsresponse.ireceiptsresponse.md)\> @@ -584,9 +584,9 @@ Get the message that was included in the ledger for a transaction. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`transactionId` | *string* | The id of the transaction to get the included message for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `transactionId` | *string* | The id of the transaction to get the included message for. | **Returns:** *Promise*<[*IMessage*](../interfaces/models_imessage.imessage.md)\> diff --git a/docs/classes/crypto_bech32.bech32.md b/docs/classes/crypto_bech32.bech32.md index 829bbb516..c1d115dee 100644 --- a/docs/classes/crypto_bech32.bech32.md +++ b/docs/classes/crypto_bech32.bech32.md @@ -41,9 +41,9 @@ Decode a bech32 string. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bech` | *string* | The text to decode. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bech` | *string* | The text to decode. | **Returns:** *undefined* \| {} @@ -59,9 +59,9 @@ Decode a bech32 string to 5 bit array. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bech` | *string* | The text to decode. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bech` | *string* | The text to decode. | **Returns:** *undefined* \| {} @@ -77,10 +77,10 @@ Encode the buffer. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`humanReadablePart` | *string* | The header | -`data` | *Uint8Array* | The data to encode. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `humanReadablePart` | *string* | The header | +| `data` | *Uint8Array* | The data to encode. | **Returns:** *string* @@ -96,10 +96,10 @@ Encode the 5 bit data buffer. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`humanReadablePart` | *string* | The header | -`data5Bit` | *Uint8Array* | The data to encode. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `humanReadablePart` | *string* | The header | +| `data5Bit` | *Uint8Array* | The data to encode. | **Returns:** *string* @@ -115,9 +115,9 @@ Convert the 5 bit data to 8 bit. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`fiveBit` | *Uint8Array* | The 5 bit data to convert. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `fiveBit` | *Uint8Array* | The 5 bit data to convert. | **Returns:** *Uint8Array* @@ -133,10 +133,10 @@ Does the given string match the bech32 pattern. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`humanReadablePart` | *string* | The human readable part. | -`bech32Text?` | *string* | The text to test. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `humanReadablePart` | *string* | The human readable part. | +| `bech32Text?` | *string* | The text to test. | **Returns:** *boolean* @@ -152,9 +152,9 @@ Convert the input bytes into 5 bit data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bytes` | *Uint8Array* | The bytes to convert. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bytes` | *Uint8Array* | The bytes to convert. | **Returns:** *Uint8Array* diff --git a/docs/classes/crypto_bip32path.bip32path.md b/docs/classes/crypto_bip32path.bip32path.md index e0fd1459a..f3e43a645 100644 --- a/docs/classes/crypto_bip32path.bip32path.md +++ b/docs/classes/crypto_bip32path.bip32path.md @@ -31,9 +31,9 @@ Create a new instance of Bip32Path. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`initialPath?` | *string* | Initial path to create. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `initialPath?` | *string* | Initial path to create. | **Returns:** [*Bip32Path*](crypto_bip32path.bip32path.md) @@ -69,9 +69,9 @@ Push a new index on to the path. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`index` | *number* | The index to add to the path. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | *number* | The index to add to the path. | **Returns:** *void* @@ -85,9 +85,9 @@ Push a new hardened index on to the path. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`index` | *number* | The index to add to the path. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | *number* | The index to add to the path. | **Returns:** *void* @@ -113,9 +113,9 @@ Construct a new path by cloning an existing one. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bip32Path` | [*Bip32Path*](crypto_bip32path.bip32path.md) | The path to clone. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bip32Path` | [*Bip32Path*](crypto_bip32path.bip32path.md) | The path to clone. | **Returns:** [*Bip32Path*](crypto_bip32path.bip32path.md) diff --git a/docs/classes/crypto_bip39.bip39.md b/docs/classes/crypto_bip39.bip39.md index 2d9a0f2dd..f70b03d58 100644 --- a/docs/classes/crypto_bip39.bip39.md +++ b/docs/classes/crypto_bip39.bip39.md @@ -39,9 +39,9 @@ Calculate the entropy checksum. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`entropy` | *Uint8Array* | The entropy to calculate the checksum for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `entropy` | *Uint8Array* | The entropy to calculate the checksum for. | **Returns:** *string* @@ -57,9 +57,9 @@ Generate a mnemonic from the entropy. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`entropy` | *Uint8Array* | The entropy to generate | +| Name | Type | Description | +| :------ | :------ | :------ | +| `entropy` | *Uint8Array* | The entropy to generate | **Returns:** *string* @@ -75,9 +75,9 @@ Convert the mnemonic back to entropy. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`mnemonic` | *string* | The mnemonic to convert. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `mnemonic` | *string* | The mnemonic to convert. | **Returns:** *Uint8Array* @@ -93,12 +93,12 @@ Convert a mnemonic to a seed. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`mnemonic` | *string* | - | The mnemonic to convert. | -`password?` | *string* | - | The password to apply to the seed generation. | -`iterations` | *number* | 2048 | The number of iterations to perform on the password function, defaults to 2048. | -`keyLength` | *number* | 64 | The size of the key length to generate, defaults to 64. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `mnemonic` | *string* | - | The mnemonic to convert. | +| `password?` | *string* | - | The password to apply to the seed generation. | +| `iterations` | *number* | 2048 | The number of iterations to perform on the password function, defaults to 2048. | +| `keyLength` | *number* | 64 | The size of the key length to generate, defaults to 64. | **Returns:** *Uint8Array* @@ -114,9 +114,9 @@ Generate a random mnemonic. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`length` | *number* | 256 | The length of the mnemonic to generate, defaults to 256. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `length` | *number* | 256 | The length of the mnemonic to generate, defaults to 256. | **Returns:** *string* @@ -132,9 +132,9 @@ Set the wordlist and joining character. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`wordlistData` | *string*[] | - | Array of words. | -`joiningChar` | *string* | " " | The character to join the words with. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `wordlistData` | *string*[] | - | Array of words. | +| `joiningChar` | *string* | " " | The character to join the words with. | **Returns:** *void* diff --git a/docs/classes/crypto_blake2b.blake2b.md b/docs/classes/crypto_blake2b.blake2b.md index 99e1012fa..85fe468bc 100644 --- a/docs/classes/crypto_blake2b.blake2b.md +++ b/docs/classes/crypto_blake2b.blake2b.md @@ -45,10 +45,10 @@ Perform Sum 256 on the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`data` | *Uint8Array* | The data to operate on. | -`key?` | *Uint8Array* | Optional key for the hash. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | *Uint8Array* | The data to operate on. | +| `key?` | *Uint8Array* | Optional key for the hash. | **Returns:** *Uint8Array* @@ -64,10 +64,10 @@ Perform Sum 512 on the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`data` | *Uint8Array* | The data to operate on. | -`key?` | *Uint8Array* | Optional key for the hash. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | *Uint8Array* | The data to operate on. | +| `key?` | *Uint8Array* | Optional key for the hash. | **Returns:** *Uint8Array* diff --git a/docs/classes/crypto_curl.curl.md b/docs/classes/crypto_curl.curl.md index e3e85f2df..9086bed16 100644 --- a/docs/classes/crypto_curl.curl.md +++ b/docs/classes/crypto_curl.curl.md @@ -34,9 +34,9 @@ Create a new instance of Curl. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`rounds` | *number* | The number of rounds to perform. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `rounds` | *number* | The number of rounds to perform. | **Returns:** [*Curl*](crypto_curl.curl.md) @@ -66,11 +66,11 @@ Absorbs trits given an offset and length #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`trits` | *Int8Array* | The trits to absorb. | -`offset` | *number* | The offset to start abororbing from the array. | -`length` | *number* | The length of trits to absorb. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `trits` | *Int8Array* | The trits to absorb. | +| `offset` | *number* | The offset to start abororbing from the array. | +| `length` | *number* | The length of trits to absorb. | **Returns:** *void* @@ -84,9 +84,9 @@ Get the state of the sponge. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`len` | *number* | The length of the state to get. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `len` | *number* | The length of the state to get. | **Returns:** *Int8Array* @@ -112,10 +112,10 @@ Squeezes trits given an offset and length #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`trits` | *Int8Array* | The trits to squeeze. | -`offset` | *number* | The offset to start squeezing from the array. | -`length` | *number* | The length of trits to squeeze. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `trits` | *Int8Array* | The trits to squeeze. | +| `offset` | *number* | The offset to start squeezing from the array. | +| `length` | *number* | The length of trits to squeeze. | **Returns:** *void* diff --git a/docs/classes/crypto_edwards25519_cachedgroupelement.cachedgroupelement.md b/docs/classes/crypto_edwards25519_cachedgroupelement.cachedgroupelement.md index 6c783a79f..95f026d1b 100644 --- a/docs/classes/crypto_edwards25519_cachedgroupelement.cachedgroupelement.md +++ b/docs/classes/crypto_edwards25519_cachedgroupelement.cachedgroupelement.md @@ -29,12 +29,12 @@ Create a new instance of CachedGroupElement. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`yPlusX?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | Y + X Element. | -`yMinusX?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | Y - X Element | -`Z?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | Z Element. | -`T2d?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | T2d Element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `yPlusX?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | Y + X Element. | +| `yMinusX?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | Y - X Element | +| `Z?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | Z Element. | +| `T2d?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | T2d Element. | **Returns:** [*CachedGroupElement*](crypto_edwards25519_cachedgroupelement.cachedgroupelement.md) diff --git a/docs/classes/crypto_edwards25519_completedgroupelement.completedgroupelement.md b/docs/classes/crypto_edwards25519_completedgroupelement.completedgroupelement.md index 9fb9349f2..46189e4d0 100644 --- a/docs/classes/crypto_edwards25519_completedgroupelement.completedgroupelement.md +++ b/docs/classes/crypto_edwards25519_completedgroupelement.completedgroupelement.md @@ -40,12 +40,12 @@ Create a new instance of CompletedGroupElement. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`X?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The X element. | -`Y?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Y Element. | -`Z?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Z Element. | -`T?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The T Element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `X?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The X element. | +| `Y?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Y Element. | +| `Z?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Z Element. | +| `T?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The T Element. | **Returns:** [*CompletedGroupElement*](crypto_edwards25519_completedgroupelement.completedgroupelement.md) @@ -91,10 +91,10 @@ Group Element add #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`p` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The extended group element. | -`q` | [*CachedGroupElement*](crypto_edwards25519_cachedgroupelement.cachedgroupelement.md) | The cached group element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `p` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The extended group element. | +| `q` | [*CachedGroupElement*](crypto_edwards25519_cachedgroupelement.cachedgroupelement.md) | The cached group element. | **Returns:** *void* @@ -108,10 +108,10 @@ Mixed add. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`p` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The p. | -`q` | [*PreComputedGroupElement*](crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md) | The q. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `p` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The p. | +| `q` | [*PreComputedGroupElement*](crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md) | The q. | **Returns:** *void* @@ -125,10 +125,10 @@ Mixed subtract. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`p` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The p. | -`q` | [*PreComputedGroupElement*](crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md) | The q. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `p` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The p. | +| `q` | [*PreComputedGroupElement*](crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md) | The q. | **Returns:** *void* @@ -142,10 +142,10 @@ Group Element substract. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`p` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The p. | -`q` | [*CachedGroupElement*](crypto_edwards25519_cachedgroupelement.cachedgroupelement.md) | The q. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `p` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The p. | +| `q` | [*CachedGroupElement*](crypto_edwards25519_cachedgroupelement.cachedgroupelement.md) | The q. | **Returns:** *void* @@ -159,9 +159,9 @@ Convert to extended element. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`e` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The extended element to fill. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `e` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The extended element to fill. | **Returns:** *void* @@ -175,8 +175,8 @@ Convert to projective element. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`p` | [*ProjectiveGroupElement*](crypto_edwards25519_projectivegroupelement.projectivegroupelement.md) | The projective element to fill. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `p` | [*ProjectiveGroupElement*](crypto_edwards25519_projectivegroupelement.projectivegroupelement.md) | The projective element to fill. | **Returns:** *void* diff --git a/docs/classes/crypto_edwards25519_extendedgroupelement.extendedgroupelement.md b/docs/classes/crypto_edwards25519_extendedgroupelement.extendedgroupelement.md index ddd9b5c03..0d6ddc9ec 100644 --- a/docs/classes/crypto_edwards25519_extendedgroupelement.extendedgroupelement.md +++ b/docs/classes/crypto_edwards25519_extendedgroupelement.extendedgroupelement.md @@ -42,12 +42,12 @@ Create a new instance of ExtendedGroupElement. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`X?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The X element. | -`Y?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Y Element. | -`Z?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Z Element. | -`T?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The T Element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `X?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The X element. | +| `Y?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Y Element. | +| `Z?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Z Element. | +| `T?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The T Element. | **Returns:** [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) @@ -94,9 +94,9 @@ CofactorEqual checks whether p, q are equal up to cofactor multiplication #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`q` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The extended group element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `q` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The extended group element. | **Returns:** *boolean* @@ -112,9 +112,9 @@ Double the element. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`cachedGroupElement` | [*CompletedGroupElement*](crypto_edwards25519_completedgroupelement.completedgroupelement.md) | The element to populate. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `cachedGroupElement` | [*CompletedGroupElement*](crypto_edwards25519_completedgroupelement.completedgroupelement.md) | The element to populate. | **Returns:** *void* @@ -128,9 +128,9 @@ Populate the element from bytes. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bytes` | *Uint8Array* | The butes to populate from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bytes` | *Uint8Array* | The butes to populate from. | **Returns:** *boolean* @@ -150,9 +150,9 @@ Preconditions: #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`a` | *Uint8Array* | The a. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `a` | *Uint8Array* | The a. | **Returns:** *void* @@ -166,9 +166,9 @@ Convert the element to bytes. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bytes` | *Uint8Array* | The array to store the bytes in. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bytes` | *Uint8Array* | The array to store the bytes in. | **Returns:** *void* @@ -182,9 +182,9 @@ Convert to a cached group element. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`cacheGroupElement` | [*CachedGroupElement*](crypto_edwards25519_cachedgroupelement.cachedgroupelement.md) | The element to populate. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `cacheGroupElement` | [*CachedGroupElement*](crypto_edwards25519_cachedgroupelement.cachedgroupelement.md) | The element to populate. | **Returns:** *void* @@ -198,9 +198,9 @@ Convert to a projective group element. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`projectiveGroupElement` | [*ProjectiveGroupElement*](crypto_edwards25519_projectivegroupelement.projectivegroupelement.md) | The element to populate. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `projectiveGroupElement` | [*ProjectiveGroupElement*](crypto_edwards25519_projectivegroupelement.projectivegroupelement.md) | The element to populate. | **Returns:** *void* diff --git a/docs/classes/crypto_edwards25519_fieldelement.fieldelement.md b/docs/classes/crypto_edwards25519_fieldelement.fieldelement.md index b47dbe628..e2f92bf67 100644 --- a/docs/classes/crypto_edwards25519_fieldelement.fieldelement.md +++ b/docs/classes/crypto_edwards25519_fieldelement.fieldelement.md @@ -51,9 +51,9 @@ Create a new instance of FieldElement. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`values?` | *number*[] \| *Int32Array* | A set of values to initialize the array. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `values?` | *number*[] \| *Int32Array* | A set of values to initialize the array. | **Returns:** [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) @@ -75,10 +75,10 @@ Add the elements and store in this. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`a` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The a element. | -`b` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The b element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `a` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The a element. | +| `b` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The b element. | **Returns:** *void* @@ -95,10 +95,10 @@ Preconditions: b in {0,1}. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`g` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The g element. | -`b` | *number* | The b value. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `g` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The g element. | +| `b` | *number* | The b value. | **Returns:** *void* @@ -124,18 +124,18 @@ Combine the element. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`h0` | *bigint* | The h0 component. | -`h1` | *bigint* | The h1 component. | -`h2` | *bigint* | The h2 component. | -`h3` | *bigint* | The h3 component. | -`h4` | *bigint* | The h4 component. | -`h5` | *bigint* | The h5 component. | -`h6` | *bigint* | The h6 component. | -`h7` | *bigint* | The h7 component. | -`h8` | *bigint* | The h8 component. | -`h9` | *bigint* | The h9 component. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `h0` | *bigint* | The h0 component. | +| `h1` | *bigint* | The h1 component. | +| `h2` | *bigint* | The h2 component. | +| `h3` | *bigint* | The h3 component. | +| `h4` | *bigint* | The h4 component. | +| `h5` | *bigint* | The h5 component. | +| `h6` | *bigint* | The h6 component. | +| `h7` | *bigint* | The h7 component. | +| `h8` | *bigint* | The h8 component. | +| `h9` | *bigint* | The h9 component. | **Returns:** *void* @@ -149,9 +149,9 @@ Populate from bytes. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bytes` | *Uint8Array* | The bytes to populate from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bytes` | *Uint8Array* | The bytes to populate from. | **Returns:** *void* @@ -171,9 +171,9 @@ Postconditions: #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`f` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The f element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `f` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The f element. | **Returns:** *object* @@ -189,9 +189,9 @@ Invert #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`z` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The elemnt to invert. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `z` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The elemnt to invert. | **Returns:** *void* @@ -255,10 +255,10 @@ With tighter constraints on inputs, can squeeze carries into: number. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`f` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The f element. | -`g` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The g element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `f` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The f element. | +| `g` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The g element. | **Returns:** *void* @@ -298,9 +298,9 @@ Perform the pow 22523 calculate. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`z` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The element to operate on. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `z` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The element to operate on. | **Returns:** *void* @@ -320,9 +320,9 @@ Postconditions: #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`f` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The f element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `f` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The f element. | **Returns:** *void* @@ -345,9 +345,9 @@ See fe_mul.c for discussion of implementation strategy. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`f` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The f element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `f` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The f element. | **Returns:** *void* @@ -361,10 +361,10 @@ Subtract the elements and store in this. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`a` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The a element. | -`b` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The b element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `a` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The a element. | +| `b` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The b element. | **Returns:** *void* @@ -400,9 +400,9 @@ Proof: #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bytes` | *Uint8Array* | The bytes to populate. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bytes` | *Uint8Array* | The bytes to populate. | **Returns:** *void* diff --git a/docs/classes/crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md b/docs/classes/crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md index 4343d68a4..720f400b9 100644 --- a/docs/classes/crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md +++ b/docs/classes/crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md @@ -36,11 +36,11 @@ Create a new instance of PreComputedGroupElement. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`yPlusX?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | Y + X Element. | -`yMinusX?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | Y - X Element | -`xy2d?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | XY2d Element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `yPlusX?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | Y + X Element. | +| `yMinusX?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | Y - X Element | +| `xy2d?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | XY2d Element. | **Returns:** [*PreComputedGroupElement*](crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md) @@ -78,10 +78,10 @@ CMove the pre computed element. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`u` | [*PreComputedGroupElement*](crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md) | The u. | -`b` | *number* | The b. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `u` | [*PreComputedGroupElement*](crypto_edwards25519_precomputedgroupelement.precomputedgroupelement.md) | The u. | +| `b` | *number* | The b. | **Returns:** *void* @@ -95,10 +95,10 @@ Select point. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`pos` | *number* | The position. | -`b` | *number* | The index. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `pos` | *number* | The position. | +| `b` | *number* | The index. | **Returns:** *void* diff --git a/docs/classes/crypto_edwards25519_projectivegroupelement.projectivegroupelement.md b/docs/classes/crypto_edwards25519_projectivegroupelement.projectivegroupelement.md index b073c0d4d..44e482092 100644 --- a/docs/classes/crypto_edwards25519_projectivegroupelement.projectivegroupelement.md +++ b/docs/classes/crypto_edwards25519_projectivegroupelement.projectivegroupelement.md @@ -34,11 +34,11 @@ Create a new instance of CompletedGroupElement. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`X?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The X element. | -`Y?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Y Element. | -`Z?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Z Element. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `X?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The X element. | +| `Y?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Y Element. | +| `Z?` | [*FieldElement*](crypto_edwards25519_fieldelement.fieldelement.md) | The Z Element. | **Returns:** [*ProjectiveGroupElement*](crypto_edwards25519_projectivegroupelement.projectivegroupelement.md) @@ -79,10 +79,10 @@ B is the Ed25519 base point (x,4/5) with x positive. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`a` | *Uint8Array* | The a | -`A` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The A | -`b` | *Uint8Array* | The b | +| Name | Type | Description | +| :------ | :------ | :------ | +| `a` | *Uint8Array* | The a | +| `A` | [*ExtendedGroupElement*](crypto_edwards25519_extendedgroupelement.extendedgroupelement.md) | The A | +| `b` | *Uint8Array* | The b | **Returns:** *void* diff --git a/docs/classes/crypto_hmacsha256.hmacsha256.md b/docs/classes/crypto_hmacsha256.hmacsha256.md index c31454629..00fba8bc3 100644 --- a/docs/classes/crypto_hmacsha256.hmacsha256.md +++ b/docs/classes/crypto_hmacsha256.hmacsha256.md @@ -29,10 +29,10 @@ Create a new instance of HmacSha256. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`key` | *Uint8Array* | - | The key for the hmac. | -`bits` | *number* | 256 | The number of bits. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `key` | *Uint8Array* | - | The key for the hmac. | +| `bits` | *number* | 256 | The number of bits. | **Returns:** [*HmacSha256*](crypto_hmacsha256.hmacsha256.md) @@ -58,9 +58,9 @@ Update the hash with the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | *Uint8Array* | The data to update the hash with. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | *Uint8Array* | The data to update the hash with. | **Returns:** [*HmacSha256*](crypto_hmacsha256.hmacsha256.md) @@ -76,10 +76,10 @@ Perform Sum 256 on the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`key` | *Uint8Array* | The key for the hmac. | -`data` | *Uint8Array* | The data to operate on. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | *Uint8Array* | The key for the hmac. | +| `data` | *Uint8Array* | The data to operate on. | **Returns:** *Uint8Array* diff --git a/docs/classes/crypto_hmacsha512.hmacsha512.md b/docs/classes/crypto_hmacsha512.hmacsha512.md index 942720290..681bb6446 100644 --- a/docs/classes/crypto_hmacsha512.hmacsha512.md +++ b/docs/classes/crypto_hmacsha512.hmacsha512.md @@ -29,10 +29,10 @@ Create a new instance of HmacSha512. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`key` | *Uint8Array* | - | The key for the hmac. | -`bits` | *number* | 512 | The number of bits. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `key` | *Uint8Array* | - | The key for the hmac. | +| `bits` | *number* | 512 | The number of bits. | **Returns:** [*HmacSha512*](crypto_hmacsha512.hmacsha512.md) @@ -58,9 +58,9 @@ Update the hash with the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | *Uint8Array* | The data to update the hash with. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | *Uint8Array* | The data to update the hash with. | **Returns:** [*HmacSha512*](crypto_hmacsha512.hmacsha512.md) @@ -76,10 +76,10 @@ Perform Sum 512 on the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`key` | *Uint8Array* | The key for the hmac. | -`data` | *Uint8Array* | The data to operate on. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | *Uint8Array* | The key for the hmac. | +| `data` | *Uint8Array* | The data to operate on. | **Returns:** *Uint8Array* diff --git a/docs/classes/crypto_pbkdf2.pbkdf2.md b/docs/classes/crypto_pbkdf2.pbkdf2.md index 536454d7f..8f390159b 100644 --- a/docs/classes/crypto_pbkdf2.pbkdf2.md +++ b/docs/classes/crypto_pbkdf2.pbkdf2.md @@ -35,12 +35,12 @@ Derive a key from the parameters using Sha256. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`password` | *Uint8Array* | The password to derive the key from. | -`salt` | *Uint8Array* | The salt for the derivation. | -`iterations` | *number* | Numer of iterations to perform. | -`keyLength` | *number* | The length of the key to derive. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `password` | *Uint8Array* | The password to derive the key from. | +| `salt` | *Uint8Array* | The salt for the derivation. | +| `iterations` | *number* | Numer of iterations to perform. | +| `keyLength` | *number* | The length of the key to derive. | **Returns:** *Uint8Array* @@ -56,12 +56,12 @@ Derive a key from the parameters using Sha512. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`password` | *Uint8Array* | The password to derive the key from. | -`salt` | *Uint8Array* | The salt for the derivation. | -`iterations` | *number* | Numer of iterations to perform. | -`keyLength` | *number* | The length of the key to derive. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `password` | *Uint8Array* | The password to derive the key from. | +| `salt` | *Uint8Array* | The salt for the derivation. | +| `iterations` | *number* | Numer of iterations to perform. | +| `keyLength` | *number* | The length of the key to derive. | **Returns:** *Uint8Array* diff --git a/docs/classes/crypto_sha256.sha256.md b/docs/classes/crypto_sha256.sha256.md index 67fb6e531..ac1389d03 100644 --- a/docs/classes/crypto_sha256.sha256.md +++ b/docs/classes/crypto_sha256.sha256.md @@ -35,9 +35,9 @@ Create a new instance of Sha256. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bits` | *number* | The number of bits. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bits` | *number* | The number of bits. | **Returns:** [*Sha256*](crypto_sha256.sha256.md) @@ -79,9 +79,9 @@ Update the hash with the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | *Uint8Array* | The data to update the hash with. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | *Uint8Array* | The data to update the hash with. | **Returns:** [*Sha256*](crypto_sha256.sha256.md) @@ -97,9 +97,9 @@ Perform Sum 224 on the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`data` | *Uint8Array* | The data to operate on. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | *Uint8Array* | The data to operate on. | **Returns:** *Uint8Array* @@ -115,9 +115,9 @@ Perform Sum 256 on the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`data` | *Uint8Array* | The data to operate on. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | *Uint8Array* | The data to operate on. | **Returns:** *Uint8Array* diff --git a/docs/classes/crypto_sha512.sha512.md b/docs/classes/crypto_sha512.sha512.md index 9ba523ff4..49d6fee4b 100644 --- a/docs/classes/crypto_sha512.sha512.md +++ b/docs/classes/crypto_sha512.sha512.md @@ -36,9 +36,9 @@ Create a new instance of Sha512. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bits` | *number* | The number of bits. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bits` | *number* | The number of bits. | **Returns:** [*Sha512*](crypto_sha512.sha512.md) @@ -96,9 +96,9 @@ Update the hash with the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | *Uint8Array* | The data to update the hash with. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | *Uint8Array* | The data to update the hash with. | **Returns:** [*Sha512*](crypto_sha512.sha512.md) @@ -114,9 +114,9 @@ Perform Sum 512 on the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`data` | *Uint8Array* | The data to operate on. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | *Uint8Array* | The data to operate on. | **Returns:** *Uint8Array* diff --git a/docs/classes/crypto_slip0010.slip0010.md b/docs/classes/crypto_slip0010.slip0010.md index 3f4510868..28697817c 100644 --- a/docs/classes/crypto_slip0010.slip0010.md +++ b/docs/classes/crypto_slip0010.slip0010.md @@ -37,10 +37,10 @@ Derive a key from the path. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`seed` | *Uint8Array* | The seed. | -`path` | [*Bip32Path*](crypto_bip32path.bip32path.md) | The path. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `seed` | *Uint8Array* | The seed. | +| `path` | [*Bip32Path*](crypto_bip32path.bip32path.md) | The path. | **Returns:** *object* @@ -56,9 +56,9 @@ Get the master key from the seed. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`seed` | *Uint8Array* | The seed to generate the master key from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `seed` | *Uint8Array* | The seed to generate the master key from. | **Returns:** *object* @@ -74,10 +74,10 @@ Get the public key from the private key. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`privateKey` | *Uint8Array* | - | The private key. | -`withZeroByte` | *boolean* | true | Include a zero bute prefix. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `privateKey` | *Uint8Array* | - | The private key. | +| `withZeroByte` | *boolean* | true | Include a zero bute prefix. | **Returns:** *Uint8Array* diff --git a/docs/classes/encoding_b1t6.b1t6.md b/docs/classes/encoding_b1t6.b1t6.md index e22f77eaa..04925dc3c 100644 --- a/docs/classes/encoding_b1t6.b1t6.md +++ b/docs/classes/encoding_b1t6.b1t6.md @@ -35,11 +35,11 @@ Encode a byte array into trits. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`dst` | *Int8Array* | The destination array. | -`startIndex` | *number* | The start index to write in the array. | -`src` | *Uint8Array* | The source data. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `dst` | *Int8Array* | The destination array. | +| `startIndex` | *number* | The start index to write in the array. | +| `src` | *Uint8Array* | The source data. | **Returns:** *number* @@ -55,9 +55,9 @@ The encoded length of the data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`data` | *Uint8Array* | The data. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | *Uint8Array* | The data. | **Returns:** *number* diff --git a/docs/classes/pow_localpowprovider.localpowprovider.md b/docs/classes/pow_localpowprovider.localpowprovider.md index b7051767c..fb7846802 100644 --- a/docs/classes/pow_localpowprovider.localpowprovider.md +++ b/docs/classes/pow_localpowprovider.localpowprovider.md @@ -39,10 +39,10 @@ Perform pow on the message and return the nonce of at least targetScore. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | *Uint8Array* | The message to process. | -`targetScore` | *number* | the target score. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | *Uint8Array* | The message to process. | +| `targetScore` | *number* | the target score. | **Returns:** *Promise* diff --git a/docs/classes/seedtypes_ed25519seed.ed25519seed.md b/docs/classes/seedtypes_ed25519seed.ed25519seed.md index 909d01fde..10eb12b15 100644 --- a/docs/classes/seedtypes_ed25519seed.ed25519seed.md +++ b/docs/classes/seedtypes_ed25519seed.ed25519seed.md @@ -33,9 +33,9 @@ Create a new instance of Ed25519Seed. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`secretKeyBytes?` | *Uint8Array* | The bytes. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `secretKeyBytes?` | *Uint8Array* | The bytes. | **Returns:** [*Ed25519Seed*](seedtypes_ed25519seed.ed25519seed.md) @@ -49,9 +49,9 @@ Generate a new seed from the path. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`path` | [*Bip32Path*](crypto_bip32path.bip32path.md) | The path to generate the seed for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `path` | [*Bip32Path*](crypto_bip32path.bip32path.md) | The path to generate the seed for. | **Returns:** [*ISeed*](../interfaces/models_iseed.iseed.md) @@ -97,9 +97,9 @@ Create the seed from a Bip39 mnemonic. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`mnemonic` | *string* | The mnemonic to create the seed from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `mnemonic` | *string* | The mnemonic to create the seed from. | **Returns:** [*Ed25519Seed*](seedtypes_ed25519seed.ed25519seed.md) diff --git a/docs/classes/utils_arrayhelper.arrayhelper.md b/docs/classes/utils_arrayhelper.arrayhelper.md index e759b8021..7544220d6 100644 --- a/docs/classes/utils_arrayhelper.arrayhelper.md +++ b/docs/classes/utils_arrayhelper.arrayhelper.md @@ -34,10 +34,10 @@ Are the two array equals. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`array1` | *undefined* \| *ArrayLike* | The first array. | -`array2` | *undefined* \| *ArrayLike* | The second array. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `array1` | *undefined* \| *ArrayLike* | The first array. | +| `array2` | *undefined* \| *ArrayLike* | The second array. | **Returns:** *boolean* diff --git a/docs/classes/utils_bech32helper.bech32helper.md b/docs/classes/utils_bech32helper.bech32helper.md index 395015750..6204ea0c7 100644 --- a/docs/classes/utils_bech32helper.bech32helper.md +++ b/docs/classes/utils_bech32helper.bech32helper.md @@ -57,10 +57,10 @@ Decode an address from bech32. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bech32Text` | *string* | The bech32 text to decode. | -`humanReadablePart` | *string* | The human readable part to use. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bech32Text` | *string* | The bech32 text to decode. | +| `humanReadablePart` | *string* | The human readable part to use. | **Returns:** *undefined* \| {} @@ -76,10 +76,10 @@ Does the provided string look like it might be an bech32 address with matching h #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bech32Text` | *string* | The bech32 text to text. | -`humanReadablePart` | *string* | The human readable part to match. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bech32Text` | *string* | The bech32 text to text. | +| `humanReadablePart` | *string* | The human readable part to match. | **Returns:** *boolean* @@ -95,11 +95,11 @@ Encode an address to bech32. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressType` | *number* | The address type to encode. | -`addressBytes` | *Uint8Array* | The address bytes to encode. | -`humanReadablePart` | *string* | The human readable part to use. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressType` | *number* | The address type to encode. | +| `addressBytes` | *Uint8Array* | The address bytes to encode. | +| `humanReadablePart` | *string* | The human readable part to use. | **Returns:** *string* diff --git a/docs/classes/utils_biginthelper.biginthelper.md b/docs/classes/utils_biginthelper.biginthelper.md index 9f98adc61..80303f386 100644 --- a/docs/classes/utils_biginthelper.biginthelper.md +++ b/docs/classes/utils_biginthelper.biginthelper.md @@ -50,10 +50,10 @@ Load 3 bytes from array as bigint. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`data` | *Uint8Array* | The input array. | -`byteOffset` | *number* | The start index to read from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | *Uint8Array* | The input array. | +| `byteOffset` | *number* | The start index to read from. | **Returns:** *bigint* @@ -69,10 +69,10 @@ Load 4 bytes from array as bigint. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`data` | *Uint8Array* | The input array. | -`byteOffset` | *number* | The start index to read from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | *Uint8Array* | The input array. | +| `byteOffset` | *number* | The start index to read from. | **Returns:** *bigint* @@ -88,10 +88,10 @@ Load 8 bytes from array as bigint. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`data` | *Uint8Array* | The data to read from. | -`byteOffset` | *number* | The start index to read from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | *Uint8Array* | The data to read from. | +| `byteOffset` | *number* | The start index to read from. | **Returns:** *bigint* @@ -107,10 +107,10 @@ Convert a big int to bytes. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`value` | *bigint* | The bigint. | -`data` | *Uint8Array* | The buffer to write into. | -`byteOffset` | *number* | The start index to write from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | *bigint* | The bigint. | +| `data` | *Uint8Array* | The buffer to write into. | +| `byteOffset` | *number* | The start index to write from. | **Returns:** *void* diff --git a/docs/classes/utils_converter.converter.md b/docs/classes/utils_converter.converter.md index c75330de9..6e5581b92 100644 --- a/docs/classes/utils_converter.converter.md +++ b/docs/classes/utils_converter.converter.md @@ -44,9 +44,9 @@ Convert a base64 string to bytes. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`base64` | *string* | The base64 string. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `base64` | *string* | The base64 string. | **Returns:** *Uint8Array* @@ -62,9 +62,9 @@ Convert a binary string to bytes. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`binary` | *string* | The binary string. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `binary` | *string* | The binary string. | **Returns:** *Uint8Array* @@ -80,9 +80,9 @@ Convert bytes to base64 string. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bytes` | *Uint8Array* | The bytes to convert. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bytes` | *Uint8Array* | The bytes to convert. | **Returns:** *string* @@ -98,9 +98,9 @@ Convert bytes to binary string. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`bytes` | *Uint8Array* | The bytes to convert. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `bytes` | *Uint8Array* | The bytes to convert. | **Returns:** *string* @@ -116,12 +116,12 @@ Encode a raw array to hex string. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`array` | *ArrayLike* | The bytes to encode. | -`startIndex?` | *number* | The index to start in the bytes. | -`length?` | *number* | The length of bytes to read. | -`reverse?` | *boolean* | Reverse the combine direction. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `array` | *ArrayLike* | The bytes to encode. | +| `startIndex?` | *number* | The index to start in the bytes. | +| `length?` | *number* | The length of bytes to read. | +| `reverse?` | *boolean* | Reverse the combine direction. | **Returns:** *string* @@ -137,11 +137,11 @@ Encode a raw array to UTF8 string. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`array` | *ArrayLike* | The bytes to encode. | -`startIndex?` | *number* | The index to start in the bytes. | -`length?` | *number* | The length of bytes to read. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `array` | *ArrayLike* | The bytes to encode. | +| `startIndex?` | *number* | The index to start in the bytes. | +| `length?` | *number* | The length of bytes to read. | **Returns:** *string* @@ -157,10 +157,10 @@ Decode a hex string to raw array. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`hex` | *string* | The hex to decode. | -`reverse?` | *boolean* | Store the characters in reverse. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `hex` | *string* | The hex to decode. | +| `reverse?` | *boolean* | Store the characters in reverse. | **Returns:** *Uint8Array* @@ -176,9 +176,9 @@ Convert the hex text to text. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`hex` | *string* | The hex to convert. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `hex` | *string* | The hex to convert. | **Returns:** *string* @@ -194,9 +194,9 @@ Is the data hex format. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`value` | *string* | The value to test. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | *string* | The value to test. | **Returns:** *boolean* @@ -212,9 +212,9 @@ Convert a UTF8 string to raw array. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`utf8` | *string* | The text to decode. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `utf8` | *string* | The text to decode. | **Returns:** *Uint8Array* @@ -230,9 +230,9 @@ Convert the UTF8 to hex. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`utf8` | *string* | The text to convert. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `utf8` | *string* | The text to convert. | **Returns:** *string* diff --git a/docs/classes/utils_powhelper.powhelper.md b/docs/classes/utils_powhelper.powhelper.md index 2cc8cbc9f..905bb25a1 100644 --- a/docs/classes/utils_powhelper.powhelper.md +++ b/docs/classes/utils_powhelper.powhelper.md @@ -36,9 +36,9 @@ Perform the score calculation. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | *Uint8Array* | The data to perform the score on | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | *Uint8Array* | The data to perform the score on | **Returns:** *number* @@ -54,10 +54,10 @@ Calculate the trailing zeros. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`powDigest` | *Uint8Array* | The pow digest. | -`nonce` | *bigint* | The nonce. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `powDigest` | *Uint8Array* | The pow digest. | +| `nonce` | *bigint* | The nonce. | **Returns:** *number* @@ -73,9 +73,9 @@ Find the number of trailing zeros. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`trits` | *Int8Array* | The trits to look for zeros. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `trits` | *Int8Array* | The trits to look for zeros. | **Returns:** *number* diff --git a/docs/classes/utils_randomhelper.randomhelper.md b/docs/classes/utils_randomhelper.randomhelper.md index a59f11ce4..d6896db7f 100644 --- a/docs/classes/utils_randomhelper.randomhelper.md +++ b/docs/classes/utils_randomhelper.randomhelper.md @@ -34,9 +34,9 @@ Generate a new random array. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`length` | *number* | The length of buffer to create. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `length` | *number* | The length of buffer to create. | **Returns:** *Uint8Array* diff --git a/docs/classes/utils_readstream.readstream.md b/docs/classes/utils_readstream.readstream.md index 65999eb71..74f49fb54 100644 --- a/docs/classes/utils_readstream.readstream.md +++ b/docs/classes/utils_readstream.readstream.md @@ -37,10 +37,10 @@ Create a new instance of ReadStream. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`storage` | *Uint8Array* | - | The data to access. | -`readStartIndex` | *number* | 0 | The index to start the reading from. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `storage` | *Uint8Array* | - | The data to access. | +| `readStartIndex` | *number* | 0 | The index to start the reading from. | **Returns:** [*ReadStream*](utils_readstream.readstream.md) @@ -66,9 +66,9 @@ Does the storage have enough data remaining. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`remaining` | *number* | The amount of space needed. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `remaining` | *number* | The amount of space needed. | **Returns:** *boolean* @@ -96,10 +96,10 @@ Read a boolean from the stream. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`name` | *string* | - | The name of the data we are trying to read. | -`moveIndex` | *boolean* | true | Move the index pointer on. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | *string* | - | The name of the data we are trying to read. | +| `moveIndex` | *boolean* | true | Move the index pointer on. | **Returns:** *boolean* @@ -115,10 +115,10 @@ Read a byte from the stream. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`name` | *string* | - | The name of the data we are trying to read. | -`moveIndex` | *boolean* | true | Move the index pointer on. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | *string* | - | The name of the data we are trying to read. | +| `moveIndex` | *boolean* | true | Move the index pointer on. | **Returns:** *number* @@ -134,11 +134,11 @@ Read an array of byte from the stream. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`name` | *string* | - | The name of the data we are trying to read. | -`length` | *number* | - | The length of the array to read. | -`moveIndex` | *boolean* | true | Move the index pointer on. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | *string* | - | The name of the data we are trying to read. | +| `length` | *number* | - | The length of the array to read. | +| `moveIndex` | *boolean* | true | Move the index pointer on. | **Returns:** *Uint8Array* @@ -154,11 +154,11 @@ Read fixed length as hex. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`name` | *string* | - | The name of the data we are trying to read. | -`length` | *number* | - | The length of the data to read. | -`moveIndex` | *boolean* | true | Move the index pointer on. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | *string* | - | The name of the data we are trying to read. | +| `length` | *number* | - | The length of the data to read. | +| `moveIndex` | *boolean* | true | Move the index pointer on. | **Returns:** *string* @@ -174,10 +174,10 @@ Read a UInt16 from the stream. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`name` | *string* | - | The name of the data we are trying to read. | -`moveIndex` | *boolean* | true | Move the index pointer on. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | *string* | - | The name of the data we are trying to read. | +| `moveIndex` | *boolean* | true | Move the index pointer on. | **Returns:** *number* @@ -193,10 +193,10 @@ Read a UInt32 from the stream. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`name` | *string* | - | The name of the data we are trying to read. | -`moveIndex` | *boolean* | true | Move the index pointer on. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | *string* | - | The name of the data we are trying to read. | +| `moveIndex` | *boolean* | true | Move the index pointer on. | **Returns:** *number* @@ -212,10 +212,10 @@ Read a UInt64 from the stream. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`name` | *string* | - | The name of the data we are trying to read. | -`moveIndex` | *boolean* | true | Move the index pointer on. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `name` | *string* | - | The name of the data we are trying to read. | +| `moveIndex` | *boolean* | true | Move the index pointer on. | **Returns:** *bigint* @@ -231,9 +231,9 @@ Set the current read index. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readIndex` | *number* | The current read index. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readIndex` | *number* | The current read index. | **Returns:** *void* diff --git a/docs/classes/utils_unitshelper.unitshelper.md b/docs/classes/utils_unitshelper.unitshelper.md index ba74040a7..90e90ca35 100644 --- a/docs/classes/utils_unitshelper.unitshelper.md +++ b/docs/classes/utils_unitshelper.unitshelper.md @@ -51,9 +51,9 @@ Format the value in the best units. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`value` | *number* | The value to format. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | *number* | The value to format. | **Returns:** Units @@ -69,11 +69,11 @@ Convert the value to different units. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`value` | *number* | The value to convert. | -`fromUnit` | Units | The form unit. | -`toUnit` | Units | The to unit. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | *number* | The value to convert. | +| `fromUnit` | Units | The form unit. | +| `toUnit` | Units | The to unit. | **Returns:** *number* @@ -89,10 +89,10 @@ Format the value in the best units. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`value` | *number* | - | The value to format. | -`decimalPlaces` | *number* | 2 | The number of decimal places to display. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `value` | *number* | - | The value to format. | +| `decimalPlaces` | *number* | 2 | The number of decimal places to display. | **Returns:** *string* @@ -108,11 +108,11 @@ Format the value in the best units. #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`value` | *number* | - | The value to format. | -`unit` | Units | - | The unit to format with. | -`decimalPlaces` | *number* | 2 | The number of decimal places to display. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `value` | *number* | - | The value to format. | +| `unit` | Units | - | The unit to format with. | +| `decimalPlaces` | *number* | 2 | The number of decimal places to display. | **Returns:** *string* diff --git a/docs/classes/utils_writestream.writestream.md b/docs/classes/utils_writestream.writestream.md index 9ab16120a..d7cab033a 100644 --- a/docs/classes/utils_writestream.writestream.md +++ b/docs/classes/utils_writestream.writestream.md @@ -96,9 +96,9 @@ Set the current write index. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeIndex` | *number* | The current write index. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeIndex` | *number* | The current write index. | **Returns:** *void* @@ -124,10 +124,10 @@ Write a boolean to the stream. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`name` | *string* | The name of the data we are trying to write. | -`val` | *boolean* | The data to write. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | *string* | The name of the data we are trying to write. | +| `val` | *boolean* | The data to write. | **Returns:** *void* @@ -141,10 +141,10 @@ Write a byte to the stream. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`name` | *string* | The name of the data we are trying to write. | -`val` | *number* | The data to write. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | *string* | The name of the data we are trying to write. | +| `val` | *number* | The data to write. | **Returns:** *void* @@ -158,11 +158,11 @@ Write fixed length stream. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`name` | *string* | The name of the data we are trying to write. | -`length` | *number* | The length of the data to write. | -`val` | *Uint8Array* | The data to write. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | *string* | The name of the data we are trying to write. | +| `length` | *number* | The length of the data to write. | +| `val` | *Uint8Array* | The data to write. | **Returns:** *void* @@ -176,11 +176,11 @@ Write fixed length stream. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`name` | *string* | The name of the data we are trying to write. | -`length` | *number* | The length of the data to write. | -`val` | *string* | The data to write. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | *string* | The name of the data we are trying to write. | +| `length` | *number* | The length of the data to write. | +| `val` | *string* | The data to write. | **Returns:** *void* @@ -194,10 +194,10 @@ Write a UInt16 to the stream. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`name` | *string* | The name of the data we are trying to write. | -`val` | *number* | The data to write. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | *string* | The name of the data we are trying to write. | +| `val` | *number* | The data to write. | **Returns:** *void* @@ -211,10 +211,10 @@ Write a UInt32 to the stream. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`name` | *string* | The name of the data we are trying to write. | -`val` | *number* | The data to write. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | *string* | The name of the data we are trying to write. | +| `val` | *number* | The data to write. | **Returns:** *void* @@ -228,9 +228,9 @@ Write a UInt64 to the stream. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`name` | *string* | The name of the data we are trying to write. | -`val` | *bigint* | The data to write. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | *string* | The name of the data we are trying to write. | +| `val` | *bigint* | The data to write. | **Returns:** *void* diff --git a/docs/interfaces/models_api_iresponse.iresponse.md b/docs/interfaces/models_api_iresponse.iresponse.md index ad6c13015..7eb9d7563 100644 --- a/docs/interfaces/models_api_iresponse.iresponse.md +++ b/docs/interfaces/models_api_iresponse.iresponse.md @@ -8,9 +8,9 @@ Base response data. ## Type parameters -Name | -:------ | -`T` | +| Name | +| :------ | +| `T` | ## Table of contents @@ -37,7 +37,7 @@ Optional error in the response. #### Type declaration: -Name | Type | Description | -:------ | :------ | :------ | -`code` | *string* | The code for the error response. | -`message` | *string* | A more descriptive version of the error. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `code` | *string* | The code for the error response. | +| `message` | *string* | A more descriptive version of the error. | diff --git a/docs/interfaces/models_iaddress.iaddress.md b/docs/interfaces/models_iaddress.iaddress.md index d828b3de8..e99ecf1bb 100644 --- a/docs/interfaces/models_iaddress.iaddress.md +++ b/docs/interfaces/models_iaddress.iaddress.md @@ -39,10 +39,10 @@ Use the public key to validate the address. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`publicKey` | *Uint8Array* | - | -`address` | *Uint8Array* | The address to verify. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `publicKey` | *Uint8Array* | - | +| `address` | *Uint8Array* | The address to verify. | **Returns:** *boolean* diff --git a/docs/interfaces/models_iclient.iclient.md b/docs/interfaces/models_iclient.iclient.md index faa34dc12..67fb73543 100644 --- a/docs/interfaces/models_iclient.iclient.md +++ b/docs/interfaces/models_iclient.iclient.md @@ -49,9 +49,9 @@ Get the address details using bech32 address. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressBech32` | *string* | The address to get the details for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressBech32` | *string* | The address to get the details for. | **Returns:** *Promise*<[*IAddressResponse*](models_api_iaddressresponse.iaddressresponse.md)\> @@ -67,9 +67,9 @@ Get the address details using ed25519 address. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressEd25519` | *string* | The address to get the details for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressEd25519` | *string* | The address to get the details for. | **Returns:** *Promise*<[*IAddressResponse*](models_api_iaddressresponse.iaddressresponse.md)\> @@ -85,11 +85,11 @@ Get the address outputs. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressEd25519` | *string* | The address to get the outputs for. | -`type?` | *number* | Filter the type of outputs you are looking up, defaults to all. | -`includeSpent?` | *boolean* | Filter the type of outputs you are looking up, defaults to false. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressEd25519` | *string* | The address to get the outputs for. | +| `type?` | *number* | Filter the type of outputs you are looking up, defaults to all. | +| `includeSpent?` | *boolean* | Filter the type of outputs you are looking up, defaults to false. | **Returns:** *Promise*<[*IAddressOutputsResponse*](models_api_iaddressoutputsresponse.iaddressoutputsresponse.md)\> @@ -105,11 +105,11 @@ Get the address outputs using bech32 address. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressBech32` | *string* | The address to get the outputs for. | -`type?` | *number* | Filter the type of outputs you are looking up, defaults to all. | -`includeSpent?` | *boolean* | Filter the type of outputs you are looking up, defaults to false. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressBech32` | *string* | The address to get the outputs for. | +| `type?` | *number* | Filter the type of outputs you are looking up, defaults to all. | +| `includeSpent?` | *boolean* | Filter the type of outputs you are looking up, defaults to false. | **Returns:** *Promise*<[*IAddressOutputsResponse*](models_api_iaddressoutputsresponse.iaddressoutputsresponse.md)\> @@ -149,9 +149,9 @@ Get the message data by id. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`messageId` | *string* | The message to get the data for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | *string* | The message to get the data for. | **Returns:** *Promise*<[*IMessage*](models_imessage.imessage.md)\> @@ -167,9 +167,9 @@ Get the children of a message. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`messageId` | *string* | The id of the message to get the children for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | *string* | The id of the message to get the children for. | **Returns:** *Promise*<[*IChildrenResponse*](models_api_ichildrenresponse.ichildrenresponse.md)\> @@ -185,9 +185,9 @@ Get the message metadata by id. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`messageId` | *string* | The message to get the metadata for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | *string* | The message to get the metadata for. | **Returns:** *Promise*<[*IMessageMetadata*](models_imessagemetadata.imessagemetadata.md)\> @@ -203,9 +203,9 @@ Get the message raw data by id. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`messageId` | *string* | The message to get the data for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | *string* | The message to get the data for. | **Returns:** *Promise* @@ -221,9 +221,9 @@ Submit message. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | [*IMessage*](models_imessage.imessage.md) | The message to submit. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | [*IMessage*](models_imessage.imessage.md) | The message to submit. | **Returns:** *Promise* @@ -239,9 +239,9 @@ Submit message in raw format. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | *Uint8Array* | The message to submit. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | *Uint8Array* | The message to submit. | **Returns:** *Promise* @@ -257,9 +257,9 @@ Find messages by index. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`indexationKey` | *string* \| *Uint8Array* | The index value as a byte array or UTF8 string. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexationKey` | *string* \| *Uint8Array* | The index value as a byte array or UTF8 string. | **Returns:** *Promise*<[*IMessagesResponse*](models_api_imessagesresponse.imessagesresponse.md)\> @@ -275,9 +275,9 @@ Get the requested milestone. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`index` | *number* | The index of the milestone to get. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | *number* | The index of the milestone to get. | **Returns:** *Promise*<[*IMilestoneResponse*](models_api_imilestoneresponse.imilestoneresponse.md)\> @@ -293,9 +293,9 @@ Get the requested milestone utxo changes. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`index` | *number* | The index of the milestone to request the changes for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | *number* | The index of the milestone to request the changes for. | **Returns:** *Promise*<[*IMilestoneUtxoChangesResponse*](models_api_imilestoneutxochangesresponse.imilestoneutxochangesresponse.md)\> @@ -311,9 +311,9 @@ Find an output by its identifier. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`outputId` | *string* | The id of the output to get. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `outputId` | *string* | The id of the output to get. | **Returns:** *Promise*<[*IOutputResponse*](models_api_ioutputresponse.ioutputresponse.md)\> @@ -329,9 +329,9 @@ Get a peer. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`peerId` | *string* | The peer to delete. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `peerId` | *string* | The peer to delete. | **Returns:** *Promise*<[*IPeer*](models_ipeer.ipeer.md)\> @@ -347,10 +347,10 @@ Add a new peer. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`multiAddress` | *string* | The address of the peer to add. | -`alias?` | *string* | An optional alias for the peer. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `multiAddress` | *string* | The address of the peer to add. | +| `alias?` | *string* | An optional alias for the peer. | **Returns:** *Promise*<[*IPeer*](models_ipeer.ipeer.md)\> @@ -366,9 +366,9 @@ Delete a peer. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`peerId` | *string* | The peer to delete. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `peerId` | *string* | The peer to delete. | **Returns:** *Promise* @@ -396,9 +396,9 @@ Get all the stored receipts or those for a given migrated at index. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`migratedAt?` | *number* | The index the receipts were migrated at, if not supplied returns all stored receipts. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `migratedAt?` | *number* | The index the receipts were migrated at, if not supplied returns all stored receipts. | **Returns:** *Promise*<[*IReceiptsResponse*](models_api_ireceiptsresponse.ireceiptsresponse.md)\> @@ -426,9 +426,9 @@ Get the message that was included in the ledger for a transaction. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`transactionId` | *string* | The id of the transaction to get the included message for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `transactionId` | *string* | The id of the transaction to get the included message for. | **Returns:** *Promise*<[*IMessage*](models_imessage.imessage.md)\> diff --git a/docs/interfaces/models_ied25519address.ied25519address.md b/docs/interfaces/models_ied25519address.ied25519address.md index b56ce4733..ea4cfec31 100644 --- a/docs/interfaces/models_ied25519address.ied25519address.md +++ b/docs/interfaces/models_ied25519address.ied25519address.md @@ -8,7 +8,7 @@ Ed25519Address address. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*0*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``0``\> ↳ **IEd25519Address** @@ -31,7 +31,7 @@ ___ ### type -• **type**: *0* +• **type**: ``0`` The type of the object. diff --git a/docs/interfaces/models_ied25519signature.ied25519signature.md b/docs/interfaces/models_ied25519signature.ied25519signature.md index 7de9edcd6..ffda282d9 100644 --- a/docs/interfaces/models_ied25519signature.ied25519signature.md +++ b/docs/interfaces/models_ied25519signature.ied25519signature.md @@ -8,7 +8,7 @@ Ed25519Signature signature. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*0*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``0``\> ↳ **IEd25519Signature** @@ -40,7 +40,7 @@ ___ ### type -• **type**: *0* +• **type**: ``0`` The type of the object. diff --git a/docs/interfaces/models_iindexationpayload.iindexationpayload.md b/docs/interfaces/models_iindexationpayload.iindexationpayload.md index 78e1b6001..2d84df974 100644 --- a/docs/interfaces/models_iindexationpayload.iindexationpayload.md +++ b/docs/interfaces/models_iindexationpayload.iindexationpayload.md @@ -8,7 +8,7 @@ Indexation payload. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*2*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``2``\> ↳ **IIndexationPayload** @@ -40,7 +40,7 @@ ___ ### type -• **type**: *2* +• **type**: ``2`` The type of the object. diff --git a/docs/interfaces/models_imilestonepayload.imilestonepayload.md b/docs/interfaces/models_imilestonepayload.imilestonepayload.md index 18f788a9f..ca4c9f749 100644 --- a/docs/interfaces/models_imilestonepayload.imilestonepayload.md +++ b/docs/interfaces/models_imilestonepayload.imilestonepayload.md @@ -8,7 +8,7 @@ Milestone payload. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*1*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``1``\> ↳ **IMilestonePayload** @@ -103,7 +103,7 @@ ___ ### type -• **type**: *1* +• **type**: ``1`` The type of the object. diff --git a/docs/interfaces/models_imqttclient.imqttclient.md b/docs/interfaces/models_imqttclient.imqttclient.md index 8e16c126a..4747708a5 100644 --- a/docs/interfaces/models_imqttclient.imqttclient.md +++ b/docs/interfaces/models_imqttclient.imqttclient.md @@ -42,10 +42,10 @@ Subscribe to the ed25519 address for output updates. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressEd25519` | *string* | The address to monitor. | -`callback` | (`topic`: *string*, `data`: [*IOutputResponse*](models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressEd25519` | *string* | The address to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IOutputResponse*](models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -61,10 +61,10 @@ Subscribe to the address for output updates. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`addressBech32` | *string* | The address to monitor. | -`callback` | (`topic`: *string*, `data`: [*IOutputResponse*](models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `addressBech32` | *string* | The address to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IOutputResponse*](models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -80,10 +80,10 @@ Subscribe to get all messages for the specified index in object form. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`index` | *string* \| *Uint8Array* | The index to monitor as bytes or in UTF8. | -`callback` | (`topic`: *string*, `data`: [*IMessage*](models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | *string* \| *Uint8Array* | The index to monitor as bytes or in UTF8. | +| `callback` | (`topic`: *string*, `data`: [*IMessage*](models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -99,10 +99,10 @@ Subscribe to get all messages for the specified index in binary form. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`index` | *string* \| *Uint8Array* | The index to monitor as bytes or in UTF8. | -`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `index` | *string* \| *Uint8Array* | The index to monitor as bytes or in UTF8. | +| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -118,10 +118,10 @@ Subscribe to metadata updates for a specific message. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`messageId` | *string* | The message to monitor. | -`callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `messageId` | *string* | The message to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -137,9 +137,9 @@ Subscribe to get all messages in object form. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`topic`: *string*, `data`: [*IMessage*](models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`topic`: *string*, `data`: [*IMessage*](models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -155,9 +155,9 @@ Subscribe to get the metadata for all the messages. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`topic`: *string*, `data`: [*IMessageMetadata*](models_imessagemetadata.imessagemetadata.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -173,9 +173,9 @@ Subscribe to get all messages in binary form. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -191,9 +191,9 @@ Subscribe to the latest confirmed milestone updates. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -209,9 +209,9 @@ Subscribe to the latest milestone updates. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`topic`: *string*, `data`: [*IMqttMilestoneResponse*](models_api_imqttmilestoneresponse.imqttmilestoneresponse.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -227,10 +227,10 @@ Subscribe to updates for a specific output. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`outputId` | *string* | The output to monitor. | -`callback` | (`topic`: *string*, `data`: [*IOutputResponse*](models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `outputId` | *string* | The output to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IOutputResponse*](models_api_ioutputresponse.ioutputresponse.md)) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -246,9 +246,9 @@ Subscribe to changes in the client state. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`callback` | (`status`: [*IMqttStatus*](models_imqttstatus.imqttstatus.md)) => *void* | Callback called when the state has changed. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `callback` | (`status`: [*IMqttStatus*](models_imqttstatus.imqttstatus.md)) => *void* | Callback called when the state has changed. | **Returns:** *string* @@ -264,16 +264,16 @@ Subscribe to another type of message as json. #### Type parameters: -Name | -:------ | -`T` | +| Name | +| :------ | +| `T` | #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`customTopic` | *string* | The topic to subscribe to. | -`callback` | (`topic`: *string*, `data`: T) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `customTopic` | *string* | The topic to subscribe to. | +| `callback` | (`topic`: *string*, `data`: T) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -289,10 +289,10 @@ Subscribe to another type of message as raw data. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`customTopic` | *string* | The topic to subscribe to. | -`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `customTopic` | *string* | The topic to subscribe to. | +| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -308,10 +308,10 @@ Subscribe to message updates for a specific transactionId. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`transactionId` | *string* | The message to monitor. | -`callback` | (`topic`: *string*, `data`: [*IMessage*](models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `transactionId` | *string* | The message to monitor. | +| `callback` | (`topic`: *string*, `data`: [*IMessage*](models_imessage.imessage.md), `raw`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -327,10 +327,10 @@ Subscribe to message updates for a specific transactionId. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`transactionId` | *string* | The message to monitor. | -`callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `transactionId` | *string* | The message to monitor. | +| `callback` | (`topic`: *string*, `data`: *Uint8Array*) => *void* | The callback which is called when new data arrives. | **Returns:** *string* @@ -346,8 +346,8 @@ Remove a subscription. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`subscriptionId` | *string* | The subscription to remove. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `subscriptionId` | *string* | The subscription to remove. | **Returns:** *void* diff --git a/docs/interfaces/models_imqttstatus.imqttstatus.md b/docs/interfaces/models_imqttstatus.imqttstatus.md index ae5e6ae94..55b8d042a 100644 --- a/docs/interfaces/models_imqttstatus.imqttstatus.md +++ b/docs/interfaces/models_imqttstatus.imqttstatus.md @@ -35,7 +35,7 @@ ___ ### state -• **state**: *disconnected* \| *connected* \| *disconnecting* \| *connecting* +• **state**: ``"disconnected"`` \| ``"connected"`` \| ``"disconnecting"`` \| ``"connecting"`` The connection status. @@ -43,6 +43,6 @@ ___ ### type -• **type**: *connect* \| *disconnect* \| *error* \| *subscription-add* \| *subscription-remove* +• **type**: ``"connect"`` \| ``"disconnect"`` \| ``"error"`` \| ``"subscription-add"`` \| ``"subscription-remove"`` The type of message. diff --git a/docs/interfaces/models_ipeer.ipeer.md b/docs/interfaces/models_ipeer.ipeer.md index caf9b5515..1fbc97686 100644 --- a/docs/interfaces/models_ipeer.ipeer.md +++ b/docs/interfaces/models_ipeer.ipeer.md @@ -43,10 +43,10 @@ Gossip metrics for the peer. #### Type declaration: -Name | Type | Description | -:------ | :------ | :------ | -`heartbeat`? | [*IGossipHeartbeat*](models_igossipheartbeat.igossipheartbeat.md) | The peer heartbeat. | -`metrics` | [*IGossipMetrics*](models_igossipmetrics.igossipmetrics.md) | The peer metrics. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `heartbeat?` | [*IGossipHeartbeat*](models_igossipheartbeat.igossipheartbeat.md) | The peer heartbeat. | +| `metrics` | [*IGossipMetrics*](models_igossipmetrics.igossipmetrics.md) | The peer metrics. | ___ diff --git a/docs/interfaces/models_ipowprovider.ipowprovider.md b/docs/interfaces/models_ipowprovider.ipowprovider.md index 635d1f316..22879f82c 100644 --- a/docs/interfaces/models_ipowprovider.ipowprovider.md +++ b/docs/interfaces/models_ipowprovider.ipowprovider.md @@ -26,10 +26,10 @@ Perform pow on the message and return the nonce of at least targetScore. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`message` | *Uint8Array* | The message to process. | -`targetScore` | *number* | the target score. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `message` | *Uint8Array* | The message to process. | +| `targetScore` | *number* | the target score. | **Returns:** *Promise* diff --git a/docs/interfaces/models_ireceiptpayload.ireceiptpayload.md b/docs/interfaces/models_ireceiptpayload.ireceiptpayload.md index 9a7bbc3bc..ec62de498 100644 --- a/docs/interfaces/models_ireceiptpayload.ireceiptpayload.md +++ b/docs/interfaces/models_ireceiptpayload.ireceiptpayload.md @@ -8,7 +8,7 @@ Receipt payload. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*3*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``3``\> ↳ **IReceiptPayload** @@ -58,7 +58,7 @@ ___ ### type -• **type**: *3* +• **type**: ``3`` The type of the object. diff --git a/docs/interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md b/docs/interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md index a857bb8c5..0d6e19efa 100644 --- a/docs/interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md +++ b/docs/interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md @@ -8,7 +8,7 @@ Reference unlock block. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*1*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``1``\> ↳ **IReferenceUnlockBlock** @@ -31,7 +31,7 @@ ___ ### type -• **type**: *1* +• **type**: ``1`` The type of the object. diff --git a/docs/interfaces/models_iseed.iseed.md b/docs/interfaces/models_iseed.iseed.md index 11188ffb3..f164dc49c 100644 --- a/docs/interfaces/models_iseed.iseed.md +++ b/docs/interfaces/models_iseed.iseed.md @@ -29,9 +29,9 @@ Generate a new seed from the path. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`path` | [*Bip32Path*](../classes/crypto_bip32path.bip32path.md) | The path to generate the seed for. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `path` | [*Bip32Path*](../classes/crypto_bip32path.bip32path.md) | The path to generate the seed for. | **Returns:** [*ISeed*](models_iseed.iseed.md) diff --git a/docs/interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md b/docs/interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md index 6eb9a2eba..7b1123914 100644 --- a/docs/interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md +++ b/docs/interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md @@ -8,7 +8,7 @@ Signature locked single output. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*1*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``1``\> ↳ **ISigLockedDustAllowanceOutput** @@ -40,7 +40,7 @@ ___ ### type -• **type**: *1* +• **type**: ``1`` The type of the object. diff --git a/docs/interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md b/docs/interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md index cc2a5aa64..76dedc0bf 100644 --- a/docs/interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md +++ b/docs/interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md @@ -8,7 +8,7 @@ Signature locked single output. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*0*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``0``\> ↳ **ISigLockedSingleOutput** @@ -40,7 +40,7 @@ ___ ### type -• **type**: *0* +• **type**: ``0`` The type of the object. diff --git a/docs/interfaces/models_isignatureunlockblock.isignatureunlockblock.md b/docs/interfaces/models_isignatureunlockblock.isignatureunlockblock.md index 015d74791..ed1b22e46 100644 --- a/docs/interfaces/models_isignatureunlockblock.isignatureunlockblock.md +++ b/docs/interfaces/models_isignatureunlockblock.isignatureunlockblock.md @@ -8,7 +8,7 @@ Signature unlock block. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*0*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``0``\> ↳ **ISignatureUnlockBlock** @@ -31,7 +31,7 @@ ___ ### type -• **type**: *0* +• **type**: ``0`` The type of the object. diff --git a/docs/interfaces/models_itransactionessence.itransactionessence.md b/docs/interfaces/models_itransactionessence.itransactionessence.md index e5bbadb8f..ef874104e 100644 --- a/docs/interfaces/models_itransactionessence.itransactionessence.md +++ b/docs/interfaces/models_itransactionessence.itransactionessence.md @@ -8,7 +8,7 @@ Transaction payload. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*0*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``0``\> ↳ **ITransactionEssence** @@ -49,7 +49,7 @@ ___ ### type -• **type**: *0* +• **type**: ``0`` The type of the object. diff --git a/docs/interfaces/models_itransactionpayload.itransactionpayload.md b/docs/interfaces/models_itransactionpayload.itransactionpayload.md index f234fe185..f649d1d8e 100644 --- a/docs/interfaces/models_itransactionpayload.itransactionpayload.md +++ b/docs/interfaces/models_itransactionpayload.itransactionpayload.md @@ -8,7 +8,7 @@ Transaction payload. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*0*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``0``\> ↳ **ITransactionPayload** @@ -32,7 +32,7 @@ ___ ### type -• **type**: *0* +• **type**: ``0`` The type of the object. diff --git a/docs/interfaces/models_itreasuryinput.itreasuryinput.md b/docs/interfaces/models_itreasuryinput.itreasuryinput.md index 532097e76..e3b8f9c4e 100644 --- a/docs/interfaces/models_itreasuryinput.itreasuryinput.md +++ b/docs/interfaces/models_itreasuryinput.itreasuryinput.md @@ -8,7 +8,7 @@ Treasury Input. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*1*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``1``\> ↳ **ITreasuryInput** @@ -31,7 +31,7 @@ ___ ### type -• **type**: *1* +• **type**: ``1`` The type of the object. diff --git a/docs/interfaces/models_itreasuryoutput.itreasuryoutput.md b/docs/interfaces/models_itreasuryoutput.itreasuryoutput.md index d19c7849b..37ac3c74d 100644 --- a/docs/interfaces/models_itreasuryoutput.itreasuryoutput.md +++ b/docs/interfaces/models_itreasuryoutput.itreasuryoutput.md @@ -8,7 +8,7 @@ Treasury Output. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*2*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``2``\> ↳ **ITreasuryOutput** @@ -31,7 +31,7 @@ ___ ### type -• **type**: *2* +• **type**: ``2`` The type of the object. diff --git a/docs/interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md b/docs/interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md index d199ff95b..c24e8856f 100644 --- a/docs/interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md +++ b/docs/interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md @@ -8,7 +8,7 @@ Receipt payload. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*4*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``4``\> ↳ **ITreasuryTransactionPayload** @@ -40,7 +40,7 @@ ___ ### type -• **type**: *4* +• **type**: ``4`` The type of the object. diff --git a/docs/interfaces/models_itypebase.itypebase.md b/docs/interfaces/models_itypebase.itypebase.md index 35cdb6ad2..8c4a89728 100644 --- a/docs/interfaces/models_itypebase.itypebase.md +++ b/docs/interfaces/models_itypebase.itypebase.md @@ -8,9 +8,9 @@ Type of the object. ## Type parameters -Name | -:------ | -`T` | +| Name | +| :------ | +| `T` | ## Hierarchy diff --git a/docs/interfaces/models_iutxoinput.iutxoinput.md b/docs/interfaces/models_iutxoinput.iutxoinput.md index 974fd5f0b..8ea65df53 100644 --- a/docs/interfaces/models_iutxoinput.iutxoinput.md +++ b/docs/interfaces/models_iutxoinput.iutxoinput.md @@ -8,7 +8,7 @@ UTXO Transaction Input. ## Hierarchy -* [*ITypeBase*](models_itypebase.itypebase.md)<*0*\> +* [*ITypeBase*](models_itypebase.itypebase.md)<``0``\> ↳ **IUTXOInput** @@ -40,7 +40,7 @@ ___ ### type -• **type**: *0* +• **type**: ``0`` The type of the object. diff --git a/docs/modules/binary_address.md b/docs/modules/binary_address.md index 2d2d2ea58..fcf839612 100644 --- a/docs/modules/binary_address.md +++ b/docs/modules/binary_address.md @@ -42,9 +42,9 @@ Deserialize the address from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IEd25519Address*](../interfaces/models_ied25519address.ied25519address.md) @@ -60,9 +60,9 @@ Deserialize the Ed25519 address from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IEd25519Address*](../interfaces/models_ied25519address.ied25519address.md) @@ -78,10 +78,10 @@ Serialize the address to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IEd25519Address*](../interfaces/models_ied25519address.ied25519address.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IEd25519Address*](../interfaces/models_ied25519address.ied25519address.md) | The object to serialize. | **Returns:** *void* @@ -95,9 +95,9 @@ Serialize the ed25519 address to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IEd25519Address*](../interfaces/models_ied25519address.ied25519address.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IEd25519Address*](../interfaces/models_ied25519address.ied25519address.md) | The object to serialize. | **Returns:** *void* diff --git a/docs/modules/binary_funds.md b/docs/modules/binary_funds.md index e56801354..f49f6e971 100644 --- a/docs/modules/binary_funds.md +++ b/docs/modules/binary_funds.md @@ -51,9 +51,9 @@ Deserialize the receipt payload funds from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IMigratedFunds*](../interfaces/models_imigratedfunds.imigratedfunds.md)[] @@ -69,9 +69,9 @@ Deserialize the migrated fund from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IMigratedFunds*](../interfaces/models_imigratedfunds.imigratedfunds.md) @@ -87,10 +87,10 @@ Serialize the receipt payload funds to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`objects` | [*IMigratedFunds*](../interfaces/models_imigratedfunds.imigratedfunds.md)[] | The objects to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `objects` | [*IMigratedFunds*](../interfaces/models_imigratedfunds.imigratedfunds.md)[] | The objects to serialize. | **Returns:** *void* @@ -104,9 +104,9 @@ Serialize the migrated funds to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IMigratedFunds*](../interfaces/models_imigratedfunds.imigratedfunds.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IMigratedFunds*](../interfaces/models_imigratedfunds.imigratedfunds.md) | The object to serialize. | **Returns:** *void* diff --git a/docs/modules/binary_input.md b/docs/modules/binary_input.md index a73e349f2..480b67560 100644 --- a/docs/modules/binary_input.md +++ b/docs/modules/binary_input.md @@ -73,9 +73,9 @@ Deserialize the input from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) \| [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md) @@ -91,9 +91,9 @@ Deserialize the inputs from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** ([*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) \| [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md))[] @@ -109,9 +109,9 @@ Deserialize the treasury input from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md) @@ -127,9 +127,9 @@ Deserialize the utxo input from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) @@ -145,10 +145,10 @@ Serialize the input to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) \| [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) \| [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md) | The object to serialize. | **Returns:** *void* @@ -162,10 +162,10 @@ Serialize the inputs to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`objects` | ([*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) \| [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md))[] | The objects to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `objects` | ([*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) \| [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md))[] | The objects to serialize. | **Returns:** *void* @@ -179,10 +179,10 @@ Serialize the treasury input to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md) | The object to serialize. | **Returns:** *void* @@ -196,9 +196,9 @@ Serialize the utxo input to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) | The object to serialize. | **Returns:** *void* diff --git a/docs/modules/binary_message.md b/docs/modules/binary_message.md index 896fce7bc..19ffa0a64 100644 --- a/docs/modules/binary_message.md +++ b/docs/modules/binary_message.md @@ -49,9 +49,9 @@ Deserialize the message from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The message to deserialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The message to deserialize. | **Returns:** [*IMessage*](../interfaces/models_imessage.imessage.md) @@ -67,9 +67,9 @@ Serialize the message essence to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IMessage*](../interfaces/models_imessage.imessage.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IMessage*](../interfaces/models_imessage.imessage.md) | The object to serialize. | **Returns:** *void* diff --git a/docs/modules/binary_output.md b/docs/modules/binary_output.md index 404fd98fc..70d8586d9 100644 --- a/docs/modules/binary_output.md +++ b/docs/modules/binary_output.md @@ -84,9 +84,9 @@ Deserialize the output from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ISigLockedSingleOutput*](../interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md) \| [*ISigLockedDustAllowanceOutput*](../interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md) \| [*ITreasuryOutput*](../interfaces/models_itreasuryoutput.itreasuryoutput.md) @@ -102,9 +102,9 @@ Deserialize the outputs from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** ([*ISigLockedSingleOutput*](../interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md) \| [*ISigLockedDustAllowanceOutput*](../interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md) \| [*ITreasuryOutput*](../interfaces/models_itreasuryoutput.itreasuryoutput.md))[] @@ -120,9 +120,9 @@ Deserialize the signature locked dust allowance output from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ISigLockedDustAllowanceOutput*](../interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md) @@ -138,9 +138,9 @@ Deserialize the signature locked single output from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ISigLockedSingleOutput*](../interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md) @@ -156,9 +156,9 @@ Deserialize the treasury output from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ITreasuryOutput*](../interfaces/models_itreasuryoutput.itreasuryoutput.md) @@ -174,10 +174,10 @@ Serialize the output to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ITypeBase*](../interfaces/models_itypebase.itypebase.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ITypeBase*](../interfaces/models_itypebase.itypebase.md) | The object to serialize. | **Returns:** *void* @@ -191,10 +191,10 @@ Serialize the outputs to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`objects` | ([*ISigLockedSingleOutput*](../interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md) \| [*ISigLockedDustAllowanceOutput*](../interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md) \| [*ITreasuryOutput*](../interfaces/models_itreasuryoutput.itreasuryoutput.md))[] | The objects to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `objects` | ([*ISigLockedSingleOutput*](../interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md) \| [*ISigLockedDustAllowanceOutput*](../interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md) \| [*ITreasuryOutput*](../interfaces/models_itreasuryoutput.itreasuryoutput.md))[] | The objects to serialize. | **Returns:** *void* @@ -208,10 +208,10 @@ Serialize the signature locked dust allowance output to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ISigLockedDustAllowanceOutput*](../interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ISigLockedDustAllowanceOutput*](../interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md) | The object to serialize. | **Returns:** *void* @@ -225,10 +225,10 @@ Serialize the signature locked single output to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ISigLockedSingleOutput*](../interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ISigLockedSingleOutput*](../interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md) | The object to serialize. | **Returns:** *void* @@ -242,9 +242,9 @@ Serialize the treasury output to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ITreasuryOutput*](../interfaces/models_itreasuryoutput.itreasuryoutput.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ITreasuryOutput*](../interfaces/models_itreasuryoutput.itreasuryoutput.md) | The object to serialize. | **Returns:** *void* diff --git a/docs/modules/binary_payload.md b/docs/modules/binary_payload.md index 74ca27339..59231640e 100644 --- a/docs/modules/binary_payload.md +++ b/docs/modules/binary_payload.md @@ -104,9 +104,9 @@ Deserialize the indexation payload from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IIndexationPayload*](../interfaces/models_iindexationpayload.iindexationpayload.md) @@ -122,9 +122,9 @@ Deserialize the milestone payload from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IMilestonePayload*](../interfaces/models_imilestonepayload.imilestonepayload.md) @@ -140,9 +140,9 @@ Deserialize the payload from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) \| [*IMilestonePayload*](../interfaces/models_imilestonepayload.imilestonepayload.md) \| [*IIndexationPayload*](../interfaces/models_iindexationpayload.iindexationpayload.md) \| [*ITreasuryTransactionPayload*](../interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md) \| [*IReceiptPayload*](../interfaces/models_ireceiptpayload.ireceiptpayload.md) \| *undefined* @@ -158,9 +158,9 @@ Deserialize the receipt payload from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IReceiptPayload*](../interfaces/models_ireceiptpayload.ireceiptpayload.md) @@ -176,9 +176,9 @@ Deserialize the transaction payload from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) @@ -194,9 +194,9 @@ Deserialize the treasury transaction payload from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ITreasuryTransactionPayload*](../interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md) @@ -212,10 +212,10 @@ Serialize the indexation payload to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IIndexationPayload*](../interfaces/models_iindexationpayload.iindexationpayload.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IIndexationPayload*](../interfaces/models_iindexationpayload.iindexationpayload.md) | The object to serialize. | **Returns:** *void* @@ -229,10 +229,10 @@ Serialize the milestone payload to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IMilestonePayload*](../interfaces/models_imilestonepayload.imilestonepayload.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IMilestonePayload*](../interfaces/models_imilestonepayload.imilestonepayload.md) | The object to serialize. | **Returns:** *void* @@ -246,10 +246,10 @@ Serialize the payload essence to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) \| [*IMilestonePayload*](../interfaces/models_imilestonepayload.imilestonepayload.md) \| [*IIndexationPayload*](../interfaces/models_iindexationpayload.iindexationpayload.md) \| [*ITreasuryTransactionPayload*](../interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md) \| [*IReceiptPayload*](../interfaces/models_ireceiptpayload.ireceiptpayload.md) \| *undefined* | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) \| [*IMilestonePayload*](../interfaces/models_imilestonepayload.imilestonepayload.md) \| [*IIndexationPayload*](../interfaces/models_iindexationpayload.iindexationpayload.md) \| [*ITreasuryTransactionPayload*](../interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md) \| [*IReceiptPayload*](../interfaces/models_ireceiptpayload.ireceiptpayload.md) \| *undefined* | The object to serialize. | **Returns:** *void* @@ -263,10 +263,10 @@ Serialize the receipt payload to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IReceiptPayload*](../interfaces/models_ireceiptpayload.ireceiptpayload.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IReceiptPayload*](../interfaces/models_ireceiptpayload.ireceiptpayload.md) | The object to serialize. | **Returns:** *void* @@ -280,10 +280,10 @@ Serialize the transaction payload to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) | The object to serialize. | **Returns:** *void* @@ -297,9 +297,9 @@ Serialize the treasury transaction payload to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ITreasuryTransactionPayload*](../interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ITreasuryTransactionPayload*](../interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md) | The object to serialize. | **Returns:** *void* diff --git a/docs/modules/binary_signature.md b/docs/modules/binary_signature.md index 45ff7136c..0fc83a020 100644 --- a/docs/modules/binary_signature.md +++ b/docs/modules/binary_signature.md @@ -42,9 +42,9 @@ Deserialize the Ed25519 signature from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IEd25519Signature*](../interfaces/models_ied25519signature.ied25519signature.md) @@ -60,9 +60,9 @@ Deserialize the signature from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IEd25519Signature*](../interfaces/models_ied25519signature.ied25519signature.md) @@ -78,10 +78,10 @@ Serialize the Ed25519 signature to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IEd25519Signature*](../interfaces/models_ied25519signature.ied25519signature.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IEd25519Signature*](../interfaces/models_ied25519signature.ied25519signature.md) | The object to serialize. | **Returns:** *void* @@ -95,9 +95,9 @@ Serialize the signature to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IEd25519Signature*](../interfaces/models_ied25519signature.ied25519signature.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IEd25519Signature*](../interfaces/models_ied25519signature.ied25519signature.md) | The object to serialize. | **Returns:** *void* diff --git a/docs/modules/binary_transaction.md b/docs/modules/binary_transaction.md index 8bd12601c..d5acde702 100644 --- a/docs/modules/binary_transaction.md +++ b/docs/modules/binary_transaction.md @@ -31,9 +31,9 @@ Deserialize the transaction essence from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ITransactionEssence*](../interfaces/models_itransactionessence.itransactionessence.md) @@ -49,9 +49,9 @@ Serialize the transaction essence to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ITransactionEssence*](../interfaces/models_itransactionessence.itransactionessence.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ITransactionEssence*](../interfaces/models_itransactionessence.itransactionessence.md) | The object to serialize. | **Returns:** *void* diff --git a/docs/modules/binary_unlockblock.md b/docs/modules/binary_unlockblock.md index bfa9ac317..7de0c72d6 100644 --- a/docs/modules/binary_unlockblock.md +++ b/docs/modules/binary_unlockblock.md @@ -55,9 +55,9 @@ Deserialize the reference unlock block from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md) @@ -73,9 +73,9 @@ Deserialize the signature unlock block from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) @@ -91,9 +91,9 @@ Deserialize the unlock block from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** [*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) \| [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md) @@ -109,9 +109,9 @@ Deserialize the unlock blocks from binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `readStream` | [*ReadStream*](../classes/utils_readstream.readstream.md) | The stream to read the data from. | **Returns:** ([*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) \| [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md))[] @@ -127,10 +127,10 @@ Serialize the reference unlock block to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md) | The object to serialize. | **Returns:** *void* @@ -144,10 +144,10 @@ Serialize the signature unlock block to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) | The object to serialize. | **Returns:** *void* @@ -161,10 +161,10 @@ Serialize the unlock block to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`object` | [*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) \| [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md) | The object to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `object` | [*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) \| [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md) | The object to serialize. | **Returns:** *void* @@ -178,9 +178,9 @@ Serialize the unlock blocks to binary. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | -`objects` | ([*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) \| [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md))[] | The objects to serialize. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `writeStream` | [*WriteStream*](../classes/utils_writestream.writestream.md) | The stream to write the data to. | +| `objects` | ([*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) \| [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md))[] | The objects to serialize. | **Returns:** *void* diff --git a/docs/modules/crypto_edwards25519_scalar.md b/docs/modules/crypto_edwards25519_scalar.md index 64166e715..c25929013 100644 --- a/docs/modules/crypto_edwards25519_scalar.md +++ b/docs/modules/crypto_edwards25519_scalar.md @@ -20,9 +20,9 @@ Scalar Minimal returns true if the given scalar is less than the order of the Cu #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`scalar` | Uint8Array | The scalar. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `scalar` | Uint8Array | The scalar. | **Returns:** *boolean* @@ -47,12 +47,12 @@ Output: #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`s` | Uint8Array | The scalar. | -`a` | Uint8Array | The a. | -`b` | Uint8Array | The b. | -`c` | Uint8Array | The c. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `s` | Uint8Array | The scalar. | +| `a` | Uint8Array | The a. | +| `b` | Uint8Array | The b. | +| `c` | Uint8Array | The c. | **Returns:** *void* @@ -67,9 +67,9 @@ where l = 2^252 + 27742317777372353535851937790883648493. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`out` | Uint8Array | s[0]+256*s[1]+...+256^31*s[31] = s mod l | -`s` | Uint8Array | s[0]+256*s[1]+...+256^63*s[63] = s | +| Name | Type | Description | +| :------ | :------ | :------ | +| `out` | Uint8Array | s[0]+256*s[1]+...+256^31*s[31] = s mod l | +| `s` | Uint8Array | s[0]+256*s[1]+...+256^63*s[63] = s | **Returns:** *void* diff --git a/docs/modules/highlevel_addresses.md b/docs/modules/highlevel_addresses.md index f7588a0e7..79587dc11 100644 --- a/docs/modules/highlevel_addresses.md +++ b/docs/modules/highlevel_addresses.md @@ -19,10 +19,10 @@ Generate addresses based on the account indexing style. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`generatorState` | [*IBip44GeneratorState*](../interfaces/models_ibip44generatorstate.ibip44generatorstate.md) | The address state. | -`isFirst` | *boolean* | Is this the first address we are generating. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `generatorState` | [*IBip44GeneratorState*](../interfaces/models_ibip44generatorstate.ibip44generatorstate.md) | The address state. | +| `isFirst` | *boolean* | Is this the first address we are generating. | **Returns:** *string* @@ -38,11 +38,11 @@ Generate a bip44 path based on all its parts. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`accountIndex` | *number* | The account index. | -`addressIndex` | *number* | The address index. | -`isInternal` | *boolean* | Is this an internal address. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `accountIndex` | *number* | The account index. | +| `addressIndex` | *number* | The address index. | +| `isInternal` | *boolean* | Is this an internal address. | **Returns:** [*Bip32Path*](../classes/crypto_bip32path.bip32path.md) diff --git a/docs/modules/highlevel_getbalance.md b/docs/modules/highlevel_getbalance.md index a7616c2b3..dc89195f7 100644 --- a/docs/modules/highlevel_getbalance.md +++ b/docs/modules/highlevel_getbalance.md @@ -18,12 +18,12 @@ Get the balance for a list of addresses. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | -`seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed. | -`accountIndex` | *number* | The account index in the wallet. | -`addressOptions?` | *object* | Optional address configuration for balance address lookups. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | +| `seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed. | +| `accountIndex` | *number* | The account index in the wallet. | +| `addressOptions?` | *object* | Optional address configuration for balance address lookups. | **Returns:** *Promise* diff --git a/docs/modules/highlevel_getunspentaddress.md b/docs/modules/highlevel_getunspentaddress.md index 91de5306f..7ac7ec60d 100644 --- a/docs/modules/highlevel_getunspentaddress.md +++ b/docs/modules/highlevel_getunspentaddress.md @@ -18,12 +18,12 @@ Get the first unspent address. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | -`seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | -`accountIndex` | *number* | The account index in the wallet. | -`addressOptions?` | *object* | Optional address configuration for balance address lookups. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | +| `seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | +| `accountIndex` | *number* | The account index in the wallet. | +| `addressOptions?` | *object* | Optional address configuration for balance address lookups. | **Returns:** *Promise*<{} \| undefined\> diff --git a/docs/modules/highlevel_getunspentaddresses.md b/docs/modules/highlevel_getunspentaddresses.md index d3435a1d1..b55eb0b85 100644 --- a/docs/modules/highlevel_getunspentaddresses.md +++ b/docs/modules/highlevel_getunspentaddresses.md @@ -19,12 +19,12 @@ Get all the unspent addresses. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | -`seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | -`accountIndex` | *number* | The account index in the wallet. | -`addressOptions?` | *object* | Optional address configuration for balance address lookups. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | +| `seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | +| `accountIndex` | *number* | The account index in the wallet. | +| `addressOptions?` | *object* | Optional address configuration for balance address lookups. | **Returns:** *Promise*<{}[]\> @@ -40,19 +40,19 @@ Get all the unspent addresses using an address generator. #### Type parameters: -Name | -:------ | -`T` | +| Name | +| :------ | +| `T` | #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to get the addresses from. | -`seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | -`initialAddressState` | T | The initial address state for calculating the addresses. | -`nextAddressPath` | (`addressState`: T, `isFirst`: *boolean*) => *string* | Calculate the next address for inputs. | -`addressOptions?` | *object* | Optional address configuration for balance address lookups. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to get the addresses from. | +| `seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | +| `initialAddressState` | T | The initial address state for calculating the addresses. | +| `nextAddressPath` | (`addressState`: T, `isFirst`: *boolean*) => *string* | Calculate the next address for inputs. | +| `addressOptions?` | *object* | Optional address configuration for balance address lookups. | **Returns:** *Promise*<{}[]\> diff --git a/docs/modules/highlevel_promote.md b/docs/modules/highlevel_promote.md index fa3d690cb..09a5d915a 100644 --- a/docs/modules/highlevel_promote.md +++ b/docs/modules/highlevel_promote.md @@ -18,10 +18,10 @@ Promote an existing message. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The clientor node endpoint to perform the promote with. | -`messageId` | *string* | The message to promote. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The clientor node endpoint to perform the promote with. | +| `messageId` | *string* | The message to promote. | **Returns:** *Promise*<{}\> diff --git a/docs/modules/highlevel_reattach.md b/docs/modules/highlevel_reattach.md index 482f256d1..100930341 100644 --- a/docs/modules/highlevel_reattach.md +++ b/docs/modules/highlevel_reattach.md @@ -18,10 +18,10 @@ Reattach an existing message. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to perform the reattach with. | -`messageId` | *string* | The message to reattach. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to perform the reattach with. | +| `messageId` | *string* | The message to reattach. | **Returns:** *Promise*<{}\> diff --git a/docs/modules/highlevel_retrievedata.md b/docs/modules/highlevel_retrievedata.md index bfce79e33..c47f3d6df 100644 --- a/docs/modules/highlevel_retrievedata.md +++ b/docs/modules/highlevel_retrievedata.md @@ -18,10 +18,10 @@ Retrieve a data message. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to retrieve the data with. | -`messageId` | *string* | The message id of the data to get. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to retrieve the data with. | +| `messageId` | *string* | The message id of the data to get. | **Returns:** *Promise*<{} \| undefined\> diff --git a/docs/modules/highlevel_retry.md b/docs/modules/highlevel_retry.md index 4bcdfc566..682fd11ee 100644 --- a/docs/modules/highlevel_retry.md +++ b/docs/modules/highlevel_retry.md @@ -18,10 +18,10 @@ Retry an existing message either by promoting or reattaching. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to perform the retry with. | -`messageId` | *string* | The message to retry. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to perform the retry with. | +| `messageId` | *string* | The message to retry. | **Returns:** *Promise*<{}\> diff --git a/docs/modules/highlevel_send.md b/docs/modules/highlevel_send.md index 916f8f519..6cdcb2a8d 100644 --- a/docs/modules/highlevel_send.md +++ b/docs/modules/highlevel_send.md @@ -23,20 +23,20 @@ Calculate the inputs from the seed and basePath. #### Type parameters: -Name | -:------ | -`T` | +| Name | +| :------ | +| `T` | #### Parameters: -Name | Type | Default value | Description | -:------ | :------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | - | The client or node endpoint to calculate the inputs with. | -`seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | - | The seed to use for address generation. | -`initialAddressState` | T | - | The initial address state for calculating the addresses. | -`nextAddressPath` | (`addressState`: T, `isFirst`: *boolean*) => *string* | - | Calculate the next address for inputs. | -`outputs` | {}[] | - | The outputs to send. | -`zeroCount` | *number* | 5 | Abort when the number of zero balances is exceeded. | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | - | The client or node endpoint to calculate the inputs with. | +| `seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | - | The seed to use for address generation. | +| `initialAddressState` | T | - | The initial address state for calculating the addresses. | +| `nextAddressPath` | (`addressState`: T, `isFirst`: *boolean*) => *string* | - | Calculate the next address for inputs. | +| `outputs` | {}[] | - | The outputs to send. | +| `zeroCount` | *number* | 5 | Abort when the number of zero balances is exceeded. | **Returns:** *Promise*<{}[]\> @@ -52,15 +52,15 @@ Send a transfer from the balance on the seed to a single output. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | -`seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | -`accountIndex` | *number* | The account index in the wallet. | -`addressBech32` | *string* | The address to send the funds to in bech32 format. | -`amount` | *number* | The amount to send. | -`indexation?` | *object* | Optional indexation data to associate with the transaction. | -`addressOptions?` | *object* | Optional address configuration for balance address lookups. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | +| `seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | +| `accountIndex` | *number* | The account index in the wallet. | +| `addressBech32` | *string* | The address to send the funds to in bech32 format. | +| `amount` | *number* | The amount to send. | +| `indexation?` | *object* | Optional indexation data to associate with the transaction. | +| `addressOptions?` | *object* | Optional address configuration for balance address lookups. | **Returns:** *Promise*<{}\> @@ -76,15 +76,15 @@ Send a transfer from the balance on the seed to a single output. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | -`seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | -`accountIndex` | *number* | The account index in the wallet. | -`addressEd25519` | *string* | The address to send the funds to in ed25519 format. | -`amount` | *number* | The amount to send. | -`indexation?` | *object* | Optional indexation data to associate with the transaction. | -`addressOptions?` | *object* | Optional address configuration for balance address lookups. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | +| `seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | +| `accountIndex` | *number* | The account index in the wallet. | +| `addressEd25519` | *string* | The address to send the funds to in ed25519 format. | +| `amount` | *number* | The amount to send. | +| `indexation?` | *object* | Optional indexation data to associate with the transaction. | +| `addressOptions?` | *object* | Optional address configuration for balance address lookups. | **Returns:** *Promise*<{}\> @@ -100,14 +100,14 @@ Send a transfer from the balance on the seed to multiple outputs. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | -`seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | -`accountIndex` | *number* | The account index in the wallet. | -`outputs` | {}[] | The address to send the funds to in bech32 format and amounts. | -`indexation?` | *object* | Optional indexation data to associate with the transaction. | -`addressOptions?` | *object* | Optional address configuration for balance address lookups. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | +| `seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | +| `accountIndex` | *number* | The account index in the wallet. | +| `outputs` | {}[] | The address to send the funds to in bech32 format and amounts. | +| `indexation?` | *object* | Optional indexation data to associate with the transaction. | +| `addressOptions?` | *object* | Optional address configuration for balance address lookups. | **Returns:** *Promise*<{}\> @@ -123,14 +123,14 @@ Send a transfer from the balance on the seed. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | -`seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | -`accountIndex` | *number* | The account index in the wallet. | -`outputs` | {}[] | The outputs including address to send the funds to in ed25519 format and amount. | -`indexation?` | *object* | Optional indexation data to associate with the transaction. | -`addressOptions?` | *object* | Optional address configuration for balance address lookups. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | +| `seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | +| `accountIndex` | *number* | The account index in the wallet. | +| `outputs` | {}[] | The outputs including address to send the funds to in ed25519 format and amount. | +| `indexation?` | *object* | Optional indexation data to associate with the transaction. | +| `addressOptions?` | *object* | Optional address configuration for balance address lookups. | **Returns:** *Promise*<{}\> @@ -146,21 +146,21 @@ Send a transfer using account based indexing for the inputs. #### Type parameters: -Name | -:------ | -`T` | +| Name | +| :------ | +| `T` | #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | -`seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | -`initialAddressState` | T | The initial address state for calculating the addresses. | -`nextAddressPath` | (`addressState`: T, `isFirst`: *boolean*) => *string* | Calculate the next address for inputs. | -`outputs` | {}[] | The address to send the funds to in bech32 format and amounts. | -`indexation?` | *object* | Optional indexation data to associate with the transaction. | -`zeroCount?` | *number* | The number of addresses with 0 balance during lookup before aborting. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | +| `seed` | [*ISeed*](../interfaces/models_iseed.iseed.md) | The seed to use for address generation. | +| `initialAddressState` | T | The initial address state for calculating the addresses. | +| `nextAddressPath` | (`addressState`: T, `isFirst`: *boolean*) => *string* | Calculate the next address for inputs. | +| `outputs` | {}[] | The address to send the funds to in bech32 format and amounts. | +| `indexation?` | *object* | Optional indexation data to associate with the transaction. | +| `zeroCount?` | *number* | The number of addresses with 0 balance during lookup before aborting. | **Returns:** *Promise*<{}\> diff --git a/docs/modules/highlevel_sendadvanced.md b/docs/modules/highlevel_sendadvanced.md index 4e092ee4d..86a50b991 100644 --- a/docs/modules/highlevel_sendadvanced.md +++ b/docs/modules/highlevel_sendadvanced.md @@ -19,11 +19,11 @@ Build a transaction payload. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`inputsAndSignatureKeyPairs` | {}[] | The inputs with the signature key pairs needed to sign transfers. | -`outputs` | {}[] | The outputs to send. | -`indexation?` | *object* | Optional indexation data to associate with the transaction. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `inputsAndSignatureKeyPairs` | {}[] | The inputs with the signature key pairs needed to sign transfers. | +| `outputs` | {}[] | The outputs to send. | +| `indexation?` | *object* | Optional indexation data to associate with the transaction. | **Returns:** [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) @@ -39,12 +39,12 @@ Send a transfer from the balance on the seed. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | -`inputsAndSignatureKeyPairs` | {}[] | The inputs with the signature key pairs needed to sign transfers. | -`outputs` | {}[] | The outputs to send. | -`indexation?` | *object* | Optional indexation data to associate with the transaction. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the transfer with. | +| `inputsAndSignatureKeyPairs` | {}[] | The inputs with the signature key pairs needed to sign transfers. | +| `outputs` | {}[] | The outputs to send. | +| `indexation?` | *object* | Optional indexation data to associate with the transaction. | **Returns:** *Promise*<{}\> diff --git a/docs/modules/highlevel_senddata.md b/docs/modules/highlevel_senddata.md index dbf12e252..a285fd9f7 100644 --- a/docs/modules/highlevel_senddata.md +++ b/docs/modules/highlevel_senddata.md @@ -18,11 +18,11 @@ Send a data message. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the data with. | -`indexationKey` | Uint8Array \| *string* | The index name. | -`indexationData?` | Uint8Array \| *string* | The index data as either UTF8 text or Uint8Array bytes. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `client` | [*IClient*](../interfaces/models_iclient.iclient.md) \| *string* | The client or node endpoint to send the data with. | +| `indexationKey` | Uint8Array \| *string* | The index name. | +| `indexationData?` | Uint8Array \| *string* | The index data as either UTF8 text or Uint8Array bytes. | **Returns:** *Promise*<{}\> diff --git a/docs/modules/models_ied25519address.md b/docs/modules/models_ied25519address.md index 110816f19..618bc952b 100644 --- a/docs/modules/models_ied25519address.md +++ b/docs/modules/models_ied25519address.md @@ -16,6 +16,6 @@ ### ED25519\_ADDRESS\_TYPE -• `Const` **ED25519\_ADDRESS\_TYPE**: *0*= 0 +• `Const` **ED25519\_ADDRESS\_TYPE**: ``0``= 0 The global type for the address type. diff --git a/docs/modules/models_ied25519signature.md b/docs/modules/models_ied25519signature.md index f8ffdc8f7..15c6ea6bd 100644 --- a/docs/modules/models_ied25519signature.md +++ b/docs/modules/models_ied25519signature.md @@ -16,6 +16,6 @@ ### ED25519\_SIGNATURE\_TYPE -• `Const` **ED25519\_SIGNATURE\_TYPE**: *0*= 0 +• `Const` **ED25519\_SIGNATURE\_TYPE**: ``0``= 0 The global type for the signature type. diff --git a/docs/modules/models_iindexationpayload.md b/docs/modules/models_iindexationpayload.md index 060265567..7359ec76c 100644 --- a/docs/modules/models_iindexationpayload.md +++ b/docs/modules/models_iindexationpayload.md @@ -16,6 +16,6 @@ ### INDEXATION\_PAYLOAD\_TYPE -• `Const` **INDEXATION\_PAYLOAD\_TYPE**: *2*= 2 +• `Const` **INDEXATION\_PAYLOAD\_TYPE**: ``2``= 2 The global type for the payload. diff --git a/docs/modules/models_imilestonepayload.md b/docs/modules/models_imilestonepayload.md index b24bef9e7..c684d4c60 100644 --- a/docs/modules/models_imilestonepayload.md +++ b/docs/modules/models_imilestonepayload.md @@ -16,6 +16,6 @@ ### MILESTONE\_PAYLOAD\_TYPE -• `Const` **MILESTONE\_PAYLOAD\_TYPE**: *1*= 1 +• `Const` **MILESTONE\_PAYLOAD\_TYPE**: ``1``= 1 The global type for the payload. diff --git a/docs/modules/models_ireceiptpayload.md b/docs/modules/models_ireceiptpayload.md index a0df0cdff..d20aa1702 100644 --- a/docs/modules/models_ireceiptpayload.md +++ b/docs/modules/models_ireceiptpayload.md @@ -16,6 +16,6 @@ ### RECEIPT\_PAYLOAD\_TYPE -• `Const` **RECEIPT\_PAYLOAD\_TYPE**: *3*= 3 +• `Const` **RECEIPT\_PAYLOAD\_TYPE**: ``3``= 3 The global type for the payload. diff --git a/docs/modules/models_ireferenceunlockblock.md b/docs/modules/models_ireferenceunlockblock.md index 5c646f3e5..f07f095d6 100644 --- a/docs/modules/models_ireferenceunlockblock.md +++ b/docs/modules/models_ireferenceunlockblock.md @@ -16,6 +16,6 @@ ### REFERENCE\_UNLOCK\_BLOCK\_TYPE -• `Const` **REFERENCE\_UNLOCK\_BLOCK\_TYPE**: *1*= 1 +• `Const` **REFERENCE\_UNLOCK\_BLOCK\_TYPE**: ``1``= 1 The global type for the unlock block. diff --git a/docs/modules/models_isiglockeddustallowanceoutput.md b/docs/modules/models_isiglockeddustallowanceoutput.md index ebb58fd30..ef9df5f56 100644 --- a/docs/modules/models_isiglockeddustallowanceoutput.md +++ b/docs/modules/models_isiglockeddustallowanceoutput.md @@ -16,6 +16,6 @@ ### SIG\_LOCKED\_DUST\_ALLOWANCE\_OUTPUT\_TYPE -• `Const` **SIG\_LOCKED\_DUST\_ALLOWANCE\_OUTPUT\_TYPE**: *1*= 1 +• `Const` **SIG\_LOCKED\_DUST\_ALLOWANCE\_OUTPUT\_TYPE**: ``1``= 1 The global type for the sig locked dust allowance output. diff --git a/docs/modules/models_isiglockedsingleoutput.md b/docs/modules/models_isiglockedsingleoutput.md index cfc979a5d..1e74ef836 100644 --- a/docs/modules/models_isiglockedsingleoutput.md +++ b/docs/modules/models_isiglockedsingleoutput.md @@ -16,6 +16,6 @@ ### SIG\_LOCKED\_SINGLE\_OUTPUT\_TYPE -• `Const` **SIG\_LOCKED\_SINGLE\_OUTPUT\_TYPE**: *0*= 0 +• `Const` **SIG\_LOCKED\_SINGLE\_OUTPUT\_TYPE**: ``0``= 0 The global type for the sig locked single output. diff --git a/docs/modules/models_isignatureunlockblock.md b/docs/modules/models_isignatureunlockblock.md index 93aa4101e..b2a549785 100644 --- a/docs/modules/models_isignatureunlockblock.md +++ b/docs/modules/models_isignatureunlockblock.md @@ -16,6 +16,6 @@ ### SIGNATURE\_UNLOCK\_BLOCK\_TYPE -• `Const` **SIGNATURE\_UNLOCK\_BLOCK\_TYPE**: *0*= 0 +• `Const` **SIGNATURE\_UNLOCK\_BLOCK\_TYPE**: ``0``= 0 The global type for the unlock block. diff --git a/docs/modules/models_itransactionessence.md b/docs/modules/models_itransactionessence.md index 2a5abd73d..d7e890e91 100644 --- a/docs/modules/models_itransactionessence.md +++ b/docs/modules/models_itransactionessence.md @@ -16,6 +16,6 @@ ### TRANSACTION\_ESSENCE\_TYPE -• `Const` **TRANSACTION\_ESSENCE\_TYPE**: *0*= 0 +• `Const` **TRANSACTION\_ESSENCE\_TYPE**: ``0``= 0 The global type for the transaction essence. diff --git a/docs/modules/models_itransactionpayload.md b/docs/modules/models_itransactionpayload.md index ee42e775b..934ee62a2 100644 --- a/docs/modules/models_itransactionpayload.md +++ b/docs/modules/models_itransactionpayload.md @@ -16,6 +16,6 @@ ### TRANSACTION\_PAYLOAD\_TYPE -• `Const` **TRANSACTION\_PAYLOAD\_TYPE**: *0*= 0 +• `Const` **TRANSACTION\_PAYLOAD\_TYPE**: ``0``= 0 The global type for the payload. diff --git a/docs/modules/models_itreasuryinput.md b/docs/modules/models_itreasuryinput.md index fe914a6ab..4feb2bb63 100644 --- a/docs/modules/models_itreasuryinput.md +++ b/docs/modules/models_itreasuryinput.md @@ -16,6 +16,6 @@ ### TREASURY\_INPUT\_TYPE -• `Const` **TREASURY\_INPUT\_TYPE**: *1*= 1 +• `Const` **TREASURY\_INPUT\_TYPE**: ``1``= 1 The global type for the treasury input. diff --git a/docs/modules/models_itreasuryoutput.md b/docs/modules/models_itreasuryoutput.md index 09d1d89f2..f03104cc0 100644 --- a/docs/modules/models_itreasuryoutput.md +++ b/docs/modules/models_itreasuryoutput.md @@ -16,6 +16,6 @@ ### TREASURY\_OUTPUT\_TYPE -• `Const` **TREASURY\_OUTPUT\_TYPE**: *2*= 2 +• `Const` **TREASURY\_OUTPUT\_TYPE**: ``2``= 2 The global type for the treasury output. diff --git a/docs/modules/models_itreasurytransactionpayload.md b/docs/modules/models_itreasurytransactionpayload.md index 6c49eddbc..2b76f7585 100644 --- a/docs/modules/models_itreasurytransactionpayload.md +++ b/docs/modules/models_itreasurytransactionpayload.md @@ -16,6 +16,6 @@ ### TREASURY\_TRANSACTION\_PAYLOAD\_TYPE -• `Const` **TREASURY\_TRANSACTION\_PAYLOAD\_TYPE**: *4*= 4 +• `Const` **TREASURY\_TRANSACTION\_PAYLOAD\_TYPE**: ``4``= 4 The global type for the payload. diff --git a/docs/modules/models_iutxoinput.md b/docs/modules/models_iutxoinput.md index 353f1b280..7a6ca0f3e 100644 --- a/docs/modules/models_iutxoinput.md +++ b/docs/modules/models_iutxoinput.md @@ -16,6 +16,6 @@ ### UTXO\_INPUT\_TYPE -• `Const` **UTXO\_INPUT\_TYPE**: *0*= 0 +• `Const` **UTXO\_INPUT\_TYPE**: ``0``= 0 The global type for the input. diff --git a/docs/modules/models_ledgerinclusionstate.md b/docs/modules/models_ledgerinclusionstate.md index 1d9f3a8e8..8fbf69169 100644 --- a/docs/modules/models_ledgerinclusionstate.md +++ b/docs/modules/models_ledgerinclusionstate.md @@ -12,6 +12,6 @@ ### LedgerInclusionState -Ƭ **LedgerInclusionState**: *noTransaction* \| *included* \| *conflicting* +Ƭ **LedgerInclusionState**: ``"noTransaction"`` \| ``"included"`` \| ``"conflicting"`` The different states of ledger inclusion. diff --git a/docs/modules/utils_logging.md b/docs/modules/utils_logging.md index 6fb540d75..8b53877c1 100644 --- a/docs/modules/utils_logging.md +++ b/docs/modules/utils_logging.md @@ -34,10 +34,10 @@ Log an address to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`unknownAddress?` | [*IEd25519Address*](../interfaces/models_ied25519address.ied25519address.md) | The address to log. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `unknownAddress?` | [*IEd25519Address*](../interfaces/models_ied25519address.ied25519address.md) | The address to log. | **Returns:** *void* @@ -51,10 +51,10 @@ Log fund to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`fund?` | [*IMigratedFunds*](../interfaces/models_imigratedfunds.imigratedfunds.md) | The fund to log. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `fund?` | [*IMigratedFunds*](../interfaces/models_imigratedfunds.imigratedfunds.md) | The fund to log. | **Returns:** *void* @@ -68,10 +68,10 @@ Log a indexation payload to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`payload?` | [*IIndexationPayload*](../interfaces/models_iindexationpayload.iindexationpayload.md) | The payload. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `payload?` | [*IIndexationPayload*](../interfaces/models_iindexationpayload.iindexationpayload.md) | The payload. | **Returns:** *void* @@ -85,10 +85,10 @@ Log the node information. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`info` | [*INodeInfo*](../interfaces/models_inodeinfo.inodeinfo.md) | The info to log. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `info` | [*INodeInfo*](../interfaces/models_inodeinfo.inodeinfo.md) | The info to log. | **Returns:** *void* @@ -102,10 +102,10 @@ Log input to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`unknownInput?` | [*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) \| [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md) | The input to log. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `unknownInput?` | [*IUTXOInput*](../interfaces/models_iutxoinput.iutxoinput.md) \| [*ITreasuryInput*](../interfaces/models_itreasuryinput.itreasuryinput.md) | The input to log. | **Returns:** *void* @@ -119,10 +119,10 @@ Log a message to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`message` | [*IMessage*](../interfaces/models_imessage.imessage.md) | The message to log. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `message` | [*IMessage*](../interfaces/models_imessage.imessage.md) | The message to log. | **Returns:** *void* @@ -136,10 +136,10 @@ Log the message metadata to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`messageMetadata` | [*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md) | The messageMetadata to log. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `messageMetadata` | [*IMessageMetadata*](../interfaces/models_imessagemetadata.imessagemetadata.md) | The messageMetadata to log. | **Returns:** *void* @@ -153,10 +153,10 @@ Log a milestone payload to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`payload?` | [*IMilestonePayload*](../interfaces/models_imilestonepayload.imilestonepayload.md) | The payload. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `payload?` | [*IMilestonePayload*](../interfaces/models_imilestonepayload.imilestonepayload.md) | The payload. | **Returns:** *void* @@ -170,10 +170,10 @@ Log output to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`unknownOutput?` | [*ISigLockedSingleOutput*](../interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md) \| [*ISigLockedDustAllowanceOutput*](../interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md) \| [*ITreasuryOutput*](../interfaces/models_itreasuryoutput.itreasuryoutput.md) | The output to log. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `unknownOutput?` | [*ISigLockedSingleOutput*](../interfaces/models_isiglockedsingleoutput.isiglockedsingleoutput.md) \| [*ISigLockedDustAllowanceOutput*](../interfaces/models_isiglockeddustallowanceoutput.isiglockeddustallowanceoutput.md) \| [*ITreasuryOutput*](../interfaces/models_itreasuryoutput.itreasuryoutput.md) | The output to log. | **Returns:** *void* @@ -187,10 +187,10 @@ Log a message to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`unknownPayload?` | [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) \| [*IMilestonePayload*](../interfaces/models_imilestonepayload.imilestonepayload.md) \| [*IIndexationPayload*](../interfaces/models_iindexationpayload.iindexationpayload.md) \| [*ITreasuryTransactionPayload*](../interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md) \| [*IReceiptPayload*](../interfaces/models_ireceiptpayload.ireceiptpayload.md) | The payload. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `unknownPayload?` | [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) \| [*IMilestonePayload*](../interfaces/models_imilestonepayload.imilestonepayload.md) \| [*IIndexationPayload*](../interfaces/models_iindexationpayload.iindexationpayload.md) \| [*ITreasuryTransactionPayload*](../interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md) \| [*IReceiptPayload*](../interfaces/models_ireceiptpayload.ireceiptpayload.md) | The payload. | **Returns:** *void* @@ -204,10 +204,10 @@ Log a receipt payload to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`payload?` | [*IReceiptPayload*](../interfaces/models_ireceiptpayload.ireceiptpayload.md) | The payload. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `payload?` | [*IReceiptPayload*](../interfaces/models_ireceiptpayload.ireceiptpayload.md) | The payload. | **Returns:** *void* @@ -221,10 +221,10 @@ Log signature to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`unknownSignature?` | [*IEd25519Signature*](../interfaces/models_ied25519signature.ied25519signature.md) | The signature to log. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `unknownSignature?` | [*IEd25519Signature*](../interfaces/models_ied25519signature.ied25519signature.md) | The signature to log. | **Returns:** *void* @@ -238,10 +238,10 @@ Log the tips information. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`tipsResponse` | [*ITipsResponse*](../interfaces/models_api_itipsresponse.itipsresponse.md) | The tips to log. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `tipsResponse` | [*ITipsResponse*](../interfaces/models_api_itipsresponse.itipsresponse.md) | The tips to log. | **Returns:** *void* @@ -255,10 +255,10 @@ Log a transaction payload to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`payload?` | [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) | The payload. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `payload?` | [*ITransactionPayload*](../interfaces/models_itransactionpayload.itransactionpayload.md) | The payload. | **Returns:** *void* @@ -272,10 +272,10 @@ Log a treasury transaction payload to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`payload?` | [*ITreasuryTransactionPayload*](../interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md) | The payload. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `payload?` | [*ITreasuryTransactionPayload*](../interfaces/models_itreasurytransactionpayload.itreasurytransactionpayload.md) | The payload. | **Returns:** *void* @@ -289,10 +289,10 @@ Log unlock block to the console. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`prefix` | *string* | The prefix for the output. | -`unknownUnlockBlock?` | [*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) \| [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md) | The unlock block to log. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `prefix` | *string* | The prefix for the output. | +| `unknownUnlockBlock?` | [*ISignatureUnlockBlock*](../interfaces/models_isignatureunlockblock.isignatureunlockblock.md) \| [*IReferenceUnlockBlock*](../interfaces/models_ireferenceunlockblock.ireferenceunlockblock.md) | The unlock block to log. | **Returns:** *void* @@ -306,8 +306,8 @@ Set the logger for output. #### Parameters: -Name | Type | Description | -:------ | :------ | :------ | -`log` | (`message`: *string*, `data?`: *unknown*) => *void* | The logger. | +| Name | Type | Description | +| :------ | :------ | :------ | +| `log` | (`message`: *string*, `data?`: *unknown*) => *void* | The logger. | **Returns:** *void* diff --git a/package-lock.json b/package-lock.json index 2d557d8ca..8b479d439 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@iota/iota.js", - "version": "1.5.0-alpha.7", + "version": "1.5.0", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -14,9 +14,9 @@ } }, "@babel/compat-data": { - "version": "7.13.12", - "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.13.12.tgz", - "integrity": "sha512-3eJJ841uKxeV8dcN/2yGEUy+RfgQspPEgQat85umsE1rotuquQ2AbIub4S6j7c50a2d+4myc+zSlnXeIHrOnhQ==", + "version": "7.13.15", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.13.15.tgz", + "integrity": "sha512-ltnibHKR1VnrU4ymHyQ/CXtNXI6yZC0oJThyW78Hft8XndANwi+9H+UIklBDraIjFEJzw8wmcM427oDd9KS5wA==", "dev": true }, "@babel/core": { @@ -96,12 +96,12 @@ } }, "@babel/helper-compilation-targets": { - "version": "7.13.13", - "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.13.13.tgz", - "integrity": "sha512-q1kcdHNZehBwD9jYPh3WyXcsFERi39X4I59I3NadciWtNDyZ6x+GboOxncFK0kXlKIv6BJm5acncehXWUjWQMQ==", + "version": "7.13.16", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.13.16.tgz", + "integrity": "sha512-3gmkYIrpqsLlieFwjkGgLaSHmhnvlAYzZLlYVjlW+QwI+1zE17kGxuJGmIqDQdYp56XdmGeD+Bswx0UTyG18xA==", "dev": true, "requires": { - "@babel/compat-data": "^7.13.12", + "@babel/compat-data": "^7.13.15", "@babel/helper-validator-option": "^7.12.17", "browserslist": "^4.14.5", "semver": "^6.3.0" @@ -1015,9 +1015,9 @@ "dev": true }, "@types/node-fetch": { - "version": "2.5.9", - "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.9.tgz", - "integrity": "sha512-6cUyqLK+JBsATAqNQqk10jURoBFrzfRCDh4kaYxg8ivKhRPIpyBgAvuY7zM/3E4AwsYJSh5HCHBCJRM4DsCTaQ==", + "version": "2.5.10", + "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.5.10.tgz", + "integrity": "sha512-IpkX0AasN44hgEad0gEF/V6EgR5n69VEqPEgnmoM8GsIGro3PowbWs4tR6IhxUTyPLpOn+fiGG6nrQhcmoCuIQ==", "dev": true, "requires": { "@types/node": "*", @@ -1067,13 +1067,13 @@ "dev": true }, "@typescript-eslint/eslint-plugin": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.21.0.tgz", - "integrity": "sha512-FPUyCPKZbVGexmbCFI3EQHzCZdy2/5f+jv6k2EDljGdXSRc0cKvbndd2nHZkSLqCNOPk0jB6lGzwIkglXcYVsQ==", + "version": "4.22.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.22.0.tgz", + "integrity": "sha512-U8SP9VOs275iDXaL08Ln1Fa/wLXfj5aTr/1c0t0j6CdbOnxh+TruXu1p4I0NAvdPBQgoPjHsgKn28mOi0FzfoA==", "dev": true, "requires": { - "@typescript-eslint/experimental-utils": "4.21.0", - "@typescript-eslint/scope-manager": "4.21.0", + "@typescript-eslint/experimental-utils": "4.22.0", + "@typescript-eslint/scope-manager": "4.22.0", "debug": "^4.1.1", "functional-red-black-tree": "^1.0.1", "lodash": "^4.17.15", @@ -1083,55 +1083,55 @@ } }, "@typescript-eslint/experimental-utils": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.21.0.tgz", - "integrity": "sha512-cEbgosW/tUFvKmkg3cU7LBoZhvUs+ZPVM9alb25XvR0dal4qHL3SiUqHNrzoWSxaXA9gsifrYrS1xdDV6w/gIA==", + "version": "4.22.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.22.0.tgz", + "integrity": "sha512-xJXHHl6TuAxB5AWiVrGhvbGL8/hbiCQ8FiWwObO3r0fnvBdrbWEDy1hlvGQOAWc6qsCWuWMKdVWlLAEMpxnddg==", "dev": true, "requires": { "@types/json-schema": "^7.0.3", - "@typescript-eslint/scope-manager": "4.21.0", - "@typescript-eslint/types": "4.21.0", - "@typescript-eslint/typescript-estree": "4.21.0", + "@typescript-eslint/scope-manager": "4.22.0", + "@typescript-eslint/types": "4.22.0", + "@typescript-eslint/typescript-estree": "4.22.0", "eslint-scope": "^5.0.0", "eslint-utils": "^2.0.0" } }, "@typescript-eslint/parser": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.21.0.tgz", - "integrity": "sha512-eyNf7QmE5O/l1smaQgN0Lj2M/1jOuNg2NrBm1dqqQN0sVngTLyw8tdCbih96ixlhbF1oINoN8fDCyEH9SjLeIA==", + "version": "4.22.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.22.0.tgz", + "integrity": "sha512-z/bGdBJJZJN76nvAY9DkJANYgK3nlRstRRi74WHm3jjgf2I8AglrSY+6l7ogxOmn55YJ6oKZCLLy+6PW70z15Q==", "dev": true, "requires": { - "@typescript-eslint/scope-manager": "4.21.0", - "@typescript-eslint/types": "4.21.0", - "@typescript-eslint/typescript-estree": "4.21.0", + "@typescript-eslint/scope-manager": "4.22.0", + "@typescript-eslint/types": "4.22.0", + "@typescript-eslint/typescript-estree": "4.22.0", "debug": "^4.1.1" } }, "@typescript-eslint/scope-manager": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.21.0.tgz", - "integrity": "sha512-kfOjF0w1Ix7+a5T1knOw00f7uAP9Gx44+OEsNQi0PvvTPLYeXJlsCJ4tYnDj5PQEYfpcgOH5yBlw7K+UEI9Agw==", + "version": "4.22.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.22.0.tgz", + "integrity": "sha512-OcCO7LTdk6ukawUM40wo61WdeoA7NM/zaoq1/2cs13M7GyiF+T4rxuA4xM+6LeHWjWbss7hkGXjFDRcKD4O04Q==", "dev": true, "requires": { - "@typescript-eslint/types": "4.21.0", - "@typescript-eslint/visitor-keys": "4.21.0" + "@typescript-eslint/types": "4.22.0", + "@typescript-eslint/visitor-keys": "4.22.0" } }, "@typescript-eslint/types": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.21.0.tgz", - "integrity": "sha512-+OQaupjGVVc8iXbt6M1oZMwyKQNehAfLYJJ3SdvnofK2qcjfor9pEM62rVjBknhowTkh+2HF+/KdRAc/wGBN2w==", + "version": "4.22.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.22.0.tgz", + "integrity": "sha512-sW/BiXmmyMqDPO2kpOhSy2Py5w6KvRRsKZnV0c4+0nr4GIcedJwXAq+RHNK4lLVEZAJYFltnnk1tJSlbeS9lYA==", "dev": true }, "@typescript-eslint/typescript-estree": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.21.0.tgz", - "integrity": "sha512-ZD3M7yLaVGVYLw4nkkoGKumb7Rog7QID9YOWobFDMQKNl+vPxqVIW/uDk+MDeGc+OHcoG2nJ2HphwiPNajKw3w==", + "version": "4.22.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.22.0.tgz", + "integrity": "sha512-TkIFeu5JEeSs5ze/4NID+PIcVjgoU3cUQUIZnH3Sb1cEn1lBo7StSV5bwPuJQuoxKXlzAObjYTilOEKRuhR5yg==", "dev": true, "requires": { - "@typescript-eslint/types": "4.21.0", - "@typescript-eslint/visitor-keys": "4.21.0", + "@typescript-eslint/types": "4.22.0", + "@typescript-eslint/visitor-keys": "4.22.0", "debug": "^4.1.1", "globby": "^11.0.1", "is-glob": "^4.0.1", @@ -1151,12 +1151,12 @@ } }, "@typescript-eslint/visitor-keys": { - "version": "4.21.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.21.0.tgz", - "integrity": "sha512-dH22dROWGi5Z6p+Igc8bLVLmwy7vEe8r+8c+raPQU0LxgogPUrRAtRGtvBWmlr9waTu3n+QLt/qrS/hWzk1x5w==", + "version": "4.22.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.22.0.tgz", + "integrity": "sha512-nnMu4F+s4o0sll6cBSsTeVsT4cwxB7zECK3dFxzEjPBii9xLpq4yqqsy/FU5zMfan6G60DKZSCXAa3sHJZrcYw==", "dev": true, "requires": { - "@typescript-eslint/types": "4.21.0", + "@typescript-eslint/types": "4.22.0", "eslint-visitor-keys": "^2.0.0" } }, @@ -1565,16 +1565,16 @@ "dev": true }, "browserslist": { - "version": "4.16.3", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.16.3.tgz", - "integrity": "sha512-vIyhWmIkULaq04Gt93txdh+j02yX/JzlyhLYbV3YQCn/zvES3JnY7TifHHvvr1w5hTDluNKMkV05cs4vy8Q7sw==", + "version": "4.16.4", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.16.4.tgz", + "integrity": "sha512-d7rCxYV8I9kj41RH8UKYnvDYCRENUlHRgyXy/Rhr/1BaeLGfiCptEdFE8MIrvGfWbBFNjVYx76SQWvNX1j+/cQ==", "dev": true, "requires": { - "caniuse-lite": "^1.0.30001181", - "colorette": "^1.2.1", - "electron-to-chromium": "^1.3.649", + "caniuse-lite": "^1.0.30001208", + "colorette": "^1.2.2", + "electron-to-chromium": "^1.3.712", "escalade": "^3.1.1", - "node-releases": "^1.1.70" + "node-releases": "^1.1.71" } }, "bs-logger": { @@ -1693,9 +1693,9 @@ "dev": true }, "caniuse-lite": { - "version": "1.0.30001207", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001207.tgz", - "integrity": "sha512-UPQZdmAsyp2qfCTiMU/zqGSWOYaY9F9LL61V8f+8MrubsaDGpaHD9HRV/EWZGULZn0Hxu48SKzI5DgFwTvHuYw==", + "version": "1.0.30001214", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001214.tgz", + "integrity": "sha512-O2/SCpuaU3eASWVaesQirZv1MSjUNOvmugaD8zNSJqw6Vv5SGwoOpA9LJs3pNPfM745nxqPvfZY3MQKY4AKHYg==", "dev": true }, "capture-exit": { @@ -2217,9 +2217,9 @@ } }, "electron-to-chromium": { - "version": "1.3.708", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.708.tgz", - "integrity": "sha512-+A8ggYZ5riOLMcVAuzHx6bforaPzaiLnW1QOMD2SlMYQVi7QQTyQ/WrlZoebIH9ikmgr+tLJGpNITFFCUiQcPw==", + "version": "1.3.719", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.719.tgz", + "integrity": "sha512-heM78GKSqrIzO9Oz0/y22nTBN7bqSP1Pla2SyU9DiSnQD+Ea9SyyN5RWWlgqsqeBLNDkSlE9J9EHFmdMPzxB/g==", "dev": true }, "emittery": { @@ -2365,9 +2365,9 @@ } }, "eslint": { - "version": "7.23.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.23.0.tgz", - "integrity": "sha512-kqvNVbdkjzpFy0XOszNwjkKzZ+6TcwCQ/h+ozlcIWwaimBBuhlQ4nN6kbiM2L+OjDcznkTJxzYfRFH92sx4a0Q==", + "version": "7.24.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.24.0.tgz", + "integrity": "sha512-k9gaHeHiFmGCDQ2rEfvULlSLruz6tgfA8DEn+rY9/oYPFFTlz55mM/Q/Rij1b2Y42jwZiK3lXvNTw6w6TXzcKQ==", "dev": true, "requires": { "@babel/code-frame": "7.12.11", @@ -2574,9 +2574,9 @@ } }, "eslint-plugin-unicorn": { - "version": "29.0.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-unicorn/-/eslint-plugin-unicorn-29.0.0.tgz", - "integrity": "sha512-R9jGLKb2p6LuOixviByGlH2mkfY72EBELXAPeUufveebN0M2Woa7B7dUO3gN2xPn/+eGjrIm4I2u7dDtr9G4iA==", + "version": "30.0.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-unicorn/-/eslint-plugin-unicorn-30.0.0.tgz", + "integrity": "sha512-ZKbE48Ep99z/3geLpkBfv+jNrzr2k7bLqCC/RfZOekZzAvn2/ECDE/d8zGdW1YxHmIC9pevQvm8Pl89v9GEIVw==", "dev": true, "requires": { "ci-info": "^3.1.1", @@ -2585,13 +2585,13 @@ "eslint-utils": "^2.1.0", "eslint-visitor-keys": "^2.0.0", "import-modules": "^2.1.0", - "lodash": "^4.17.20", + "lodash": "^4.17.21", "pluralize": "^8.0.0", "read-pkg-up": "^7.0.1", "regexp-tree": "^0.1.23", "reserved-words": "^0.1.2", "safe-regex": "^2.1.1", - "semver": "^7.3.4" + "semver": "^7.3.5" }, "dependencies": { "ci-info": { @@ -2619,6 +2619,12 @@ "p-locate": "^4.1.0" } }, + "lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true + }, "p-limit": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", @@ -2691,6 +2697,15 @@ "read-pkg": "^5.2.0", "type-fest": "^0.8.1" } + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } } } }, @@ -2727,20 +2742,20 @@ } }, "@babel/core": { - "version": "7.13.14", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.13.14.tgz", - "integrity": "sha512-wZso/vyF4ki0l0znlgM4inxbdrUvCb+cVz8grxDq+6C9k6qbqoIJteQOKicaKjCipU3ISV+XedCqpL2RJJVehA==", + "version": "7.13.16", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.13.16.tgz", + "integrity": "sha512-sXHpixBiWWFti0AV2Zq7avpTasr6sIAu7Y396c608541qAU2ui4a193m0KSQmfPSKFZLnQ3cvlKDOm3XkuXm3Q==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@babel/generator": "^7.13.9", - "@babel/helper-compilation-targets": "^7.13.13", + "@babel/generator": "^7.13.16", + "@babel/helper-compilation-targets": "^7.13.16", "@babel/helper-module-transforms": "^7.13.14", - "@babel/helpers": "^7.13.10", - "@babel/parser": "^7.13.13", + "@babel/helpers": "^7.13.16", + "@babel/parser": "^7.13.16", "@babel/template": "^7.12.13", - "@babel/traverse": "^7.13.13", - "@babel/types": "^7.13.14", + "@babel/traverse": "^7.13.15", + "@babel/types": "^7.13.16", "convert-source-map": "^1.7.0", "debug": "^4.1.0", "gensync": "^1.0.0-beta.2", @@ -2750,12 +2765,12 @@ } }, "@babel/generator": { - "version": "7.13.9", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.13.9.tgz", - "integrity": "sha512-mHOOmY0Axl/JCTkxTU6Lf5sWOg/v8nUa+Xkt4zMTftX0wqmb6Sh7J8gvcehBw7q0AhrhAR+FDacKjCZ2X8K+Sw==", + "version": "7.13.16", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.13.16.tgz", + "integrity": "sha512-grBBR75UnKOcUWMp8WoDxNsWCFl//XCK6HWTrBQKTr5SV9f5g0pNOjdyzi/DTBv12S9GnYPInIXQBTky7OXEMg==", "dev": true, "requires": { - "@babel/types": "^7.13.0", + "@babel/types": "^7.13.16", "jsesc": "^2.5.1", "source-map": "^0.5.0" } @@ -2860,14 +2875,14 @@ "dev": true }, "@babel/helpers": { - "version": "7.13.10", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.13.10.tgz", - "integrity": "sha512-4VO883+MWPDUVRF3PhiLBUFHoX/bsLTGFpFK/HqvvfBZz2D57u9XzPVNFVBTc0PW/CWR9BXTOKt8NF4DInUHcQ==", + "version": "7.13.17", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.13.17.tgz", + "integrity": "sha512-Eal4Gce4kGijo1/TGJdqp3WuhllaMLSrW6XcL0ulyUAQOuxHcCafZE8KHg9857gcTehsm/v7RcOx2+jp0Ryjsg==", "dev": true, "requires": { "@babel/template": "^7.12.13", - "@babel/traverse": "^7.13.0", - "@babel/types": "^7.13.0" + "@babel/traverse": "^7.13.17", + "@babel/types": "^7.13.17" } }, "@babel/highlight": { @@ -2882,9 +2897,9 @@ } }, "@babel/parser": { - "version": "7.13.13", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.13.13.tgz", - "integrity": "sha512-OhsyMrqygfk5v8HmWwOzlYjJrtLaFhF34MrfG/Z73DgYCI6ojNUTUp2TYbtnjo8PegeJp12eamsNettCQjKjVw==", + "version": "7.13.16", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.13.16.tgz", + "integrity": "sha512-6bAg36mCwuqLO0hbR+z7PHuqWiCeP7Dzg73OpQwsAB1Eb8HnGEz5xYBzCfbu+YjoaJsJs+qheDxVAuqbt3ILEw==", "dev": true }, "@babel/template": { @@ -2899,29 +2914,28 @@ } }, "@babel/traverse": { - "version": "7.13.13", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.13.13.tgz", - "integrity": "sha512-CblEcwmXKR6eP43oQGG++0QMTtCjAsa3frUuzHoiIJWpaIIi8dwMyEFUJoXRLxagGqCK+jALRwIO+o3R9p/uUg==", + "version": "7.13.17", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.13.17.tgz", + "integrity": "sha512-BMnZn0R+X6ayqm3C3To7o1j7Q020gWdqdyP50KEoVqaCO2c/Im7sYZSmVgvefp8TTMQ+9CtwuBp0Z1CZ8V3Pvg==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@babel/generator": "^7.13.9", + "@babel/generator": "^7.13.16", "@babel/helper-function-name": "^7.12.13", "@babel/helper-split-export-declaration": "^7.12.13", - "@babel/parser": "^7.13.13", - "@babel/types": "^7.13.13", + "@babel/parser": "^7.13.16", + "@babel/types": "^7.13.17", "debug": "^4.1.0", "globals": "^11.1.0" } }, "@babel/types": { - "version": "7.13.14", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.13.14.tgz", - "integrity": "sha512-A2aa3QTkWoyqsZZFl56MLUsfmh7O0gN41IPvXAE/++8ojpbz12SszD7JEGYVdn4f9Kt4amIei07swF1h4AqmmQ==", + "version": "7.13.17", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.13.17.tgz", + "integrity": "sha512-RawydLgxbOPDlTLJNtoIypwdmAy//uQIzlKt2+iBiJaRlVuI6QLUxVAyWGNfOzp8Yu4L4lLIacoCyTNtpb4wiA==", "dev": true, "requires": { "@babel/helper-validator-identifier": "^7.12.11", - "lodash": "^4.17.19", "to-fast-properties": "^2.0.0" } }, @@ -3640,9 +3654,9 @@ } }, "globals": { - "version": "13.7.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-13.7.0.tgz", - "integrity": "sha512-Aipsz6ZKRxa/xQkZhNg0qIWXT6x6rD46f6x/PCnBomlttdIyAPak4YD9jTmKpZ72uROSMU87qJtcgpgHaVchiA==", + "version": "13.8.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.8.0.tgz", + "integrity": "sha512-rHtdA6+PDBIjeEvA91rpqzEvk/k3/i7EeNQiryiWuJH0Hw9cpyJMAt2jtbAwUaRdhD+573X4vWw6IcjKPasi9Q==", "dev": true, "requires": { "type-fest": "^0.20.2" @@ -6381,9 +6395,9 @@ } }, "rollup": { - "version": "2.44.0", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.44.0.tgz", - "integrity": "sha512-rGSF4pLwvuaH/x4nAS+zP6UNn5YUDWf/TeEU5IoXSZKBbKRNTCI3qMnYXKZgrC0D2KzS2baiOZt1OlqhMu5rnQ==", + "version": "2.45.2", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.45.2.tgz", + "integrity": "sha512-kRRU7wXzFHUzBIv0GfoFFIN3m9oteY4uAsKllIpQDId5cfnkWF2J130l+27dzDju0E6MScKiV0ZM5Bw8m4blYQ==", "dev": true, "requires": { "fsevents": "~2.3.1" @@ -7122,9 +7136,9 @@ "dev": true }, "table": { - "version": "6.0.9", - "resolved": "https://registry.npmjs.org/table/-/table-6.0.9.tgz", - "integrity": "sha512-F3cLs9a3hL1Z7N4+EkSscsel3z55XT950AvB05bwayrNg5T1/gykXtigioTAjbltvbMSJvvhFCbnf6mX+ntnJQ==", + "version": "6.3.2", + "resolved": "https://registry.npmjs.org/table/-/table-6.3.2.tgz", + "integrity": "sha512-I9/Ca6Huf2oxFag7crD0DhA+arIdfLtWunSn0NIXSzjtUlDgIBGVZY7SsMkNPNT3Psd/z4gza0nuEpmra9eRbg==", "dev": true, "requires": { "ajv": "^8.0.1", @@ -7139,9 +7153,9 @@ }, "dependencies": { "ajv": { - "version": "8.0.5", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.0.5.tgz", - "integrity": "sha512-RkiLa/AeJx7+9OvniQ/qeWu0w74A8DiPPBclQ6ji3ZQkv5KamO+QGpqmi7O4JIw3rHGUXZ6CoP9tsAkn3gyazg==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.1.0.tgz", + "integrity": "sha512-B/Sk2Ix7A36fs/ZkuGLIR86EdjbgR6fsAcbx9lOP/QBSXujDNbVmIS/U4Itz5k8fPFDeVZl/zQ/gJW4Jrq6XjQ==", "dev": true, "requires": { "fast-deep-equal": "^3.1.1", @@ -7351,9 +7365,9 @@ } }, "ts-jest": { - "version": "26.5.4", - "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-26.5.4.tgz", - "integrity": "sha512-I5Qsddo+VTm94SukBJ4cPimOoFZsYTeElR2xy6H2TOVs+NsvgYglW8KuQgKoApOKuaU/Ix/vrF9ebFZlb5D2Pg==", + "version": "26.5.5", + "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-26.5.5.tgz", + "integrity": "sha512-7tP4m+silwt1NHqzNRAPjW1BswnAhopTdc2K3HEkRZjF0ZG2F/e/ypVH0xiZIMfItFtD3CX0XFbwPzp9fIEUVg==", "dev": true, "requires": { "bs-logger": "0.x", @@ -7510,18 +7524,18 @@ "dev": true }, "typedoc-plugin-markdown": { - "version": "3.6.1", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.6.1.tgz", - "integrity": "sha512-GT09K0/w+DpFk8W2lmsnDiYBHH/5EHscFmyIOv5624WSoqxgMf+xn2BLAYLebYeoIUx9uwhSFtQJlXKFfW9uHA==", + "version": "3.7.1", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.7.1.tgz", + "integrity": "sha512-+r04TLdnvCSrQ8RX5APuBur0e22uqJbb/8R65GvIhvaYKiwVa6/+34mEnM4iQv6VERenUMFnuAFw+icj8r4H8Q==", "dev": true, "requires": { "handlebars": "^4.7.7" } }, "typescript": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.3.tgz", - "integrity": "sha512-qOcYwxaByStAWrBf4x0fibwZvMRG+r4cQoTjbPtUlrWjBHbmCAww1i448U0GJ+3cNNEtebDteo/cHOR3xJ4wEw==", + "version": "4.2.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.4.tgz", + "integrity": "sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg==", "dev": true }, "uglify-js": { diff --git a/package.json b/package.json index 484eaffe3..e9f4dc5f3 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@iota/iota.js", "description": "IOTA JavaScript Library for Chrysalis", - "version": "1.5.0-alpha.7", + "version": "1.5.0", "keywords": [ "iota", "client" @@ -55,25 +55,25 @@ "@rollup/plugin-node-resolve": "^11.2.1", "@rollup/plugin-replace": "^2.4.2", "@types/jest": "^26.0.22", - "@types/node-fetch": "^2.5.9", - "@typescript-eslint/eslint-plugin": "^4.21.0", - "@typescript-eslint/parser": "^4.21.0", + "@types/node-fetch": "^2.5.10", + "@typescript-eslint/eslint-plugin": "^4.22.0", + "@typescript-eslint/parser": "^4.22.0", "cross-env": "^7.0.2", - "eslint": "^7.23.0", + "eslint": "^7.24.0", "eslint-plugin-header": "^3.1.1", "eslint-plugin-import": "^2.22.1", "eslint-plugin-jsdoc": "^32.3.0", - "eslint-plugin-unicorn": "^29.0.0", + "eslint-plugin-unicorn": "^30.0.0", "jest": "^26.6.0", "npm-run-all": "^4.1.5", "rimraf": "^3.0.2", - "rollup": "^2.44.0", + "rollup": "^2.45.2", "rollup-plugin-terser": "^7.0.2", - "ts-jest": "^26.5.4", + "ts-jest": "^26.5.5", "ts-node": "^9.0.0", "typedoc": "^0.20.35", - "typedoc-plugin-markdown": "^3.6.1", - "typescript": "^4.2.3" + "typedoc-plugin-markdown": "^3.7.1", + "typescript": "^4.2.4" }, "main": "dist/iota.js", "browser": "dist/iota.browser.js",