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

feeEstimate

Abstract generateKeyPair

  • generateKeyPair(seed?: Buffer): KeyPair

Abstract getBaseFactor

  • getBaseFactor(): number | string
  • Returns the factor between the base unit and its smallest subdivison

    Returns number | string

Abstract getChain

  • getChain(): string
  • Name of the chain which supports this coin (eg, 'btc', 'eth')

    Returns string

getExtraPrebuildParams

Abstract getFamily

  • getFamily(): string

Abstract getFullName

  • getFullName(): string

initiateRecovery

Abstract isValidAddress

  • isValidAddress(address: string): boolean
  • Check if address is a plausibly valid address for the given coin.

    Does not verify that the address belongs to a wallet. For that, use verifyAddress

    Parameters

    • address: string

    Returns boolean

isValidMofNSetup

  • isValidMofNSetup(__namedParameters: object): boolean
  • Return wether the given m of n wallet signers/ key amounts are valid for the coin

    Parameters

    • __namedParameters: object

    Returns boolean

Abstract isValidPub

  • isValidPub(pub: string): boolean
  • Return boolean indicating whether input is valid public key for the coin.

    Parameters

    • pub: string

      the pub to be checked

    Returns boolean

    is it valid?

keyIdsForSigning

  • keyIdsForSigning(): number[]
  • Specifies what key we will need for signing - right now we just need the user key.

    Returns number[]

keychains

markets

newWalletObject

  • newWalletObject(walletParams: any): Wallet

Abstract parseTransaction

pendingApprovals

postProcessPrebuild

preCreateBitGo

  • Perform additional checks before adding a bitgo key. Base controller is a no-op, but coin-specific controller may do something

    Parameters

    Returns void

presignTransaction

signMessage

  • signMessage(key: object, message: string): Buffer
  • Sign message with private key

    Parameters

    • key: object
    • message: string

    Returns Buffer

Abstract signTransaction

supplementGenerateWallet

supportsBlockTarget

  • supportsBlockTarget(): boolean
  • Check whether a coin supports blockTarget for transactions to be included in

    Returns boolean

transactionDataAllowed

  • transactionDataAllowed(): boolean
  • Flag for sending data along with transactions

    Returns boolean

    True if okay to send tx data (ETH), false otherwise

url

  • url(suffix: string): string

valuelessTransferAllowed

  • valuelessTransferAllowed(): boolean
  • Flag for sending value of 0.

    Returns boolean

    True if okay to send 0 value, false otherwise

Abstract verifyAddress

verifyRecoveryTransaction

Abstract verifyTransaction

wallets

webhooks

Generated using TypeDoc