Interface Signer

An interface for signing messages and transactions.

interface Signer {
    getAddress(address?): string;
    sendSignedTransaction(signature, txBody, isDryrun?): Promise<any>;
    sendTransaction(transactionObject, isDryrun?): any;
    sendTransactionBatch(transactionObjects): Promise<any>;
    signMessage(message, address?): string | Promise<string>;
}

Implemented by

Methods

getAddress sendSignedTransaction sendTransaction sendTransactionBatch signMessage

Methods

getAddress

  • getAddress(address?): string

  • Gets an account's checksum address. If the address is not given, the default account of the signer is used.

    Parameters

    • Optional address: string

      The address of the account.

    Returns string

    The checksum address.

sendSignedTransaction

  • sendSignedTransaction(signature, txBody, isDryrun?): Promise<any>

  • Sends a signed transaction to the network.

    Parameters

    • signature: string

      The signature.

    • txBody: TransactionBody

      The transaction body.

    • Optional isDryrun: boolean

      The dryrun option.

    Returns Promise<any>

    The return value of the blockchain API.

sendTransaction

  • sendTransaction(transactionObject, isDryrun?): any

  • Signs and sends a transaction to the network.

    Parameters

    • transactionObject: TransactionInput

      The transaction input object.

    • Optional isDryrun: boolean

      The dryrun option.

    Returns any

    The return value of the blockchain API.

sendTransactionBatch

  • sendTransactionBatch(transactionObjects): Promise<any>

  • Signs and sends multiple transactions in a batch to the network.

    Parameters

    • transactionObjects: TransactionInput[]

      The list of the transaction input objects.

    Returns Promise<any>

    The return value of the blockchain API.

signMessage

  • signMessage(message, address?): string | Promise<string>

  • Signs a message using an account. If an address is not given, the default account of the signer is used.

    Parameters

    • message: string

      The message to sign.

    • Optional address: string

      The address of the account.

    Returns string | Promise<string>

    The signature.

On This Page