Types

• IARC0001Transaction
• IAVMWebClientCallbackOptions
• IAVMWebClientConfig
• IAVMWebClientInitOptions
• IAVMWebProviderCallbackOptions
• IAVMWebProviderConfig
• IAVMWebProviderInitOptions
• IBaseError
• IAccount
• IDisableParams
• IDisableResult
• IDiscoverParams
• IDiscoverResult
• IEnableParams
• IEnableResult
• INetworkConfiguration
• IPostTransactionsParams
• IPostTransactionsResult
• ISignMessageParams
• ISignMessageResult
• ISignTransactionsParams
• ISignTransactionsResult

IARC0001Transaction

Name	Type	Required	Default	Description
authAddr	string	no	-	The auth address if the sender has rekeyed.
msig	MultisigMetadata	no	-	Extra metadata needed when sending multisig transactions.
signers	string[]	no	-	A list of addresses to sign with (defaults to the sender in the transaction).
stxn	string	no	-	If this is part of a group of transactions, some of which are already signed you must also provide these signed transactions and the signers array MUST be undefined or empty, as per ARC-0001.
txn	string	yes	-	The base64 encoded unsigned transaction.

IAVMWebClientCallbackOptions

Name	Type	Required	Default	Description
error	IBaseError | null	yes	-	If an error occured (defined as one of the errors), this will be defined. If a request was successful, this will be null.
id	string	yes	-	A unique identifier for the response message.
method	disable | discover | enable | post_transactions | sign_and_post_transactions | sign_transactions	yes	-	An enum that represents the method of the message.
result	IDisableResult | IDiscoverResult | IEnableResult | IPostTransactionsResult | ISignTransactionsResult | null	yes	-	If a request was successful, this will contain the details of the result, otherwise, if an error occurred, this will be null.

IAVMWebClientConfig

Name	Type	Required	Default	Description
debug	boolean	no	false	Outputs debug information to the console.

IAVMWebClientInitOptions

Name	Type	Required	Default	Description
debug	boolean	no	false	Outputs debug information to the console.

IAVMWebProviderCallbackOptions

Name	Type	Required	Default	Description
id	string	yes	-	A unique identifier for the request message.
method	disable | discover | enable | post_transactions | sign_and_post_transactions | sign_transactions	yes	-	An enum that represents the method of the message.
params	IDisableParams | IDiscoverParams | IEnableParams | IPostTransactionsParams | ISignTransactionsParams	no	-	Parameters that were sent by the request.

IAVMWebProviderConfig

Name	Type	Required	Default	Description
providerId	string	yes	-	The ID of the provider.
debug	boolean	no	false	Outputs debug information to the console.

IAVMWebProviderInitOptions

Name	Type	Required	Default	Description
debug	boolean	no	false	Outputs debug information to the console.

IBaseError

Name	Type	Required	Default	Description
code	number	yes	-	The code of the error. See the error codes for more information.
message	string	yes	-	A human-readable error message that can be displayed to a user.
providerId	string	no	-	The ID of the provider that threw the error.

note

This is the basic type for an error. For specific details on errors check out the errors.

IAccount

Name	Type	Required	Default	Description
address	string	yes	-	The address of the account.
name	string	no	-	A human-readable name for this account.

IDisableParams

Name	Type	Required	Default	Description
genesisHash	string	no	-	The unique identifier for the network that is the hash of the genesis block.
providerId	string	no	-	The ID of the provider.
sessionIds	string[]	no	-	A list of specific session IDs to remove.

IDisableResult

Name	Type	Required	Default	Description
genesisHash	string	yes	-	The unique identifier for the network that is the hash of the genesis block.
genesisId	string	yes	-	A human-readable identifier for the network.
providerId	string	yes	-	The ID of the provider.
sessionIds	string[]	no	-	A list of removed session IDs.

IDiscoverParams

Name	Type	Required	Default	Description
providerId	string	yes	-	The ID of the provider.

IDiscoverResult

Name	Type	Required	Default	Description
host	string	no	-	The domain name of the provider.
icon	string	no	-	A URI pointing to an image.
name	string	yes	-	A human-readable canonical name of the provider.
networks	INetworkConfiguration[]	yes	-	A list of networks available for the provider.
providerId	string	yes	-	The ID of the provider.

IEnableParams

Name	Type	Required	Default	Description
genesisHash	string	no	-	The unique identifier for the network that is the hash of the genesis block.
providerId	string	no	-	The ID of the provider.

IEnableResult

Name	Type	Required	Default	Description
accounts	IAccount[]	yes	-	A list of accounts authorized accounts on the provider.
genesisHash	string	yes	-	The unique identifier for the network that is the hash of the genesis block.
genesisId	string	yes	-	A human-readable identifier for the network.
providerId	string	yes	-	The ID of the provider.

INetworkConfiguration

Name	Type	Required	Default	Description
genesisHash	string	yes	-	The unique identifier for the network that is the hash of the genesis block.
genesisId	string	yes	-	A human-readable identifier for the network.
methods	string[]	yes	-	A list of methods available from the provider for the chain.

IPostTransactionsParams

Name	Type	Required	Default	Description
providerId	string	yes	-	The ID of the provider.
stxns	string[]	yes	-	A list of base64 encoded signed transactions.

IPostTransactionsResult

Name	Type	Required	Default	Description
providerId	string	yes	-	The ID of the provider.
txnIDs	string[]	yes	-	A list of 52-character base32 strings (without padding) corresponding the completed transaction IDs.

ISignMessageParams

Name	Type	Required	Default	Description
message	string	yes	-	A human-readable UTF-8 string to sign.
providerId	string	no	-	The ID of the provider.
signer	string	no	-	The address to be used to sign the message.

ISignMessageResult

Name	Type	Required	Default	Description
providerId	string	yes	-	The ID of the provider.
signature	string	yes	-	A base64 encoded signature of the message signed by the private key of the intended signer.
signer	string	yes	-	The address used to sign the message.

ISignTransactionsParams

Name	Type	Required	Default	Description
providerId	string	no	-	The ID of the provider.
txns	IARC0001Transaction[]	yes	-	A list of transactions to be signed by providers.

ISignTransactionsResult

Name	Type	Required	Default	Description
providerId	string	yes	-	The ID of the provider.
stxns	(string | null)[]	yes	-	The list of base64 encoded signed transactions that is ready to be posted to the network. If any of the transactions were not signed by the wallet, and no stxns were supplied, then null will be in the place of the signed transaction.