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): Address
  • Parse an address string into address and destination tag

    Parameters

    • address: string

    Returns Address

getBaseFactor

  • getBaseFactor(): number

getChain

  • getChain(): string

getExtraPrebuildParams

getFamily

  • getFamily(): string

getFeeInfo

  • getFeeInfo(_?: any, callback?: any): Promise<FeeInfo>
  • Get fee info from server

    Parameters

    • Optional _: any
    • Optional callback: any

    Returns Promise<FeeInfo>

getFullName

  • getFullName(): string

getRippledUrl

  • getRippledUrl(): string
  • URL of a well-known, public facing (non-bitgo) rippled instance which can be used for recovery

    Returns string

initiateRecovery

isValidAddress

  • isValidAddress(address: string): boolean

isValidMofNSetup

  • isValidMofNSetup(__namedParameters: object): boolean

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[]

keychains

markets

newWalletObject

  • newWalletObject(walletParams: any): Wallet

normalizeAddress

  • normalizeAddress(__namedParameters: object): string
  • Construct a full, normalized address from an address and destination tag

    Parameters

    • __namedParameters: object

    Returns string

parseTransaction

pendingApprovals

postProcessPrebuild

preCreateBitGo

presignTransaction

recover

  • Builds a funds recovery transaction without BitGo

    Parameters

    • params: RecoveryOptions
      • rootAddress: root XRP wallet address to recover funds from
      • userKey: [encrypted] xprv
      • backupKey: [encrypted] xprv, or xpub if the xprv is held by a KRS provider
      • walletPassphrase: necessary if one of the xprvs is encrypted
      • bitgoKey: xpub
      • krsProvider: necessary if backup key is held by KRS
      • recoveryDestination: target address to send recovered funds to
    • Optional callback: NodeCallback<RecoveryInfo | string>

    Returns Bluebird<RecoveryInfo | string>

signMessage

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

signTransaction

  • signTransaction(__namedParameters: object): HalfSignedTransaction

supplementGenerateWallet

  • supplementGenerateWallet(walletParams: any, keychains: any): Bluebird<any>
  • Ripple requires additional parameters for wallet generation to be sent to the server. The additional parameters are the root public key, which is the basis of the root address, two signed, and one half-signed initialization txs

    Parameters

    • walletParams: any
      • rootPrivateKey: optional hex-encoded Ripple private key
    • keychains: any

    Returns Bluebird<any>

supportsBlockTarget

  • supportsBlockTarget(): boolean

transactionDataAllowed

  • transactionDataAllowed(): boolean

url

  • url(suffix: string): string

valuelessTransferAllowed

  • valuelessTransferAllowed(): boolean

verifyAddress

  • verifyAddress(__namedParameters: object): boolean
  • Check if address is a valid XRP address, and then make sure the root addresses match. This prevents attacks where an attack may switch out the new address for one of their own

    Parameters

    • __namedParameters: object

    Returns boolean

verifyRecoveryTransaction

verifyTransaction

  • verifyTransaction(__namedParameters: object, callback: any): Bluebird<boolean>

wallets

webhooks

Static createInstance

Generated using TypeDoc