Interface ITransactionsReplaceMetadataRequest

Argument interface for the Wallet.transactionsReplaceMetadata method. Metadata is a wallet-specific string that can be used to store arbitrary data. It should contain a serialized JSON string with key containing the custom data stored by the wallet. When interacting with metadata, the wallet should always deserialize the JSON string and then serialize it again after making changes, preserving any foreign keys that it might encounter.

To preserve foreign metadata, the pattern of access should be: Get -> Modify -> Replace

interface ITransactionsReplaceMetadataRequest {
    accountId: string;
    metadata?: string;
    networkId: string | NetworkId;
    transactionId: string;
}

Properties

accountId metadata? networkId transactionId

Properties

accountId

accountId: string

The id of account the transaction belongs to.

Optional metadata

metadata?: string

Optional metadata string to replace the existing metadata. If not supplied, the metadata will be removed.

networkId

networkId: string | NetworkId

The network id of the transaction.

transactionId

transactionId: string

The id of the transaction.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc