Class API

Constructors

constructor

Properties

_client _keosdEndpoint _keys _kms _signingMode

Methods

addPrivateKeys buildTransaction convertToWharfkitActions getChainID getRequiredKeysForTransaction isEndpointAvailable sendSignedTransaction signTransaction transact

Constructors

constructor

Properties

Private _client

_client: APIClient

Private _keosdEndpoint

_keosdEndpoint: string

Private _keys

_keys: {
    [pubKey: PublicKey]: Wif;
} = {}

Type declaration

  • [pubKey: PublicKey]: Wif

Private _kms

_kms: SignerKMS

Private _signingMode

_signingMode: "PRIVATE_KEY" | "KEOSD" | "KMS"

Methods

addPrivateKeys

  • addPrivateKeys(privateKeys): API

  • Add private keys to use for signing

    Parameters

    • privateKeys: string[]

    Returns API

    Memberof

    Signer

buildTransaction

  • buildTransaction(actions): Promise<Transaction>

  • Builds a Wharfkit Transaction from actions.

    Parameters

    • actions: Action[]

    Returns Promise<Transaction>

    Memberof

    API

Private convertToWharfkitActions

  • convertToWharfkitActions(actions): Promise<Action[]>
  • Private

    Converts non-type specific actions to Wharfkit Acitons

    Parameters

    • actions: Action[]

    Returns Promise<Action[]>

    Memberof

    Signer

getChainID

  • getChainID(): Promise<string>

  • Get the chain identifier for the given chain

    Returns Promise<string>

    Memberof

    API

Private getRequiredKeysForTransaction

  • getRequiredKeysForTransaction(transaction, availableKeys): Promise<string[]>
  • Private

    Gets the required public keys for a transaction

    Parameters

    • transaction: Transaction
    • availableKeys: string[]

    Returns Promise<string[]>

    Memberof

    Signer

Private isEndpointAvailable

  • isEndpointAvailable(): Promise<boolean>
  • Private

    Check if an endpoint is currently reachable

    Returns Promise<boolean>

    Memberof

    Signer

sendSignedTransaction

  • sendSignedTransaction(signedTransaction): Promise<{
        data: TransactionResponse;
        status: boolean;
    } | {
        data: string;
        status: boolean;
    }>

  • Sends a signed transaction up to the instantiated endpoint.

    Parameters

    • signedTransaction: SignedTransaction | SignedTransaction

    Returns Promise<{
        data: TransactionResponse;
        status: boolean;
    } | {
        data: string;
        status: boolean;
    }>

    Memberof

    API

signTransaction

  • signTransaction(transaction, allowPartialSignature?): Promise<SignedTransaction>

  • Return a signed transaction with matching signatures for authorization

    Parameters

    • transaction: Transaction
    • allowPartialSignature: boolean = false

      If true, using PRIVATE_KEY signing mode, sign with all available keys

    Returns Promise<SignedTransaction>

    Memberof

    Signer

transact

  • transact(actions, max_attempts?, attempt?): Promise<{
        data: TransactionResponse;
        status: boolean;
    } | {
        data: string;
        status: boolean;
    }>

  • Transacts given a set of actions

    Parameters

    • actions: Action[]
    • max_attempts: number = MAX_ATTEMPTS
    • attempt: number = 0

    Returns Promise<{
        data: TransactionResponse;
        status: boolean;
    } | {
        data: string;
        status: boolean;
    }>

    Memberof

    Signer

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc