Skip to main content

iota_sdk.types.send_params

SendParams Objects​

@dataclass
class SendParams()

Parameters for sending base coins.

Attributes:

  • address - The address to send to.
  • amount - The amount to send.
  • returnAddress - The address to return the funds to if not claimed.
  • expiration - Expiration in seconds, after which the output will be available for the sender again, if not spent by the receiver already. The expiration will only be used if one is necessary given the provided amount. If an expiration is needed but not provided, it will default to one day.

SendNativeTokensParams Objects​

@dataclass
class SendNativeTokensParams()

Parameters for sending native tokens

Attributes:

  • address - The address to send to.
  • nativeTokens - The native tokens to send.
  • returnAddress - The address to return the native tokens to if not claimed.
  • expiration - The expiration timestamp until native tokens can be claimed.

SendNftParams Objects​

@dataclass
class SendNftParams()

Parameters for sending NFTs.

Attributes:

  • address - The address to send the NFT to.
  • nftId - The ID of the NFT to send.

CreateNativeTokenParams Objects​

@dataclass
class CreateNativeTokenParams()

Parameters for creating native tokens.

Attributes:

  • circulatingSupply - The circulating supply of the native token.
  • maximumSupply - The maximum supply of the native token.
  • foundryMetadata - The foundry metadata of the native token.
  • aliasId - The ID of the corresponding alias.

MintNftParams Objects​

@dataclass
class MintNftParams()

Parameters for minting NFTs.

Attributes:

  • address - A Bech32 encoded address to which the NFT will be minted. Default will use the first address of the account.
  • sender - An NFT sender feature.
  • metadata - An NFT metadata feature.
  • tag - An NFT tag feature.
  • issuer - An NFT issuer feature.
  • immutableMetadata - An NFT immutable metadata feature.

CreateAliasOutputParams Objects​

@dataclass
class CreateAliasOutputParams()

Parameters for creating aliases.

Attributes:

  • address - A Bech32 encoded address which will control the alias. Default will use the first address of the account.
  • immutableMetadata - Immutable alias metadata.
  • metadata - Alias metadata.
  • stateMetadata - Alias state metadata.