@iota/sdk
Table of contents
Enumerations
- OutputType
- CoinType
- LedgerDeviceType
- Network
- AddressType
- WalletEventType
- OutputsToClaim
- ReturnStrategy
- InclusionState
Classes
- Client
- ClientMethodHandler
- SecretManager
- SecretManagerMethodHandler
- Ed25519Address
- NftAddress
- SenderFeature
- IssuerFeature
- MetadataFeature
- TagFeature
- CommonOutput
- TreasuryOutput
- BasicOutput
- NftOutput
- FoundryOutput
- SimpleTokenScheme
- StorageDepositReturnUnlockCondition
- TimelockUnlockCondition
- StateControllerAddressUnlockCondition
- GovernorAddressUnlockCondition
- ImmutableAliasAddressUnlockCondition
- PreparedTransactionData
- Utils
- Account
- Wallet
Interfaces
- IBuildBlockOptions
- IClientBlockBuilderOutputAddress
- Burn
- IClientOptions
- IDuration
- IGenerateAddressesOptions
- IGenerateAddressOptions
- LedgerNanoStatus
- LedgerApp
- IAuth
- IMqttBrokerOptions
- INode
- INetworkInfo
- INodeInfoWrapper
- AliasOutputBuilderParams
- BasicOutputBuilderParams
- FoundryOutputBuilderParams
- NftOutputBuilderParams
- OutputIdsResponse
- IPreparedTransactionData
- IInputSigningData
- IRange
- LedgerNanoSecretManager
- MnemonicSecretManager
- SeedSecretManager
- StrongholdSecretManager
- Balance
- BaseCoinBalance
- RequiredStorageDeposit
- NativeTokenBalance
- SyncOptions
- AccountSyncOptions
- AliasSyncOptions
- NftSyncOptions
- AccountMeta
- AccountMetadata
- CreateAccountPayload
- FilterOptions
- AccountAddress
- SendAmountParams
- AddressWithUnspentOutputs
- SendNativeTokensParams
- SendNftParams
- GenerateAddressOptions
- BuildAliasOutputData
- BuildBasicOutputData
- BuildFoundryOutputData
- BuildNftOutputData
- OutputData
- Segment
- OutputParams
- Assets
- Features
- Unlocks
- StorageDeposit
- PreparedCreateNativeTokenTransaction
- MintTokenTransaction
- SignedTransactionEssence
- Transaction
- TransactionOptions
- CreateNativeTokenParams
- MintNftParams
- AliasOutputParams
- WalletOptions
Type Aliases
- BlockId
- IBip32Chain
- QueryParameter
- AliasQueryParameter
- FoundryQueryParameter
- NftQueryParameter
- PlaceholderSecretManager
- SecretManagerType
- AccountId
- RemainderValueStrategy
- ChangeAddress
- ReuseAddress
- CustomAddress
Functions
Type Aliases
BlockId
Ƭ BlockId: string
A block identifier, the BLAKE2b-256 hash of the block bytes. See https://www.blake2.net/ for more information.
IBip32Chain
Ƭ IBip32Chain: number[]
BIP 32 chain.
QueryParameter
Ƭ QueryParameter: Address | AliasAddress | HasStorageDepositReturn | StorageDepositReturnAddress | HasTimelock | TimelockedBefore | TimelockedAfter | HasExpiration | ExpiresBefore | ExpiresAfter | ExpirationReturnAddress | Sender | Tag | Issuer | StateController | Governor | CommonQueryParameters
Query parameter for filtering output requests
AliasQueryParameter
Ƭ AliasQueryParameter: StateController | Governor | Issuer | Sender | CommonQueryParameters
Query parameters for filtering Alias Outputs
FoundryQueryParameter
Ƭ FoundryQueryParameter: AliasAddress | CommonQueryParameters
Query parameters for filtering Foundry Outputs
NftQueryParameter
Ƭ NftQueryParameter: Address | AliasAddress | HasStorageDepositReturn | StorageDepositReturnAddress | HasTimelock | TimelockedBefore | TimelockedAfter | HasExpiration | ExpiresBefore | ExpiresAfter | ExpirationReturnAddress | Sender | Tag | CommonQueryParameters
Query parameters for filtering Nft Outputs
PlaceholderSecretManager
Ƭ PlaceholderSecretManager: "placeholder"
Placeholder secret manager that can't do anything.
SecretManagerType
Ƭ SecretManagerType: LedgerNanoSecretManager | MnemonicSecretManager | StrongholdSecretManager | PlaceholderSecretManager
Supported secret managers
AccountId
Ƭ AccountId: number | string
Account identifier Could be the account index (number) or account alias (string)
RemainderValueStrategy
Ƭ RemainderValueStrategy: ChangeAddress | ReuseAddress | CustomAddress
The RemainderValueStrategy
ChangeAddress
Ƭ ChangeAddress: Object
ChangeAddress variant of RemainderValueStrategy
Type declaration
| Name | Type |
|---|---|
strategy | "ChangeAddress" |
value | null |
ReuseAddress
Ƭ ReuseAddress: Object
ReuseAddress variant of RemainderValueStrategy
Type declaration
| Name | Type |
|---|---|
strategy | "ReuseAddress" |
value | null |
CustomAddress
Ƭ CustomAddress: Object
CustomAddress variant of RemainderValueStrategy
Type declaration
| Name | Type |
|---|---|
strategy | "CustomAddress" |
value | string |
Functions
initLogger
▸ initLogger(config?): any
Initialize logger, if no arguments are provided a default config will be used.
Parameters
| Name | Type | Default value |
|---|---|---|
config | ILoggerConfig | defaultLoggerConfig |
Returns
any
utf8ToBytes
▸ utf8ToBytes(utf8): number[]
Convert UTF8 string to an array of bytes
Parameters
| Name | Type |
|---|---|
utf8 | string |
Returns
number[]
hexToUtf8
▸ hexToUtf8(hex): string
Convert hex encoded string to UTF8 string
Parameters
| Name | Type |
|---|---|
hex | string |
Returns
string
utf8ToHex
▸ utf8ToHex(utf8): string
Convert UTF8 string to hex encoded string
Parameters
| Name | Type |
|---|---|
utf8 | string |
Returns
string