Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Accessors

type

  • get type(): string

Static coinTokenPatternSeparator

  • get coinTokenPatternSeparator(): string

Methods

allowsAccountConsolidations

  • allowsAccountConsolidations(): boolean

baseUnitsToBigUnits

  • baseUnitsToBigUnits(baseUnits: string | number): string

bigUnitsToBaseUnits

  • bigUnitsToBaseUnits(bigUnits: string | number): string

deriveKeyWithSeed

  • deriveKeyWithSeed(__namedParameters: object): object

enterprises

explainTransaction

feeEstimate

generateKeyPair

  • generateKeyPair(seed?: Buffer): KeyPair

getAddressDetails

  • getAddressDetails(address: string): Address

getBaseFactor

  • getBaseFactor(): number

getChain

  • getChain(): string

getExtraPrebuildParams

getFamily

  • getFamily(): string

getFeeInfo

  • getFeeInfo(_?: any, callback?: any): Promise<FeeInfo>

getFullName

  • getFullName(): string

getRippledUrl

  • getRippledUrl(): string

initiateRecovery

isValidAddress

  • isValidAddress(address: string): boolean

isValidMofNSetup

  • isValidMofNSetup(__namedParameters: object): boolean

isValidPub

  • isValidPub(pub: string): boolean

keyIdsForSigning

  • keyIdsForSigning(): number[]

keychains

markets

newWalletObject

  • newWalletObject(walletParams: any): Wallet

normalizeAddress

  • normalizeAddress(__namedParameters: object): 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, callback?: NodeCallback<Buffer>): Bluebird<Buffer>

signTransaction

  • signTransaction(__namedParameters: object, callback?: NodeCallback<HalfSignedTransaction>): Bluebird<HalfSignedTransaction>

supplementGenerateWallet

  • supplementGenerateWallet(walletParams: SupplementGenerateWalletOptions): Bluebird<SupplementGenerateWalletOptions>
  • 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: SupplementGenerateWalletOptions
      • rootPrivateKey: optional hex-encoded Ripple private key

    Returns Bluebird<SupplementGenerateWalletOptions>

supportsBlockTarget

  • supportsBlockTarget(): boolean

transactionDataAllowed

  • transactionDataAllowed(): boolean

url

  • url(suffix: string): string

valuelessTransferAllowed

  • valuelessTransferAllowed(): boolean

verifyAddress

  • verifyAddress(__namedParameters: object): boolean

verifyRecoveryTransaction

verifyTransaction

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

wallets

webhooks

Static createInstance

Generated using TypeDoc