@iota/wallet-standard
Interfaces
| Interface | Description |
|---|---|
| IotaReportTransactionEffectsInput | Input for signing transactions. |
| IotaSignAndExecuteTransactionInput | Input for signing and sending transactions. |
| IotaSignAndExecuteTransactionOutput | Output of signing and sending transactions. |
| IotaSignPersonalMessageInput | Input for signing personal messages. |
| IotaSignPersonalMessageOutput | Output of signing personal messages. |
| SignedPersonalMessage | - |
| IotaSignTransactionInput | Input for signing transactions. |
| SignedTransaction | Output of signing transactions. |
| IotaSignTransactionOutput | Output of signing transactions. |
| GasData | Contains data related to the gas payment for a Transaction |
| SerializedTransactionDataV2 | Represent the serialized state of a partially built Transaction This format is designed to support transactions that have not been fully build allowing most properties to be omitted or set to null. It also supports unresolved object references, unresolved pure values, and Transaction Intents. |
| PureArg | - |
| UnresolvedPureArg | Represents an un-serialized pure value. The correct bcs schema will need to be determined before this value can be serialized to bcs |
| UnresolvedObjectArg | Represents an unresolved object reference. This allows objects to be referenced by only their ID. version and digest details may also be added to unresolved object references. To fully resolve a reference, the correct ObjectArg type needs to be determined based on the type of object, and how it used in the transaction (eg, is it used mutably if it's shared, and is it a receiving object if it's not shared) |
Type Aliases
| Type Alias | Description |
|---|---|
| IotaFeatures | Wallet Standard features that are unique to IOTA, and that all IOTA wallets are expected to implement. |
| IotaWalletFeatures | - |
| WalletWithIotaFeatures | - |
| WalletWithRequiredFeatures | Represents a wallet with the absolute minimum feature set required to function in the IOTA ecosystem. |
| MinimallyRequiredFeatures | - |
| IotaReportTransactionEffectsVersion | The latest API version of the reportTransactionEffects API. |
| IotaReportTransactionEffectsFeature | A Wallet Standard feature for reporting the effects of a transaction block executed by a dapp The feature allows wallets to updated their caches using the effects of the transaction executed outside of the wallet |
| IotaReportTransactionEffectsMethod | - |
| IotaSignAndExecuteTransactionVersion | The latest API version of the signAndExecuteTransaction API. |
| IotaSignAndExecuteTransactionFeature | A Wallet Standard feature for signing a transaction, and submitting it to the network. The wallet is expected to submit the transaction to the network via RPC, and return the transaction response. |
| IotaSignAndExecuteTransactionMethod | - |
| IotaSignPersonalMessageVersion | The latest API version of the signPersonalMessage API. |
| IotaSignPersonalMessageFeature | A Wallet Standard feature for signing a personal message, and returning the message bytes that were signed, and message signature. |
| IotaSignPersonalMessageMethod | - |
| IotaSignTransactionVersion | The latest API version of the signTransaction API. |
| IotaSignTransactionFeature | A Wallet Standard feature for signing a transaction, and returning the serialized transaction and transaction signature. |
| IotaSignTransactionMethod | - |
| CallArg | Represents an input to a Transaction, either as a fully resolved Object or Pure input or as an unresolved partial reference which needs to be resolved before the transaction can be serialized to bcs and executed. |
| ObjectArg | - |
| Argument | - |
| Command | - |
Variables
| Variable | Description |
|---|---|
| SUPPORTED_CHAINS | - |
| IotaReportTransactionEffects | Name of the feature. |
| IotaSignAndExecuteTransaction | Name of the feature. |
| IotaSignPersonalMessage | Name of the feature. |
| IotaSignTransaction | Name of the feature. |
Functions
| Function | Description |
|---|---|
| isSupportedChain | Utility that returns whether or not a chain identifier is a supported chain. |
| isWalletWithRequiredFeatureSet | - |
| signAndExecuteTransaction | - |
| signTransaction | - |
Connect
| Interface | Description |
|---|---|
| StandardConnectOutput | Output of the StandardConnectMethod. |
Wallet
| Interface | Description |
|---|---|
| Wallet | Interface of a Wallet, also referred to as a Standard Wallet. |