Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Ada

Main API endpoint

Hierarchy

  • Ada

Index

Constructors

Methods

Constructors

constructor

  • new Ada(transport: Transport<string>, scrambleKey?: string): Ada

  • Parameters

    • transport: Transport<string>
    • scrambleKey: string = "ADA"

    Returns Ada

Methods

getVersion

  • Returns an object containing the app version.

    example

    const { major, minor, patch, flags } = await ada.getVersion(); console.log(App version ${major}.${minor}.${patch});

    Returns Promise<GetVersionResponse>

    Result object containing the application version number.

getSerial

  • Returns an object containing the device serial number.

    example

    const { serialHex } = await ada.getSerial(); console.log(Serial number ${serial});

    Returns Promise<Serial>

    Result object containing the device serial number.

runTests

  • runTests(): Promise<void>

  • Runs unit tests on the device (DEVEL app build only)

    Returns Promise<void>

getExtendedPublicKeys

  • Get several public keys; one for each of the specified BIP 32 path.

    example
    const [{ publicKey, chainCode }] = await ada.getExtendedPublicKeys([[ HARDENED + 44, HARDENED + 1815, HARDENED + 1 ]]);
    console.log(publicKey);

    Parameters

    • paths: GetExtendedPublicKeysRequest

      The paths. A path must begin with 44'/1815'/account' or 1852'/1815'/account', and may be up to 10 indexes long.

    Returns Promise<GetExtendedPublicKeysResponse>

    The extended public keys (i.e. with chaincode) for the given paths.

getExtendedPublicKey

deriveAddress

  • Derives an address for the specified BIP 32 path. Note that the address is returned in raw hex format without any bech32/base58 encoding

    Parameters

    Returns Promise<DerivedAddress>

showAddress

  • Show address corresponding to a given derivation path on the device. This is useful for users to check whether the wallet does not try to scam the user.

    Parameters

    Returns Promise<void>

signTransaction

signOperationalCertificate

deriveNativeScriptHash

Generated using TypeDoc