@iota/client
Table of contents
Classes
Enumerations
Functions
Type Aliases
Interfaces
- IBuildBlockOptions
- IClientBlockBuilderOutputAddress
- Burn
- IClientOptions
- IDuration
- IGenerateAddressesOptions
- IGenerateAddressOptions
- LedgerNanoStatus
- LedgerApp
- IAuth
- IMqttBrokerOptions
- INode
- INetworkInfo
- INodeInfoWrapper
- IAliasOutputBuilderOptions
- IBasicOutputBuilderOptions
- IFoundryOutputBuilderOptions
- INftOutputBuilderOptions
- OutputIdsResponse
- IPreparedTransactionData
- IInputSigningData
- IRange
- LedgerNanoSecretManager
- MnemonicSecretManager
- StrongholdSecretManager
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
Type Aliases
BlockId
Ƭ BlockId: string
A block identifier, the BLAKE2b-256 hash of the block bytes. See https://www.blake2.net/ for more information.
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
SecretManager
Ƭ SecretManager: LedgerNanoSecretManager | MnemonicSecretManager | StrongholdSecretManager
Supported secret managers