Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AliasApi

Alias API

Work in Progress

Hierarchy

  • AliasApi

Index

Properties

getAliasById

getAliasById: function

Get alias by its id, i.e. get basic account info for given alias name

param

The alias id

returns

The Alias object

Type declaration

    • (aliasId: string): Promise<Alias>
    • Parameters

      • aliasId: string

      Returns Promise<Alias>

getAliasByName

getAliasByName: function

Get alias by name, i.e. get basic account info for given alias name

param

The alias name

returns

The Alias object

Type declaration

    • (aliasName: string): Promise<Alias>
    • Parameters

      • aliasName: string

      Returns Promise<Alias>

setAlias

setAlias: function

Registers an Alias with the Burst blockchain

The transaction will be broadcasted in two steps.

  1. Send the setAlias call with public key to the network
  2. Take the returned unsigned message and sign it, i.e. the private key won't be transmitted.
param

The alias name

param

The alias URI

param

The fee to pay

param

The name of the account

param

The senders public key for sending an unsigned message

param

The senders private key to sign the message

param

The deadline, in minutes, for the transaction to be confirmed

returns

The Transaction ID

Type declaration

    • (aliasName: string, aliasURI: string, feeNQT: string, senderPublicKey: string, senderPrivateKey: string, deadline?: number): Promise<TransactionId>
    • Parameters

      • aliasName: string
      • aliasURI: string
      • feeNQT: string
      • senderPublicKey: string
      • senderPrivateKey: string
      • Optional deadline: number

      Returns Promise<TransactionId>