Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Accessors

type

  • get type(): string

Static coinTokenPatternSeparator

  • get coinTokenPatternSeparator(): string

Methods

baseUnitsToBigUnits

  • baseUnitsToBigUnits(baseUnits: string | number): string
  • Convert a currency amount represented in base units (satoshi, wei, atoms, drops, stroops) to big units (btc, eth, rmg, xrp, xlm)

    Parameters

    • baseUnits: string | number

    Returns string

bigUnitsToBaseUnits

  • bigUnitsToBaseUnits(bigUnits: string | number): string
  • Convert a currency amount represented in big units (btc, eth, rmg, xrp, xlm) to base units (satoshi, wei, atoms, drops, stroops)

    Parameters

    • bigUnits: string | number

    Returns string

deriveKeyWithSeed

  • deriveKeyWithSeed(__namedParameters: object): object
  • The cold wallet tool uses this function to derive an extended key that is based on the passed key and seed

    Parameters

    • __namedParameters: object

    Returns object

enterprises

explainTransaction

feeEstimate

generateKeyPair

  • generateKeyPair(seed?: Buffer): KeyPair

getAddressDetails

  • getAddressDetails(address: string): AddressDetails
  • Process address into address and memo id

    Parameters

    • address: string

      the address

    Returns AddressDetails

getBaseFactor

  • getBaseFactor(): number

getChain

  • getChain(): string

getChainId

  • getChainId(): string

getExtraPrebuildParams

getFamily

  • getFamily(): string

getFullName

  • getFullName(): string

getPublicNodeUrls

  • getPublicNodeUrls(): string[]

initiateRecovery

  • initiateRecovery(__namedParameters: object): Bluebird<HDNode[]>

isValidAddress

  • isValidAddress(address: string): boolean

isValidMemo

  • isValidMemo(__namedParameters: object): boolean
  • Evaluates whether a memo is valid

    Parameters

    • __namedParameters: object

    Returns boolean

isValidMemoId

  • isValidMemoId(memoId: string): boolean
  • Return boolean indicating whether a memo id is valid

    Parameters

    • memoId: string

      the memo id to be checked

    Returns boolean

isValidMofNSetup

  • isValidMofNSetup(__namedParameters: object): boolean

isValidPrv

  • isValidPrv(prv: string): boolean
  • Return boolean indicating whether input is valid seed for the coin

    Parameters

    • prv: string

      the prv to be checked

    Returns boolean

isValidPub

  • isValidPub(pub: string): boolean

keyIdsForSigning

  • keyIdsForSigning(): number[]

keychains

markets

newWalletObject

  • newWalletObject(walletParams: any): Wallet

normalizeAddress

  • normalizeAddress(__namedParameters: object): string
  • Validate and return address with appended memo id

    Parameters

    • __namedParameters: object

    Returns string

parseTransaction

pendingApprovals

postProcessPrebuild

preCreateBitGo

presignTransaction

recover

  • recover(params: RecoveryOptions, callback?: NodeCallback<RecoveryTransaction>): Bluebird<RecoveryTransaction>
  • Builds a funds recovery transaction without BitGo

    Parameters

    • params: RecoveryOptions
    • Optional callback: NodeCallback<RecoveryTransaction>

    Returns Bluebird<RecoveryTransaction>

serializeTransaction

  • serializeTransaction(eosClient: EosJs, transaction: EosJs.transaction): string
  • Serialize an EOS transaction, to the format that should be signed

    Parameters

    • eosClient: EosJs

      an offline EOSClient that has the transaction structs

    • transaction: EosJs.transaction

      The EOS transaction returned from eosClient.transaction to serialize

    Returns string

    serialized transaction in hex format

signMessage

  • signMessage(key: object, message: string): Buffer

signTransaction

signTx

  • signTx(signableTx: string, signingKey: HDNode): string
  • Sign a transaction with a key

    Parameters

    • signableTx: string
    • signingKey: HDNode

    Returns string

supplementGenerateWallet

supportsBlockTarget

  • supportsBlockTarget(): boolean

transactionDataAllowed

  • transactionDataAllowed(): boolean

url

  • url(suffix: string): string

validateKey

  • validateKey(__namedParameters: object): HDNode
  • Validate a public or private key If passphrase is provided, try to decrypt the key with it

    Parameters

    • __namedParameters: object

    Returns HDNode

valuelessTransferAllowed

  • valuelessTransferAllowed(): boolean

verifyAddress

  • verifyAddress(__namedParameters: object): boolean

verifyRecoveryTransaction

verifyTransaction

wallets

webhooks

Static createInstance

Generated using TypeDoc