This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Alias Lookup

For blockchains that support address aliases.

Supported are:

(with more planned)

There are two plugin interfaces here, forward and reverse resolve.

Plugin Input

Please see heat-server-common/src/constants.ts for type definitions

/**
 * Resolve alias
 */
interface {
  /**
   * Enum of blockchain identifiers
   */   
  blockchain: Blockchains;

  /**
   * Enum of asset or token types
   */   
  assetType: AssetTypes;

  /**
   * Alias
   */   
  alias: string;
}

/**
 * Reverse resolve alias
 */
interface {
  /**
   * Enum of blockchain identifiers
   */   
  blockchain: Blockchains;

  /**
   * Enum of asset or token types
   */   
  assetType: AssetTypes;

  /**
   * Address or public key
   */   
  addrXpub: string;
}

Plugin Output

/**
 * Resolve alias
 */
interface {
  addrXpub: string;
  isPermanent: boolean;
}

/**
 * Reverse resolve alias
 */
interface {
  alias: string;
  isPermanent: boolean;
}