Interface SellAliasArgs

The argument object for AliasApi.sellAlias

Param: aliasId

The alias Id

Param: aliasName

The alias name as an alternative for alias Id

Param: amountPlanck

The sale amount in Planck

Param: recipientId

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

Param: recipientPublicKey

The optional recipient public key.

Param: tld

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

interface SellAliasArgs {
    aliasId?: string;
    aliasName?: string;
    amountPlanck: string;
    attachment?: Attachment;
    deadline?: number;
    feePlanck: string;
    recipientId?: string;
    recipientPublicKey?: string;
    referencedTransactionFullHash?: string;
    senderPrivateKey?: string;
    senderPublicKey: string;
    skipAdditionalSecurityCheck?: boolean;
    tld?: string;
}

Hierarchy

  • DefaultSendArgs
    • SellAliasArgs

Properties

aliasId? aliasName? amountPlanck attachment? deadline? feePlanck recipientId? recipientPublicKey? referencedTransactionFullHash? senderPrivateKey? senderPublicKey skipAdditionalSecurityCheck? tld?

Properties

OptionalaliasId

aliasId?: string

OptionalaliasName

aliasName?: string

amountPlanck

amountPlanck: string

Optionalattachment

attachment?: Attachment

An optional attachment

Optionaldeadline

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

It's recommended to use util.Amount

OptionalrecipientId

recipientId?: string

OptionalrecipientPublicKey

recipientPublicKey?: string

OptionalreferencedTransactionFullHash

referencedTransactionFullHash?: string

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

OptionalsenderPrivateKey

senderPrivateKey?: string

The senders private key, i.e. the crypto.SignKeys.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.SignKeys.publicKey

OptionalskipAdditionalSecurityCheck

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.

Optionaltld

tld?: string

Settings

Member Visibility

On This Page

Properties