@iota/iota.js
Table of contents
Classes
- Ed25519Address
- ClientError
- IndexerPluginClient
- SingleNodeClient
- B1T6
- LocalPowProvider
- Ed25519Seed
- Bech32Helper
- PowHelper
- TransactionHelper
- UnitsHelper
Variables
- MIN_ADDRESS_LENGTH
- ALIAS_ID_LENGTH
- MIN_ALIAS_ADDRESS_LENGTH
- MIN_ED25519_ADDRESS_LENGTH
- NFT_ID_LENGTH
- MIN_NFT_ADDRESS_LENGTH
- MAX_BLOCK_LENGTH
- MAX_NUMBER_PARENTS
- MIN_NUMBER_PARENTS
- UINT8_SIZE
- UINT16_SIZE
- UINT32_SIZE
- UINT64_SIZE
- UINT256_SIZE
- BLOCK_ID_LENGTH
- TRANSACTION_ID_LENGTH
- MERKLE_PROOF_LENGTH
- TYPE_LENGTH
- SMALL_TYPE_LENGTH
- STRING_LENGTH
- ARRAY_LENGTH
- MIN_FEATURES_LENGTH
- MIN_FEATURE_LENGTH
- MIN_ISSUER_FEATURE_LENGTH
- MIN_METADATA_FEATURE_LENGTH
- MIN_SENDER_FEATURE_LENGTH
- MIN_TAG_FEATURE_LENGTH
- TAIL_HASH_LENGTH
- MIN_MIGRATED_FUNDS_LENGTH
- MAX_FUNDS_COUNT
- MIN_INPUT_LENGTH
- MIN_INPUT_COUNT
- MAX_INPUT_COUNT
- MIN_TREASURY_INPUT_LENGTH
- MIN_UTXO_INPUT_LENGTH
- MIN_MILESTONE_OPTION_LENGTH
- MIN_PROTOCOL_PARAMS_MILESTONE_OPTION_LENGTH
- MIN_RECEIPT_MILESTONE_OPTION_LENGTH
- MIN_ALIAS_OUTPUT_LENGTH
- MIN_BASIC_OUTPUT_LENGTH
- MIN_FOUNDRY_OUTPUT_LENGTH
- MIN_NFT_OUTPUT_LENGTH
- MIN_OUTPUT_LENGTH
- MIN_OUTPUT_COUNT
- MAX_OUTPUT_COUNT
- MIN_TREASURY_OUTPUT_LENGTH
- MIN_MILESTONE_PAYLOAD_LENGTH
- MIN_PAYLOAD_LENGTH
- MIN_TAGGED_DATA_PAYLOAD_LENGTH
- MAX_TAG_LENGTH
- MIN_TRANSACTION_PAYLOAD_LENGTH
- MIN_TREASURY_TRANSACTION_PAYLOAD_LENGTH
- MIN_ED25519_SIGNATURE_LENGTH
- MIN_SIGNATURE_LENGTH
- MIN_SIMPLE_TOKEN_SCHEME_LENGTH
- MIN_TOKEN_SCHEME_LENGTH
- MIN_TRANSACTION_ESSENCE_LENGTH
- MIN_ADDRESS_UNLOCK_CONDITION_LENGTH
- MIN_EXPIRATION_UNLOCK_CONDITION_LENGTH
- MIN_GOVERNOR_ADDRESS_UNLOCK_CONDITION_LENGTH
- MIN_IMMUTABLE_ALIAS_UNLOCK_CONDITION_LENGTH
- MIN_STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_LENGTH
- MIN_STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_LENGTH
- MIN_TIMELOCK_UNLOCK_CONDITION_LENGTH
- MIN_UNLOCK_CONDITIONS_LENGTH
- MIN_UNLOCK_CONDITION_LENGTH
- MIN_ALIAS_UNLOCK_LENGTH
- MIN_NFT_UNLOCK_LENGTH
- MIN_REFERENCE_UNLOCK_LENGTH
- MIN_SIGNATURE_UNLOCK_LENGTH
- MIN_UNLOCK_LENGTH
- DEFAULT_PROTOCOL_VERSION
- TRANSACTION_ESSENCE_TYPE
- INPUTS_COMMITMENT_SIZE
- ALIAS_ADDRESS_TYPE
- ED25519_ADDRESS_TYPE
- NFT_ADDRESS_TYPE
- ISSUER_FEATURE_TYPE
- METADATA_FEATURE_TYPE
- SENDER_FEATURE_TYPE
- TAG_FEATURE_TYPE
- TREASURY_INPUT_TYPE
- UTXO_INPUT_TYPE
- PROTOCOL_PARAMETERS_MILESTONE_OPTION_TYPE
- RECEIPT_MILESTONE_OPTION_TYPE
- ALIAS_OUTPUT_TYPE
- BASIC_OUTPUT_TYPE
- FOUNDRY_OUTPUT_TYPE
- NFT_OUTPUT_TYPE
- TREASURY_OUTPUT_TYPE
- MILESTONE_PAYLOAD_TYPE
- TAGGED_DATA_PAYLOAD_TYPE
- TRANSACTION_PAYLOAD_TYPE
- TREASURY_TRANSACTION_PAYLOAD_TYPE
- ED25519_SIGNATURE_TYPE
- SIMPLE_TOKEN_SCHEME_TYPE
- ADDRESS_UNLOCK_CONDITION_TYPE
- EXPIRATION_UNLOCK_CONDITION_TYPE
- GOVERNOR_ADDRESS_UNLOCK_CONDITION_TYPE
- IMMUTABLE_ALIAS_UNLOCK_CONDITION_TYPE
- STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_TYPE
- STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_TYPE
- TIMELOCK_UNLOCK_CONDITION_TYPE
- ALIAS_UNLOCK_TYPE
- NFT_UNLOCK_TYPE
- REFERENCE_UNLOCK_TYPE
- SIGNATURE_UNLOCK_TYPE
- CONFLICT_REASON_STRINGS
- ED25519_SEED_TYPE
Functions
- deserializeAddress
- serializeAddress
- deserializeAliasAddress
- serializeAliasAddress
- deserializeEd25519Address
- serializeEd25519Address
- deserializeNftAddress
- serializeNftAddress
- deserializeBlock
- serializeBlock
- deserializeFeatures
- serializeFeatures
- deserializeFeature
- serializeFeature
- deserializeIssuerFeature
- serializeIssuerFeature
- deserializeMetadataFeature
- serializeMetadataFeature
- deserializeSenderFeature
- serializeSenderFeature
- deserializeTagFeature
- serializeTagFeature
- deserializeFunds
- serializeFunds
- deserializeMigratedFunds
- serializeMigratedFunds
- deserializeInputs
- serializeInputs
- deserializeInput
- serializeInput
- deserializeTreasuryInput
- serializeTreasuryInput
- deserializeUTXOInput
- serializeUTXOInput
- deserializeMilestoneOptions
- serializeMilestoneOptions
- deserializeMilestoneOption
- serializeMilestoneOption
- deserializeProtocolParamsMilestoneOption
- serializeProtocolParamsMilestoneOption
- deserializeReceiptMilestoneOption
- serializeReceiptMilestoneOption
- deserializeAliasOutput
- serializeAliasOutput
- deserializeBasicOutput
- serializeBasicOutput
- deserializeFoundryOutput
- serializeFoundryOutput
- deserializeNftOutput
- serializeNftOutput
- deserializeOutputs
- serializeOutputs
- deserializeOutput
- serializeOutput
- deserializeTreasuryOutput
- serializeTreasuryOutput
- deserializeMilestonePayload
- serializeMilestonePayload
- serializeMilestoneEssence
- deserializePayload
- serializePayload
- deserializeTaggedDataPayload
- serializeTaggedDataPayload
- deserializeTransactionPayload
- serializeTransactionPayload
- deserializeTreasuryTransactionPayload
- serializeTreasuryTransactionPayload
- deserializeEd25519Signature
- serializeEd25519Signature
- deserializeSignature
- serializeSignature
- deserializeSimpleTokenScheme
- serializeSimpleTokenScheme
- deserializeTokenScheme
- serializeTokenScheme
- deserializeTransactionEssence
- serializeTransactionEssence
- deserializeAddressUnlockCondition
- serializeAddressUnlockCondition
- deserializeExpirationUnlockCondition
- serializeExpirationUnlockCondition
- deserializeGovernorAddressUnlockCondition
- serializeGovernorAddressUnlockCondition
- deserializeImmutableAliasUnlockCondition
- serializeImmutableAliasUnlockCondition
- deserializeStateControllerAddressUnlockCondition
- serializeStateControllerAddressUnlockCondition
- deserializeStorageDepositReturnUnlockCondition
- serializeStorageDepositReturnUnlockCondition
- deserializeTimelockUnlockCondition
- serializeTimelockUnlockCondition
- deserializeUnlockConditions
- serializeUnlockConditions
- deserializeUnlockCondition
- serializeUnlockCondition
- deserializeAliasUnlock
- serializeAliasUnlock
- deserializeNftUnlock
- serializeNftUnlock
- deserializeReferenceUnlock
- serializeReferenceUnlock
- deserializeSignatureUnlock
- serializeSignatureUnlock
- deserializeUnlocks
- serializeUnlocks
- deserializeUnlock
- serializeUnlock
- addressBalance
- generateBip44Path
- generateBip44Address
- getBalance
- getUnspentAddress
- getUnspentAddresses
- getUnspentAddressesWithAddressGenerator
- promote
- reattach
- retrieveData
- retry
- send
- sendEd25519
- sendMultiple
- sendMultipleEd25519
- sendWithAddressGenerator
- calculateInputs
- sendAdvanced
- buildTransactionPayload
- sendData
- setLogger
- logRoutes
- logInfo
- logTips
- logBlock
- logBlockMetadata
- logPayload
- logTransactionPayload
- logTaggedDataPayload
- logMilestonePayload
- logMilestoneOptions
- logMilestoneOption
- logReceiptMilestoneOption
- logProtocolParamsMilestoneOption
- logTreasuryTransactionPayload
- logAddress
- logSignature
- logInput
- logOutput
- logUnlock
- logFunds
- logNativeTokens
- logTokenScheme
- logFeatures
- logImmutableFeatures
- logFeature
- logUnlockConditions
- logUnlockCondition
- milestoneIdFromMilestonePayload
- blockIdFromMilestonePayload
Interfaces
- SingleNodeClientOptions
- IAddress
- IBip44GeneratorState
- IBlock
- IBlockMetadata
- IClient
- IGossipHeartbeat
- IGossipMetrics
- IKeyPair
- IMigratedFunds
- INativeToken
- IPeer
- IPowProvider
- IRent
- ISeed
- ITransactionEssence
- ITreasury
- ITypeBase
- IAliasAddress
- IEd25519Address
- INftAddress
- IBlockIdResponse
- IMilestoneUtxoChangesResponse
- IOutputMetadataResponse
- IOutputResponse
- IReceiptsResponse
- IResponse
- ITipsResponse
- IOutputsResponse
- IIssuerFeature
- IMetadataFeature
- ISenderFeature
- ITagFeature
- INodeInfo
- INodeInfoBaseToken
- INodeInfoMetrics
- INodeInfoMilestone
- INodeInfoProtocol
- INodeInfoProtocolParamsMilestoneOpt
- INodeInfoStatus
- IRoutesResponse
- ITreasuryInput
- IUTXOInput
- IProtocolParamsMilestoneOption
- IReceiptMilestoneOption
- IAliasOutput
- IBasicOutput
- ICommonOutput
- IFoundryOutput
- INftOutput
- ITreasuryOutput
- IMilestonePayload
- ITaggedDataPayload
- ITransactionPayload
- ITreasuryTransactionPayload
- IEd25519Signature
- ISimpleTokenScheme
- IAddressUnlockCondition
- IExpirationUnlockCondition
- IGovernorAddressUnlockCondition
- IImmutableAliasUnlockCondition
- IStateControllerAddressUnlockCondition
- IStorageDepositReturnUnlockCondition
- ITimelockUnlockCondition
- IAliasUnlock
- INftUnlock
- IReferenceUnlock
- ISignatureUnlock
Type Aliases
- AddressTypes
- FeatureTypes
- InputTypes
- LedgerInclusionState
- Magnitudes
- MilestoneOptionTypes
- OutputTypes
- PayloadTypes
- SignatureTypes
- TokenSchemeTypes
- UnlockConditionTypes
- UnlockTypes
Enumerations
Variables
MIN_ADDRESS_LENGTH
• Const
MIN_ADDRESS_LENGTH: number
The minimum length of an address binary representation.
ALIAS_ID_LENGTH
• Const
ALIAS_ID_LENGTH: number
= 32
The length of an alias id.
MIN_ALIAS_ADDRESS_LENGTH
• Const
MIN_ALIAS_ADDRESS_LENGTH: number
The minimum length of an alias address binary representation.
MIN_ED25519_ADDRESS_LENGTH
• Const
MIN_ED25519_ADDRESS_LENGTH: number
The minimum length of an ed25519 address binary representation.
NFT_ID_LENGTH
• Const
NFT_ID_LENGTH: number
= 32
The length of an NFT Id.
MIN_NFT_ADDRESS_LENGTH
• Const
MIN_NFT_ADDRESS_LENGTH: number
The minimum length of an nft address binary representation.
MAX_BLOCK_LENGTH
• Const
MAX_BLOCK_LENGTH: number
= 32768
The maximum length of a block.
MAX_NUMBER_PARENTS
• Const
MAX_NUMBER_PARENTS: number
= 8
The maximum number of parents.
MIN_NUMBER_PARENTS
• Const
MIN_NUMBER_PARENTS: number
= 1
The minimum number of parents.
UINT8_SIZE
• Const
UINT8_SIZE: number
= 1
Byte length for a uint8 field.
UINT16_SIZE
• Const
UINT16_SIZE: number
= 2
Byte length for a uint16 field.
UINT32_SIZE
• Const
UINT32_SIZE: number
= 4
Byte length for a uint32 field.
UINT64_SIZE
• Const
UINT64_SIZE: number
= 8
Byte length for a uint64 field.
UINT256_SIZE
• Const
UINT256_SIZE: number
= 32
Byte length for a uint256 field.
BLOCK_ID_LENGTH
• Const
BLOCK_ID_LENGTH: number
= Blake2b.SIZE_256
Byte length for a block id.
TRANSACTION_ID_LENGTH
• Const
TRANSACTION_ID_LENGTH: number
= Blake2b.SIZE_256
Byte length for a transaction id.
MERKLE_PROOF_LENGTH
• Const
MERKLE_PROOF_LENGTH: number
= Blake2b.SIZE_256
Byte length for a merkle prrof.
TYPE_LENGTH
• Const
TYPE_LENGTH: number
= UINT32_SIZE
Byte length for a type length.
SMALL_TYPE_LENGTH
• Const
SMALL_TYPE_LENGTH: number
= UINT8_SIZE
Byte length for a small type length.
STRING_LENGTH
• Const
STRING_LENGTH: number
= UINT16_SIZE
Byte length for a string length.
ARRAY_LENGTH
• Const
ARRAY_LENGTH: number
= UINT16_SIZE
Byte length for an array length.
MIN_FEATURES_LENGTH
• Const
MIN_FEATURES_LENGTH: number
= UINT8_SIZE
The minimum length of a featurs tokens list.
MIN_FEATURE_LENGTH
• Const
MIN_FEATURE_LENGTH: number
The minimum length of a feature binary representation.
MIN_ISSUER_FEATURE_LENGTH
• Const
MIN_ISSUER_FEATURE_LENGTH: number
The minimum length of a issuer feature binary representation.
MIN_METADATA_FEATURE_LENGTH
• Const
MIN_METADATA_FEATURE_LENGTH: number
The minimum length of a metadata feature block binary representation.
MIN_SENDER_FEATURE_LENGTH
• Const
MIN_SENDER_FEATURE_LENGTH: number
The minimum length of a sender feature binary representation.
MIN_TAG_FEATURE_LENGTH
• Const
MIN_TAG_FEATURE_LENGTH: number
The minimum length of a tag feature binary representation.
TAIL_HASH_LENGTH
• Const
TAIL_HASH_LENGTH: number
= 49
The length of the tail hash length in bytes.
MIN_MIGRATED_FUNDS_LENGTH
• Const
MIN_MIGRATED_FUNDS_LENGTH: number
The minimum length of a migrated fund binary representation.
MAX_FUNDS_COUNT
• Const
MAX_FUNDS_COUNT: number
= 127
The maximum number of funds.
MIN_INPUT_LENGTH
• Const
MIN_INPUT_LENGTH: number
The minimum length of an input binary representation.
MIN_INPUT_COUNT
• Const
MIN_INPUT_COUNT: number
= 1
The minimum number of inputs.
MAX_INPUT_COUNT
• Const
MAX_INPUT_COUNT: number
= 128
The maximum number of inputs.
MIN_TREASURY_INPUT_LENGTH
• Const
MIN_TREASURY_INPUT_LENGTH: number
The minimum length of a treasury input binary representation.
MIN_UTXO_INPUT_LENGTH
• Const
MIN_UTXO_INPUT_LENGTH: number
The minimum length of a utxo input binary representation.
MIN_MILESTONE_OPTION_LENGTH
• Const
MIN_MILESTONE_OPTION_LENGTH: number
The minimum length of a milestone option binary representation.
MIN_PROTOCOL_PARAMS_MILESTONE_OPTION_LENGTH
• Const
MIN_PROTOCOL_PARAMS_MILESTONE_OPTION_LENGTH: number
The minimum length of a protocol params milestone option binary representation.
MIN_RECEIPT_MILESTONE_OPTION_LENGTH
• Const
MIN_RECEIPT_MILESTONE_OPTION_LENGTH: number
The minimum length of a receipt milestone option binary representation.
MIN_ALIAS_OUTPUT_LENGTH
• Const
MIN_ALIAS_OUTPUT_LENGTH: number
The minimum length of a alias output binary representation.
MIN_BASIC_OUTPUT_LENGTH
• Const
MIN_BASIC_OUTPUT_LENGTH: number
The minimum length of a basic output binary representation.
MIN_FOUNDRY_OUTPUT_LENGTH
• Const
MIN_FOUNDRY_OUTPUT_LENGTH: number
The minimum length of a foundry output binary representation.
MIN_NFT_OUTPUT_LENGTH
• Const
MIN_NFT_OUTPUT_LENGTH: number
The minimum length of a nft output binary representation.
MIN_OUTPUT_LENGTH
• Const
MIN_OUTPUT_LENGTH: number
The minimum length of an output binary representation.
MIN_OUTPUT_COUNT
• Const
MIN_OUTPUT_COUNT: number
= 1
The minimum number of outputs.
MAX_OUTPUT_COUNT
• Const
MAX_OUTPUT_COUNT: number
= 128
The maximum number of outputs.
MIN_TREASURY_OUTPUT_LENGTH
• Const
MIN_TREASURY_OUTPUT_LENGTH: number
The minimum length of a treasury output binary representation.
MIN_MILESTONE_PAYLOAD_LENGTH
• Const
MIN_MILESTONE_PAYLOAD_LENGTH: number
The minimum length of a milestone payload binary representation.
MIN_PAYLOAD_LENGTH
• Const
MIN_PAYLOAD_LENGTH: number
The minimum length of a payload binary representation.
MIN_TAGGED_DATA_PAYLOAD_LENGTH
• Const
MIN_TAGGED_DATA_PAYLOAD_LENGTH: number
The minimum length of a tagged data payload binary representation.
MAX_TAG_LENGTH
• Const
MAX_TAG_LENGTH: number
= 64
The maximum length of a tag.
MIN_TRANSACTION_PAYLOAD_LENGTH
• Const
MIN_TRANSACTION_PAYLOAD_LENGTH: number
The minimum length of a transaction payload binary representation.
MIN_TREASURY_TRANSACTION_PAYLOAD_LENGTH
• Const
MIN_TREASURY_TRANSACTION_PAYLOAD_LENGTH: number
The minimum length of a treasury transaction payload binary representation.
MIN_ED25519_SIGNATURE_LENGTH
• Const
MIN_ED25519_SIGNATURE_LENGTH: number
The minimum length of an ed25519 signature binary representation.
MIN_SIGNATURE_LENGTH
• Const
MIN_SIGNATURE_LENGTH: number
= MIN_ED25519_SIGNATURE_LENGTH
The minimum length of a signature binary representation.
MIN_SIMPLE_TOKEN_SCHEME_LENGTH
• Const
MIN_SIMPLE_TOKEN_SCHEME_LENGTH: number
The minimum length of an simple token scheme binary representation.
MIN_TOKEN_SCHEME_LENGTH
• Const
MIN_TOKEN_SCHEME_LENGTH: number
= MIN_SIMPLE_TOKEN_SCHEME_LENGTH
The minimum length of a simple token scheme binary representation.
MIN_TRANSACTION_ESSENCE_LENGTH
• Const
MIN_TRANSACTION_ESSENCE_LENGTH: number
The minimum length of a transaction essence binary representation.
MIN_ADDRESS_UNLOCK_CONDITION_LENGTH
• Const
MIN_ADDRESS_UNLOCK_CONDITION_LENGTH: number
The minimum length of an address unlock condition binary representation.
MIN_EXPIRATION_UNLOCK_CONDITION_LENGTH
• Const
MIN_EXPIRATION_UNLOCK_CONDITION_LENGTH: number
The minimum length of an expiration unlock condition binary representation.
MIN_GOVERNOR_ADDRESS_UNLOCK_CONDITION_LENGTH
• Const
MIN_GOVERNOR_ADDRESS_UNLOCK_CONDITION_LENGTH: number
The minimum length of an governor unlock condition binary representation.
MIN_IMMUTABLE_ALIAS_UNLOCK_CONDITION_LENGTH
• Const
MIN_IMMUTABLE_ALIAS_UNLOCK_CONDITION_LENGTH: number
The minimum length of an immutable alias unlock condition binary representation.
MIN_STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_LENGTH
• Const
MIN_STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_LENGTH: number
The minimum length of an state controller address unlock condition binary representation.
MIN_STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_LENGTH
• Const
MIN_STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_LENGTH: number
The minimum length of an storage deposit return unlock condition binary representation.
MIN_TIMELOCK_UNLOCK_CONDITION_LENGTH
• Const
MIN_TIMELOCK_UNLOCK_CONDITION_LENGTH: number
The minimum length of an timelock unlock condition binary representation.
MIN_UNLOCK_CONDITIONS_LENGTH
• Const
MIN_UNLOCK_CONDITIONS_LENGTH: number
= UINT8_SIZE
The minimum length of a unlock conditions list.
MIN_UNLOCK_CONDITION_LENGTH
• Const
MIN_UNLOCK_CONDITION_LENGTH: number
The minimum length of a unlock conditions binary representation.
MIN_ALIAS_UNLOCK_LENGTH
• Const
MIN_ALIAS_UNLOCK_LENGTH: number
The minimum length of a alias unlock binary representation.
MIN_NFT_UNLOCK_LENGTH
• Const
MIN_NFT_UNLOCK_LENGTH: number
The minimum length of a nft unlock binary representation.
MIN_REFERENCE_UNLOCK_LENGTH
• Const
MIN_REFERENCE_UNLOCK_LENGTH: number
The minimum length of a reference unlock binary representation.
MIN_SIGNATURE_UNLOCK_LENGTH
• Const
MIN_SIGNATURE_UNLOCK_LENGTH: number
The minimum length of a signature unlock binary representation.
MIN_UNLOCK_LENGTH
• Const
MIN_UNLOCK_LENGTH: number
The minimum length of an unlock binary representation.
DEFAULT_PROTOCOL_VERSION
• Const
DEFAULT_PROTOCOL_VERSION: number
= 2
The default protocol version.
TRANSACTION_ESSENCE_TYPE
• Const
TRANSACTION_ESSENCE_TYPE: 1
The global type for the transaction essence.
INPUTS_COMMITMENT_SIZE
• Const
INPUTS_COMMITMENT_SIZE: number
= Blake2b.SIZE_256
Inputs commitment size.
ALIAS_ADDRESS_TYPE
• Const
ALIAS_ADDRESS_TYPE: 8
The global type for the alias address type.
ED25519_ADDRESS_TYPE
• Const
ED25519_ADDRESS_TYPE: 0
The global type for the ed25519 address type.
NFT_ADDRESS_TYPE
• Const
NFT_ADDRESS_TYPE: 16
The global type for the NFT address type.
ISSUER_FEATURE_TYPE
• Const
ISSUER_FEATURE_TYPE: 1
The global type for the issuer feature.
METADATA_FEATURE_TYPE
• Const
METADATA_FEATURE_TYPE: 2
The global type for the metadata feature.
SENDER_FEATURE_TYPE
• Const
SENDER_FEATURE_TYPE: 0
The global type for the sender feature.
TAG_FEATURE_TYPE
• Const
TAG_FEATURE_TYPE: 3
The global type for the tag feature.
TREASURY_INPUT_TYPE
• Const
TREASURY_INPUT_TYPE: 1
The global type for the treasury input.
UTXO_INPUT_TYPE
• Const
UTXO_INPUT_TYPE: 0
The global type for the input.
PROTOCOL_PARAMETERS_MILESTONE_OPTION_TYPE
• Const
PROTOCOL_PARAMETERS_MILESTONE_OPTION_TYPE: 1
The global type for the option.
RECEIPT_MILESTONE_OPTION_TYPE
• Const
RECEIPT_MILESTONE_OPTION_TYPE: 0
The global type for the option.
ALIAS_OUTPUT_TYPE
• Const
ALIAS_OUTPUT_TYPE: 4
The global type for the alias output.
BASIC_OUTPUT_TYPE
• Const
BASIC_OUTPUT_TYPE: 3
The global type for the basic output.
FOUNDRY_OUTPUT_TYPE
• Const
FOUNDRY_OUTPUT_TYPE: 5
The global type for the foundry output.
NFT_OUTPUT_TYPE
• Const
NFT_OUTPUT_TYPE: 6
The global type for the NFT output.
TREASURY_OUTPUT_TYPE
• Const
TREASURY_OUTPUT_TYPE: 2
The global type for the treasury output.
MILESTONE_PAYLOAD_TYPE
• Const
MILESTONE_PAYLOAD_TYPE: 7
The global type for the payload.
TAGGED_DATA_PAYLOAD_TYPE
• Const
TAGGED_DATA_PAYLOAD_TYPE: 5
The global type for the payload.
TRANSACTION_PAYLOAD_TYPE
• Const
TRANSACTION_PAYLOAD_TYPE: 6
The global type for the payload.
TREASURY_TRANSACTION_PAYLOAD_TYPE
• Const
TREASURY_TRANSACTION_PAYLOAD_TYPE: 4
The global type for the payload.
ED25519_SIGNATURE_TYPE
• Const
ED25519_SIGNATURE_TYPE: 0
The global type for the signature type.
SIMPLE_TOKEN_SCHEME_TYPE
• Const
SIMPLE_TOKEN_SCHEME_TYPE: 0
The global type for the simple token scheme.
ADDRESS_UNLOCK_CONDITION_TYPE
• Const
ADDRESS_UNLOCK_CONDITION_TYPE: 0
The global type for the address unlock condition.
EXPIRATION_UNLOCK_CONDITION_TYPE
• Const
EXPIRATION_UNLOCK_CONDITION_TYPE: 3
The global type for the expiration unlock condition.
GOVERNOR_ADDRESS_UNLOCK_CONDITION_TYPE
• Const
GOVERNOR_ADDRESS_UNLOCK_CONDITION_TYPE: 5
The global type for the governor address unlock condition.
IMMUTABLE_ALIAS_UNLOCK_CONDITION_TYPE
• Const
IMMUTABLE_ALIAS_UNLOCK_CONDITION_TYPE: 6
The global type for the immutable alias unlock condition.
STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_TYPE
• Const
STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_TYPE: 4
The global type for the state controller unlock condition.
STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_TYPE
• Const
STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_TYPE: 1
The global type for the storage deposit return unlock condition.
TIMELOCK_UNLOCK_CONDITION_TYPE
• Const
TIMELOCK_UNLOCK_CONDITION_TYPE: 2
The global type for the timelock unlock condition.
ALIAS_UNLOCK_TYPE
• Const
ALIAS_UNLOCK_TYPE: 2
The global type for the alias unlock.
NFT_UNLOCK_TYPE
• Const
NFT_UNLOCK_TYPE: 3
The global type for the NFT unlock.
REFERENCE_UNLOCK_TYPE
• Const
REFERENCE_UNLOCK_TYPE: 1
The global type for the reference unlock.
SIGNATURE_UNLOCK_TYPE
• Const
SIGNATURE_UNLOCK_TYPE: 0
The global type for the unlock.
CONFLICT_REASON_STRINGS
• Const
CONFLICT_REASON_STRINGS: { [key in ConflictReason]: string }
Conflict reason strings.
ED25519_SEED_TYPE
• Const
ED25519_SEED_TYPE: number
= 1
The global type for the seed.
Functions
deserializeAddress
▸ deserializeAddress(readStream
): AddressTypes
Deserialize the address from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeAddress
▸ serializeAddress(writeStream
, object
): void
Serialize the address to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITypeBase <number > | The object to serialize. |
Returns
void
deserializeAliasAddress
▸ deserializeAliasAddress(readStream
): IAliasAddress
Deserialize the alias address from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeAliasAddress
▸ serializeAliasAddress(writeStream
, object
): void
Serialize the alias address to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IAliasAddress | The object to serialize. |
Returns
void
deserializeEd25519Address
▸ deserializeEd25519Address(readStream
): IEd25519Address
Deserialize the Ed25519 address from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeEd25519Address
▸ serializeEd25519Address(writeStream
, object
): void
Serialize the ed25519 address to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IEd25519Address | The object to serialize. |
Returns
void
deserializeNftAddress
▸ deserializeNftAddress(readStream
): INftAddress
Deserialize the nft address from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeNftAddress
▸ serializeNftAddress(writeStream
, object
): void
Serialize the nft address to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | INftAddress | The object to serialize. |
Returns
void
deserializeBlock
▸ deserializeBlock(readStream
): IBlock
Deserialize the block from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The block to deserialize. |
Returns
The deserialized block.
serializeBlock
▸ serializeBlock(writeStream
, object
): void
Serialize the block essence to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IBlock | The object to serialize. |
Returns
void
deserializeFeatures
▸ deserializeFeatures(readStream
): FeatureTypes
[] | undefined
Deserialize the feature from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
FeatureTypes
[] | undefined
The deserialized object.
serializeFeatures
▸ serializeFeatures(writeStream
, objects
): void
Serialize the feature to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
objects | undefined | FeatureTypes [] | The objects to serialize. |
Returns
void
deserializeFeature
▸ deserializeFeature(readStream
): FeatureTypes
Deserialize the feature from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeFeature
▸ serializeFeature(writeStream
, object
): void
Serialize the feature to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITypeBase <number > | The object to serialize. |
Returns
void
deserializeIssuerFeature
▸ deserializeIssuerFeature(readStream
): IIssuerFeature
Deserialize the issuer feature from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeIssuerFeature
▸ serializeIssuerFeature(writeStream
, object
): void
Serialize the issuer feature to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IIssuerFeature | The object to serialize. |
Returns
void
deserializeMetadataFeature
▸ deserializeMetadataFeature(readStream
): IMetadataFeature
Deserialize the metadata feature block from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeMetadataFeature
▸ serializeMetadataFeature(writeStream
, object
): void
Serialize the metadata feature to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IMetadataFeature | The object to serialize. |
Returns
void
deserializeSenderFeature
▸ deserializeSenderFeature(readStream
): ISenderFeature
Deserialize the sender feature from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeSenderFeature
▸ serializeSenderFeature(writeStream
, object
): void
Serialize the sender feature to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ISenderFeature | The object to serialize. |
Returns
void
deserializeTagFeature
▸ deserializeTagFeature(readStream
): ITagFeature
Deserialize the tag feature from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeTagFeature
▸ serializeTagFeature(writeStream
, object
): void
Serialize the tag feature to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITagFeature | The object to serialize. |
Returns
void
deserializeFunds
▸ deserializeFunds(readStream
): IMigratedFunds
[]
Deserialize the receipt payload funds from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeFunds
▸ serializeFunds(writeStream
, objects
): void
Serialize the receipt payload funds to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
objects | IMigratedFunds [] | The objects to serialize. |
Returns
void
deserializeMigratedFunds
▸ deserializeMigratedFunds(readStream
): IMigratedFunds
Deserialize the migrated fund from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeMigratedFunds
▸ serializeMigratedFunds(writeStream
, object
): void
Serialize the migrated funds to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IMigratedFunds | The object to serialize. |
Returns
void
deserializeInputs
▸ deserializeInputs(readStream
): InputTypes
[]
Deserialize the inputs from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeInputs
▸ serializeInputs(writeStream
, objects
): void
Serialize the inputs to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
objects | InputTypes [] | The objects to serialize. |
Returns
void
deserializeInput
▸ deserializeInput(readStream
): InputTypes
Deserialize the input from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeInput
▸ serializeInput(writeStream
, object
): void
Serialize the input to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | InputTypes | The object to serialize. |
Returns
void
deserializeTreasuryInput
▸ deserializeTreasuryInput(readStream
): ITreasuryInput
Deserialize the treasury input from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeTreasuryInput
▸ serializeTreasuryInput(writeStream
, object
): void
Serialize the treasury input to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITreasuryInput | The object to serialize. |
Returns
void
deserializeUTXOInput
▸ deserializeUTXOInput(readStream
): IUTXOInput
Deserialize the utxo input from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeUTXOInput
▸ serializeUTXOInput(writeStream
, object
): void
Serialize the utxo input to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IUTXOInput | The object to serialize. |
Returns
void
deserializeMilestoneOptions
▸ deserializeMilestoneOptions(readStream
): MilestoneOptionTypes
[]
Deserialize the milestone options from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeMilestoneOptions
▸ serializeMilestoneOptions(writeStream
, objects
): void
Serialize the milestone options to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
objects | MilestoneOptionTypes [] | The objects to serialize. |
Returns
void
deserializeMilestoneOption
▸ deserializeMilestoneOption(readStream
): MilestoneOptionTypes
Deserialize the milestone options from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeMilestoneOption
▸ serializeMilestoneOption(writeStream
, object
): void
Serialize the milestone option to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITypeBase <number > | The object to serialize. |
Returns
void
deserializeProtocolParamsMilestoneOption
▸ deserializeProtocolParamsMilestoneOption(readStream
): IProtocolParamsMilestoneOption
Deserialize the protocol params milestone option from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
IProtocolParamsMilestoneOption
The deserialized object.
serializeProtocolParamsMilestoneOption
▸ serializeProtocolParamsMilestoneOption(writeStream
, object
): void
Serialize the protocol params milestone option to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IProtocolParamsMilestoneOption | The object to serialize. |
Returns
void
deserializeReceiptMilestoneOption
▸ deserializeReceiptMilestoneOption(readStream
): IReceiptMilestoneOption
Deserialize the receipt milestone option from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeReceiptMilestoneOption
▸ serializeReceiptMilestoneOption(writeStream
, object
): void
Serialize the receipt milestone option to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IReceiptMilestoneOption | The object to serialize. |
Returns
void
deserializeAliasOutput
▸ deserializeAliasOutput(readStream
): IAliasOutput
Deserialize the alias output from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeAliasOutput
▸ serializeAliasOutput(writeStream
, object
): void
Serialize the alias output to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IAliasOutput | The object to serialize. |
Returns
void
deserializeBasicOutput
▸ deserializeBasicOutput(readStream
): IBasicOutput
Deserialize the basic output from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeBasicOutput
▸ serializeBasicOutput(writeStream
, object
): void
Serialize the basic output to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IBasicOutput | The object to serialize. |
Returns
void
deserializeFoundryOutput
▸ deserializeFoundryOutput(readStream
): IFoundryOutput
Deserialize the foundry output from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeFoundryOutput
▸ serializeFoundryOutput(writeStream
, object
): void
Serialize the foundry output to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IFoundryOutput | The object to serialize. |
Returns
void
deserializeNftOutput
▸ deserializeNftOutput(readStream
): INftOutput
Deserialize the nft output from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeNftOutput
▸ serializeNftOutput(writeStream
, object
): void
Serialize the nft output to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | INftOutput | The object to serialize. |
Returns
void
deserializeOutputs
▸ deserializeOutputs(readStream
): OutputTypes
[]
Deserialize the outputs from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeOutputs
▸ serializeOutputs(writeStream
, objects
): void
Serialize the outputs to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
objects | OutputTypes [] | The objects to serialize. |
Returns
void
deserializeOutput
▸ deserializeOutput(readStream
): OutputTypes
Deserialize the output from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeOutput
▸ serializeOutput(writeStream
, object
): void
Serialize the output to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITypeBase <number > | The object to serialize. |
Returns
void
deserializeTreasuryOutput
▸ deserializeTreasuryOutput(readStream
): ITreasuryOutput
Deserialize the treasury output from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeTreasuryOutput
▸ serializeTreasuryOutput(writeStream
, object
): void
Serialize the treasury output to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITreasuryOutput | The object to serialize. |
Returns
void
deserializeMilestonePayload
▸ deserializeMilestonePayload(readStream
): IMilestonePayload
Deserialize the milestone payload from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeMilestonePayload
▸ serializeMilestonePayload(writeStream
, object
): void
Serialize the milestone payload to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IMilestonePayload | The object to serialize. |
Returns
void
serializeMilestoneEssence
▸ serializeMilestoneEssence(writeStream
, object
): void
Serialize the milestone payload to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IMilestonePayload | The object to serialize. |
Returns
void
deserializePayload
▸ deserializePayload(readStream
): PayloadTypes
| undefined
Deserialize the payload from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
PayloadTypes
| undefined
The deserialized object.
serializePayload
▸ serializePayload(writeStream
, object
): void
Serialize the payload essence to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | undefined | PayloadTypes | The object to serialize. |
Returns
void
deserializeTaggedDataPayload
▸ deserializeTaggedDataPayload(readStream
): ITaggedDataPayload
Deserialize the tagged data payload from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeTaggedDataPayload
▸ serializeTaggedDataPayload(writeStream
, object
): void
Serialize the tagged data payload to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITaggedDataPayload | The object to serialize. |
Returns
void
deserializeTransactionPayload
▸ deserializeTransactionPayload(readStream
): ITransactionPayload
Deserialize the transaction payload from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeTransactionPayload
▸ serializeTransactionPayload(writeStream
, object
): void
Serialize the transaction payload to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITransactionPayload | The object to serialize. |
Returns
void
deserializeTreasuryTransactionPayload
▸ deserializeTreasuryTransactionPayload(readStream
): ITreasuryTransactionPayload
Deserialize the treasury transaction payload from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeTreasuryTransactionPayload
▸ serializeTreasuryTransactionPayload(writeStream
, object
): void
Serialize the treasury transaction payload to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITreasuryTransactionPayload | The object to serialize. |
Returns
void
deserializeEd25519Signature
▸ deserializeEd25519Signature(readStream
): IEd25519Signature
Deserialize the Ed25519 signature from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeEd25519Signature
▸ serializeEd25519Signature(writeStream
, object
): void
Serialize the Ed25519 signature to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IEd25519Signature | The object to serialize. |
Returns
void
deserializeSignature
▸ deserializeSignature(readStream
): SignatureTypes
Deserialize the signature from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeSignature
▸ serializeSignature(writeStream
, object
): void
Serialize the signature to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IEd25519Signature | The object to serialize. |
Returns
void
deserializeSimpleTokenScheme
▸ deserializeSimpleTokenScheme(readStream
): ISimpleTokenScheme
Deserialize the simple token scheme from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeSimpleTokenScheme
▸ serializeSimpleTokenScheme(writeStream
, object
): void
Serialize the simple token scheme to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ISimpleTokenScheme | The object to serialize. |
Returns
void
deserializeTokenScheme
▸ deserializeTokenScheme(readStream
): TokenSchemeTypes
Deserialize the token scheme from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeTokenScheme
▸ serializeTokenScheme(writeStream
, object
): void
Serialize the token scheme to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ISimpleTokenScheme | The object to serialize. |
Returns
void
deserializeTransactionEssence
▸ deserializeTransactionEssence(readStream
): ITransactionEssence
Deserialize the transaction essence from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeTransactionEssence
▸ serializeTransactionEssence(writeStream
, object
): void
Serialize the transaction essence to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITransactionEssence | The object to serialize. |
Returns
void
deserializeAddressUnlockCondition
▸ deserializeAddressUnlockCondition(readStream
): IAddressUnlockCondition
Deserialize the address unlock condition from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeAddressUnlockCondition
▸ serializeAddressUnlockCondition(writeStream
, object
): void
Serialize the address unlock condition to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IAddressUnlockCondition | The object to serialize. |
Returns
void
deserializeExpirationUnlockCondition
▸ deserializeExpirationUnlockCondition(readStream
): IExpirationUnlockCondition
Deserialize the expiration unlock condition from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeExpirationUnlockCondition
▸ serializeExpirationUnlockCondition(writeStream
, object
): void
Serialize the expiration unlock condition to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IExpirationUnlockCondition | The object to serialize. |
Returns
void
deserializeGovernorAddressUnlockCondition
▸ deserializeGovernorAddressUnlockCondition(readStream
): IGovernorAddressUnlockCondition
Deserialize the governor address unlock condition from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
IGovernorAddressUnlockCondition
The deserialized object.
serializeGovernorAddressUnlockCondition
▸ serializeGovernorAddressUnlockCondition(writeStream
, object
): void
Serialize the governor address unlock condition to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IGovernorAddressUnlockCondition | The object to serialize. |
Returns
void
deserializeImmutableAliasUnlockCondition
▸ deserializeImmutableAliasUnlockCondition(readStream
): IImmutableAliasUnlockCondition
Deserialize the immutable alias unlock condition from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
IImmutableAliasUnlockCondition
The deserialized object.
serializeImmutableAliasUnlockCondition
▸ serializeImmutableAliasUnlockCondition(writeStream
, object
): void
Serialize the immutable alias unlock condition to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IImmutableAliasUnlockCondition | The object to serialize. |
Returns
void
deserializeStateControllerAddressUnlockCondition
▸ deserializeStateControllerAddressUnlockCondition(readStream
): IStateControllerAddressUnlockCondition
Deserialize the state controller address unlock condition from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
IStateControllerAddressUnlockCondition
The deserialized object.
serializeStateControllerAddressUnlockCondition
▸ serializeStateControllerAddressUnlockCondition(writeStream
, object
): void
Serialize the state controller address unlock condition to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IStateControllerAddressUnlockCondition | The object to serialize. |
Returns
void
deserializeStorageDepositReturnUnlockCondition
▸ deserializeStorageDepositReturnUnlockCondition(readStream
): IStorageDepositReturnUnlockCondition
Deserialize the storage deposit return unlock condition from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
IStorageDepositReturnUnlockCondition
The deserialized object.
serializeStorageDepositReturnUnlockCondition
▸ serializeStorageDepositReturnUnlockCondition(writeStream
, object
): void
Serialize the storage deposit return unlock condition to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IStorageDepositReturnUnlockCondition | The object to serialize. |
Returns
void
deserializeTimelockUnlockCondition
▸ deserializeTimelockUnlockCondition(readStream
): ITimelockUnlockCondition
Deserialize the timelock unlock condition from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeTimelockUnlockCondition
▸ serializeTimelockUnlockCondition(writeStream
, object
): void
Serialize the timelock unlock condition to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITimelockUnlockCondition | The object to serialize. |
Returns
void
deserializeUnlockConditions
▸ deserializeUnlockConditions(readStream
): UnlockConditionTypes
[]
Deserialize the unlock conditions from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeUnlockConditions
▸ serializeUnlockConditions(writeStream
, objects
): void
Serialize the unlock conditions to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
objects | UnlockConditionTypes [] | The objects to serialize. |
Returns
void
deserializeUnlockCondition
▸ deserializeUnlockCondition(readStream
): UnlockConditionTypes
Deserialize the unlock condition from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeUnlockCondition
▸ serializeUnlockCondition(writeStream
, object
): void
Serialize the unlock condition to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ITypeBase <number > | The object to serialize. |
Returns
void
deserializeAliasUnlock
▸ deserializeAliasUnlock(readStream
): IAliasUnlock
Deserialize the alias unlock from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeAliasUnlock
▸ serializeAliasUnlock(writeStream
, object
): void
Serialize the alias unlock to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IAliasUnlock | The object to serialize. |
Returns
void
deserializeNftUnlock
▸ deserializeNftUnlock(readStream
): INftUnlock
Deserialize the nft unlock from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeNftUnlock
▸ serializeNftUnlock(writeStream
, object
): void
Serialize the nft unlock to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | INftUnlock | The object to serialize. |
Returns
void
deserializeReferenceUnlock
▸ deserializeReferenceUnlock(readStream
): IReferenceUnlock
Deserialize the reference unlock from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeReferenceUnlock
▸ serializeReferenceUnlock(writeStream
, object
): void
Serialize the reference unlock to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | IReferenceUnlock | The object to serialize. |
Returns
void
deserializeSignatureUnlock
▸ deserializeSignatureUnlock(readStream
): ISignatureUnlock
Deserialize the signature unlock from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeSignatureUnlock
▸ serializeSignatureUnlock(writeStream
, object
): void
Serialize the signature unlock to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | ISignatureUnlock | The object to serialize. |
Returns
void
deserializeUnlocks
▸ deserializeUnlocks(readStream
): UnlockTypes
[]
Deserialize the unlocks from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeUnlocks
▸ serializeUnlocks(writeStream
, objects
): void
Serialize the unlocks to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
objects | UnlockTypes [] | The objects to serialize. |
Returns
void
deserializeUnlock
▸ deserializeUnlock(readStream
): UnlockTypes
Deserialize the unlock from binary.
Parameters
Name | Type | Description |
---|---|---|
readStream | ReadStream | The stream to read the data from. |
Returns
The deserialized object.
serializeUnlock
▸ serializeUnlock(writeStream
, object
): void
Serialize the unlock to binary.
Parameters
Name | Type | Description |
---|---|---|
writeStream | WriteStream | The stream to write the data to. |
object | UnlockTypes | The object to serialize. |
Returns
void
addressBalance
▸ addressBalance(client
, addressBech32
): Promise
<{}>
Get the balance for an address.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to get the information from. |
addressBech32 | string | The address to get the balances for. |
Returns
Promise
<{}>
The balance.
generateBip44Path
▸ generateBip44Path(accountIndex
, addressIndex
, isInternal
): Bip32Path
Generate a bip44 path based on all its parts.
Parameters
Name | Type | Description |
---|---|---|
accountIndex | number | The account index. |
addressIndex | number | The address index. |
isInternal | boolean | Is this an internal address. |
Returns
Bip32Path
The generated address.
generateBip44Address
▸ generateBip44Address(generatorState
): string
Generate addresses based on the account indexing style.
Parameters
Name | Type | Description |
---|---|---|
generatorState | IBip44GeneratorState | The address state. |
Returns
string
The key pair for the address.
getBalance
▸ getBalance(client
, seed
, accountIndex
, addressOptions?
): Promise
<BigInteger
>
Get the balance for a list of addresses.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to send the transfer with. |
seed | ISeed | The seed. |
accountIndex | number | The account index in the wallet. |
addressOptions? | Object | Optional address configuration for balance address lookups. |
Returns
Promise
<BigInteger
>
The balance.
getUnspentAddress
▸ getUnspentAddress(client
, seed
, accountIndex
, addressOptions?
): Promise
<{} | undefined
>
Get the first unspent address.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to send the transfer with. |
seed | ISeed | The seed to use for address generation. |
accountIndex | number | The account index in the wallet. |
addressOptions? | Object | Optional address configuration for balance address lookups. |
Returns
Promise
<{} | undefined
>
The first unspent address.
getUnspentAddresses
▸ getUnspentAddresses(client
, seed
, accountIndex
, addressOptions?
): Promise
<{}[]>
Get all the unspent addresses.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to send the transfer with. |
seed | ISeed | The seed to use for address generation. |
accountIndex | number | The account index in the wallet. |
addressOptions? | Object | Optional address configuration for balance address lookups. |
Returns
Promise
<{}[]>
All the unspent addresses.
getUnspentAddressesWithAddressGenerator
▸ getUnspentAddressesWithAddressGenerator<T
>(client
, seed
, initialAddressState
, nextAddressPath
, addressOptions?
): Promise
<{}[]>
Get all the unspent addresses using an address generator.
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to get the addresses from. |
seed | ISeed | The seed to use for address generation. |
initialAddressState | T | The initial address state for calculating the addresses. |
nextAddressPath | (addressState : T ) => string | Calculate the next address for inputs. |
addressOptions? | Object | Optional address configuration for balance address lookups. |
Returns
Promise
<{}[]>
All the unspent addresses.
promote
▸ promote(client
, blockId
): Promise
<{}>
Promote an existing block.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The clientor node endpoint to perform the promote with. |
blockId | string | The block to promote. |
Returns
Promise
<{}>
The id and block that were promoted.
reattach
▸ reattach(client
, blockId
): Promise
<{}>
Reattach an existing block.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to perform the reattach with. |
blockId | string | The block to reattach. |
Returns
Promise
<{}>
The id and block that were reattached.
retrieveData
▸ retrieveData(client
, blockId
): Promise
<{} | undefined
>
Retrieve a data block.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to retrieve the data with. |
blockId | string | The block id of the data to get. |
Returns
Promise
<{} | undefined
>
The block tag and data.
retry
▸ retry(client
, blockId
): Promise
<{}>
Retry an existing block either by promoting or reattaching.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to perform the retry with. |
blockId | string | The block to retry. |
Returns
Promise
<{}>
The id and block that were retried.
send
▸ send(client
, seed
, accountIndex
, addressBech32
, amount
, taggedData?
, addressOptions?
): Promise
<{}>
Send a transfer from the balance on the seed to a single output.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to send the transfer with. |
seed | ISeed | The seed to use for address generation. |
accountIndex | number | The account index in the wallet. |
addressBech32 | string | The address to send the funds to in bech32 format. |
amount | BigInteger | The amount to send. |
taggedData? | Object | Optional tagged data to associate with the transaction. |
addressOptions? | Object | Optional address configuration for balance address lookups. |
Returns
Promise
<{}>
The id of the block created and the contructed block.
sendEd25519
▸ sendEd25519(client
, seed
, accountIndex
, addressEd25519
, amount
, taggedData?
, addressOptions?
): Promise
<{}>
Send a transfer from the balance on the seed to a single output.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to send the transfer with. |
seed | ISeed | The seed to use for address generation. |
accountIndex | number | The account index in the wallet. |
addressEd25519 | string | The address to send the funds to in ed25519 format. |
amount | BigInteger | The amount to send. |
taggedData? | Object | Optional tagged data to associate with the transaction. |
addressOptions? | Object | Optional address configuration for balance address lookups. |
Returns
Promise
<{}>
The id of the block created and the contructed block.
sendMultiple
▸ sendMultiple(client
, seed
, accountIndex
, outputs
, taggedData?
, addressOptions?
): Promise
<{}>
Send a transfer from the balance on the seed to multiple outputs.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to send the transfer with. |
seed | ISeed | The seed to use for address generation. |
accountIndex | number | The account index in the wallet. |
outputs | {}[] | The address to send the funds to in bech32 format and amounts. |
taggedData? | Object | Optional tagged data to associate with the transaction. |
addressOptions? | Object | Optional address configuration for balance address lookups. |
Returns
Promise
<{}>
The id of the block created and the contructed block.
sendMultipleEd25519
▸ sendMultipleEd25519(client
, seed
, accountIndex
, outputs
, taggedData?
, addressOptions?
): Promise
<{}>
Send a transfer from the balance on the seed.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to send the transfer with. |
seed | ISeed | The seed to use for address generation. |
accountIndex | number | The account index in the wallet. |
outputs | {}[] | The outputs including address to send the funds to in ed25519 format and amount. |
taggedData? | Object | Optional tagged data to associate with the transaction. |
addressOptions? | Object | Optional address configuration for balance address lookups. |
Returns
Promise
<{}>
The id of the block created and the contructed block.
sendWithAddressGenerator
▸ sendWithAddressGenerator<T
>(client
, seed
, initialAddressState
, nextAddressPath
, outputs
, taggedData?
, zeroCount?
): Promise
<{}>
Send a transfer using account based indexing for the inputs.
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to send the transfer with. |
seed | ISeed | The seed to use for address generation. |
initialAddressState | T | The initial address state for calculating the addresses. |
nextAddressPath | (addressState : T ) => string | Calculate the next address for inputs. |
outputs | {}[] | The address to send the funds to in bech32 format and amounts. |
taggedData? | Object | Optional tagged data to associate with the transaction. |
zeroCount? | number | The number of addresses with 0 balance during lookup before aborting. |
Returns
Promise
<{}>
The id of the block created and the contructed block.
calculateInputs
▸ calculateInputs<T
>(client
, seed
, initialAddressState
, nextAddressPath
, outputs
, zeroCount?
): Promise
<{}[]>
Calculate the inputs from the seed and basePath.
Type parameters
Name |
---|
T |
Parameters
Name | Type | Default value | Description |
---|---|---|---|
client | string | IClient | undefined | The client or node endpoint to calculate the inputs with. |
seed | ISeed | undefined | The seed to use for address generation. |
initialAddressState | T | undefined | The initial address state for calculating the addresses. |
nextAddressPath | (addressState : T ) => string | undefined | Calculate the next address for inputs. |
outputs | {}[] | undefined | The outputs to send. |
zeroCount | number | 5 | Abort when the number of zero balances is exceeded. |
Returns
Promise
<{}[]>
The id of the block created and the contructed block.
sendAdvanced
▸ sendAdvanced(client
, inputsAndSignatureKeyPairs
, outputs
, taggedData?
): Promise
<{}>
Send a transfer from the balance on the seed.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to send the transfer with. |
inputsAndSignatureKeyPairs | {}[] | The inputs with the signature key pairs needed to sign transfers. |
outputs | {}[] | The outputs to send. |
taggedData? | Object | Optional tagged data to associate with the transaction. |
Returns
Promise
<{}>
The id of the block created and the remainder address if one was needed.
buildTransactionPayload
▸ buildTransactionPayload(networkId
, inputsAndSignatureKeyPairs
, outputs
, taggedData?
): ITransactionPayload
Build a transaction payload.
Parameters
Name | Type | Description |
---|---|---|
networkId | string | The network id we are sending the payload on. |
inputsAndSignatureKeyPairs | {}[] | The inputs with the signature key pairs needed to sign transfers. |
outputs | {}[] | The outputs to send. |
taggedData? | Object | Optional tagged data to associate with the transaction. |
Returns
The transaction payload.
sendData
▸ sendData(client
, tag?
, data?
): Promise
<{}>
Send a data block.
Parameters
Name | Type | Description |
---|---|---|
client | string | IClient | The client or node endpoint to send the data with. |
tag? | string | Uint8Array | The tag for the data. |
data? | string | Uint8Array | The data as either UTF8 text or Uint8Array bytes. |
Returns
Promise
<{}>
The id of the block created and the block.
setLogger
▸ setLogger(log
): void
Set the logger for output.
Parameters
Name | Type | Description |
---|---|---|
log | (message : string , data? : unknown ) => void | The logger. |
Returns
void
logRoutes
▸ logRoutes(prefix
, routes
): void
Log the routes of the node.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
routes | IRoutesResponse | The available routes. |
Returns
void
logInfo
▸ logInfo(prefix
, info
): void
Log the node information.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
info | INodeInfo | The info to log. |
Returns
void
logTips
▸ logTips(prefix
, tipsResponse
): void
Log the tips information.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
tipsResponse | ITipsResponse | The tips to log. |
Returns
void
logBlock
▸ logBlock(prefix
, block
): void
Log a block to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
block | IBlock | The block to log. |
Returns
void
logBlockMetadata
▸ logBlockMetadata(prefix
, blockMetadata
): void
Log the block metadata to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
blockMetadata | IBlockMetadata | The blockMetadata to log. |
Returns
void
logPayload
▸ logPayload(prefix
, payload?
): void
Log a block to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
payload? | PayloadTypes | The payload. |
Returns
void
logTransactionPayload
▸ logTransactionPayload(prefix
, payload?
): void
Log a transaction payload to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
payload? | ITransactionPayload | The payload. |
Returns
void
logTaggedDataPayload
▸ logTaggedDataPayload(prefix
, payload?
): void
Log a tagged data payload to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
payload? | ITaggedDataPayload | The payload. |
Returns
void
logMilestonePayload
▸ logMilestonePayload(prefix
, payload?
): void
Log a milestone payload to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
payload? | IMilestonePayload | The payload. |
Returns
void
logMilestoneOptions
▸ logMilestoneOptions(prefix
, milestoneOptions?
): void
Log milestone options to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
milestoneOptions? | MilestoneOptionTypes [] | The milestone options. |
Returns
void
logMilestoneOption
▸ logMilestoneOption(prefix
, milestoneOption
): void
Log milestone option to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
milestoneOption | MilestoneOptionTypes | The milestone option. |
Returns
void
logReceiptMilestoneOption
▸ logReceiptMilestoneOption(prefix
, option?
): void
Log a receipt milestone option to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
option? | IReceiptMilestoneOption | The option. |
Returns
void
logProtocolParamsMilestoneOption
▸ logProtocolParamsMilestoneOption(prefix
, option?
): void
Log a protocol params milestone option to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
option? | IProtocolParamsMilestoneOption | The option. |
Returns
void
logTreasuryTransactionPayload
▸ logTreasuryTransactionPayload(prefix
, payload?
): void
Log a treasury transaction payload to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
payload? | ITreasuryTransactionPayload | The payload. |
Returns
void
logAddress
▸ logAddress(prefix
, address?
): void
Log an address to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
address? | AddressTypes | The address to log. |
Returns
void
logSignature
▸ logSignature(prefix
, signature?
): void
Log signature to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
signature? | IEd25519Signature | The signature to log. |
Returns
void
logInput
▸ logInput(prefix
, input?
): void
Log input to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
input? | InputTypes | The input to log. |
Returns
void
logOutput
▸ logOutput(prefix
, output?
): void
Log output to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
output? | OutputTypes | The output to log. |
Returns
void
logUnlock
▸ logUnlock(prefix
, unlock?
): void
Log unlock to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
unlock? | UnlockTypes | The unlock to log. |
Returns
void
logFunds
▸ logFunds(prefix
, fund?
): void
Log fund to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
fund? | IMigratedFunds | The fund to log. |
Returns
void
logNativeTokens
▸ logNativeTokens(prefix
, nativeTokens
): void
Log native tokens to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
nativeTokens | undefined | INativeToken [] | The native tokens. |
Returns
void
logTokenScheme
▸ logTokenScheme(prefix
, tokenScheme
): void
Log token scheme to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
tokenScheme | ISimpleTokenScheme | The token scheme. |
Returns
void
logFeatures
▸ logFeatures(prefix
, features
): void
Log featurew to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
features | undefined | FeatureTypes [] | The features. |
Returns
void
logImmutableFeatures
▸ logImmutableFeatures(prefix
, immutableFeatures
): void
Log immutable featuress to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
immutableFeatures | undefined | FeatureTypes [] | The features. |
Returns
void
logFeature
▸ logFeature(prefix
, feature
): void
Log feature to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
feature | FeatureTypes | The feature. |
Returns
void
logUnlockConditions
▸ logUnlockConditions(prefix
, unlockConditions
): void
Log unlock conditions to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
unlockConditions | UnlockConditionTypes [] | The unlock conditions. |
Returns
void
logUnlockCondition
▸ logUnlockCondition(prefix
, unlockCondition
): void
Log feature block to the console.
Parameters
Name | Type | Description |
---|---|---|
prefix | string | The prefix for the output. |
unlockCondition | UnlockConditionTypes | The unlock condition. |
Returns
void
milestoneIdFromMilestonePayload
▸ milestoneIdFromMilestonePayload(payload
): string
Compute a milestoneId from a milestone payload.
Parameters
Name | Type | Description |
---|---|---|
payload | IMilestonePayload | The milestone payload. |
Returns
string
The milestone id hex prefixed string.
blockIdFromMilestonePayload
▸ blockIdFromMilestonePayload(protocolVersion
, payload
): string
Compute a blockId from a milestone payload.
Parameters
Name | Type | Description |
---|---|---|
protocolVersion | number | The protocol version to use. |
payload | IMilestonePayload | The milestone payload. |
Returns
string
The blockId of the block with the milestone payload.
Type Aliases
AddressTypes
Ƭ AddressTypes: IEd25519Address
| IAliasAddress
| INftAddress
All of the address types.
FeatureTypes
Ƭ FeatureTypes: ISenderFeature
| IIssuerFeature
| IMetadataFeature
| ITagFeature
All of the feature block types.
InputTypes
Ƭ InputTypes: IUTXOInput
| ITreasuryInput
All of the input types.
LedgerInclusionState
Ƭ LedgerInclusionState: "noTransaction"
| "included"
| "conflicting"
The different states of ledger inclusion.
Magnitudes
Ƭ Magnitudes: "P"
| "T"
| "G"
| "M"
| "K"
| ""
Magnitudes for the numbers.
MilestoneOptionTypes
Ƭ MilestoneOptionTypes: IReceiptMilestoneOption
| IProtocolParamsMilestoneOption
All of the milestone option types.
OutputTypes
Ƭ OutputTypes: ITreasuryOutput
| IBasicOutput
| IAliasOutput
| IFoundryOutput
| INftOutput
All of the output types.
PayloadTypes
Ƭ PayloadTypes: ITransactionPayload
| IMilestonePayload
| ITreasuryTransactionPayload
| ITaggedDataPayload
All of the payload types.
SignatureTypes
Ƭ SignatureTypes: IEd25519Signature
All of the signature types.
TokenSchemeTypes
Ƭ TokenSchemeTypes: ISimpleTokenScheme
All of the token scheme types.
UnlockConditionTypes
Ƭ UnlockConditionTypes: IAddressUnlockCondition
| IStorageDepositReturnUnlockCondition
| ITimelockUnlockCondition
| IExpirationUnlockCondition
| IStateControllerAddressUnlockCondition
| IGovernorAddressUnlockCondition
| IImmutableAliasUnlockCondition
All of the unlock condition types.
UnlockTypes
Ƭ UnlockTypes: ISignatureUnlock
| IReferenceUnlock
| IAliasUnlock
| INftUnlock
All of the unlock types.