Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SellAliasArgs

The argument object for AliasApi.sellAlias

param

The alias Id

param

The alias name as an alternative for alias Id

param

The sale amount in Planck

param

The optional recipient Id. If given, then only that recipient can buy the alias.

param

The optional recipient public key.

param

The name of the Top Level Domain (TLD) aka namespace where this alias belongs to

Hierarchy

Index

Properties

Optional aliasId

aliasId: string

Optional aliasName

aliasName: string

amountPlanck

amountPlanck: string

Optional attachment

attachment: Attachment

An optional attachment

Optional deadline

deadline: number

The deadline when after how many minutes the transaction will be discarded, if it was not processed, e.g. due to very low fee

feePlanck

feePlanck: string

The fee expressed in Planck

note

It's recommended to use util.Amount

Optional recipientId

recipientId: string

Optional recipientPublicKey

recipientPublicKey: string

Optional referencedTransactionFullHash

referencedTransactionFullHash: string

Using this field allows to make a transaction dependent on other transactions.

Optional senderPrivateKey

senderPrivateKey: string

The senders private key, i.e. the crypto.Keys.signPrivateKey If the private key is not given, then the transaction method will return the unsigned byte string. The transaction won't be processed until the unsigned bytes are being signed and broadcasted using TransactionApi.signAndBroadcastTransaction

senderPublicKey

senderPublicKey: string

The senders public key, i.e. the crypto.Keys.publicKey

Optional skipAdditionalSecurityCheck

skipAdditionalSecurityCheck: boolean

Setting this option to true, skips the additional security check, i.e. the verification of the unsigned transaction bytes, which detects tampered node responses. By default, the option is false. Usually, you won't use this option, but can be useful when a method cannot be verified, because the verification is not implemented yet.

Optional tld

tld: string