Options
All
  • Public
  • Public/Protected
  • All
Menu

ripple-lib

Index

References

Classes

Interfaces

Type aliases

Properties

Functions

References

deriveXAddress

Renames and exports __type

Type aliases

FormattedTransactionType

FormattedTransactionType: FormattedPaymentTransaction | FormattedOrderTransaction | FormattedOrderCancellationTransaction | FormattedTrustlineTransaction | FormattedSettingsTransaction

PathFindRequest

PathFindRequest: PathFindCreateRequest | PathFindCloseRequest | PathFindStatusRequest

Request

Request: AccountChannelsRequest | AccountCurrenciesRequest | AccountInfoRequest | AccountLinesRequest | AccountObjectsRequest | AccountOffersRequest | AccountTxRequest | GatewayBalancesRequest | NoRippleCheckRequest | LedgerRequest | LedgerClosedRequest | LedgerCurrentRequest | LedgerDataRequest | LedgerEntryRequest | SubmitRequest | SubmitMultisignedRequest | TransactionEntryRequest | TxRequest | BookOffersRequest | DepositAuthorizedRequest | PathFindRequest | RipplePathFindRequest | ChannelVerifyRequest | SubscribeRequest | UnsubscribeRequest | FeeRequest | ManifestRequest | ServerInfoRequest | ServerStateRequest | PingRequest | RandomRequest

Response

Response: AccountChannelsResponse | AccountCurrenciesResponse | AccountInfoResponse | AccountLinesResponse | AccountObjectsResponse | AccountOffersResponse | AccountTxResponse | GatewayBalancesResponse | NoRippleCheckResponse | LedgerResponse | LedgerClosedResponse | LedgerCurrentResponse | LedgerDataResponse | LedgerEntryResponse | SubmitResponse | SubmitMultisignedResponse | TransactionEntryResponse | TxResponse | BookOffersResponse | DepositAuthorizedResponse | PathFindResponse | RipplePathFindResponse | ChannelVerifyResponse | SubscribeResponse | UnsubscribeResponse | FeeResponse | ManifestResponse | ServerInfoResponse | ServerStateResponse | PingResponse | RandomResponse

Stream

Stream: LedgerStream | ValidationStream | TransactionStream | PathFindStream | PeerStatusStream | OrderBookStream | ConsensusStream

Properties

deriveAddress

deriveAddress: (publicKey: any) => string

Type declaration

    • (publicKey: any): string

    • Parameters

      • publicKey: any

      Returns string

deriveKeypair

deriveKeypair: (seed: string, options?: object) => { privateKey: string; publicKey: string }

Type declaration

    • (seed: string, options?: object): { privateKey: string; publicKey: string }

    • Parameters

      • seed: string
      • Optional options: object

      Returns { privateKey: string; publicKey: string }

      • privateKey: string
      • publicKey: string

Functions

ISOTimeToRippleTime

  • ISOTimeToRippleTime(iso8601: string): number

  • Parameters

    • iso8601: string

      International standard date format.

    Returns number

    Seconds since ripple epoch (1/1/2000 GMT).

Const computeAccountRootIndex

  • computeAccountRootIndex(address: string): string

  • Compute Account Root Index.

    All objects in a ledger's state tree have a unique index. The Account Root index is derived by hashing the address with a namespace identifier. This ensures every index is unique.

    See Ledger Object IDs.

    Parameters

    • address: string

      The classic account address.

    Returns string

    The Ledger Object Index for the account.

Const computeBinaryTransactionHash

  • computeBinaryTransactionHash(txBlobHex: string): string

Const computeBinaryTransactionSigningHash

  • computeBinaryTransactionSigningHash(txBlobHex: string): string

  • Hash the given binary transaction data with the single-signing prefix.

    See Serialization Format.

    Parameters

    • txBlobHex: string

      The binary transaction blob as a hexadecimal string.

    Returns string

    The hash to sign.

Const computeEscrowHash

  • computeEscrowHash(address: any, sequence: any): string

Const computeLedgerHash

  • computeLedgerHash(ledgerHeader: any): string

computeLedgerHeaderHash

  • computeLedgerHeaderHash(ledger: any, options?: ComputeLedgerHeaderHashOptions): string

Const computeOfferIndex

  • computeOfferIndex(address: string, sequence: number): string

  • Offer ID Format.

    The index of a Offer object is the SHA-512Half of the following values, concatenated in order:

    • The Offer space key (0x006F)
    • The AccountID of the account placing the offer
    • The Sequence number of the OfferCreate transaction that created the offer.

    This method computes an Offer Index (aka Order Index).

    Parameters

    • address: string

      The classic account address of the SignerList owner (starting with r).

    • sequence: number

    Returns string

    The index of the account's Offer object.

Const computePaymentChannelHash

  • computePaymentChannelHash(address: any, dstAddress: any, sequence: any): string

Const computeSignerListIndex

  • computeSignerListIndex(address: string): string

  • SignerList ID Format.

    The index of a SignerList object is the SHA-512Half of the following values, concatenated in order:

    • The RippleState space key (0x0053)
    • The AccountID of the owner of the SignerList
    • The SignerListID (currently always 0).

    This method computes a SignerList index.

    Parameters

    • address: string

      The classic account address of the SignerList owner (starting with r).

    Returns string

    The ID of the account's SignerList object.

Const computeStateTreeHash

  • computeStateTreeHash(entries: any[]): string

Const computeTransactionHash

  • computeTransactionHash(txJSON: any): string

Const computeTransactionTreeHash

  • computeTransactionTreeHash(transactions: any[]): string

Const computeTrustlineHash

  • computeTrustlineHash(address1: string, address2: string, currency: string): string

convertKeysFromSnakeCaseToCamelCase

  • convertKeysFromSnakeCaseToCamelCase(obj: any): any

dropsToXrp

  • dropsToXrp(drops: BigNumber.Value): string

generateXAddress

  • generateXAddress(options?: GenerateAddressOptions): GeneratedAddress

isValidSecret

  • isValidSecret(secret: string): boolean

removeUndefined

  • removeUndefined<T>(obj: T): T

rippleTimeToISOTime

  • rippleTimeToISOTime(rippleTime: number): string

  • Parameters

    • rippleTime: number

      Is the number of seconds since Ripple Epoch (1/1/2000 GMT).

    Returns string

    Iso8601 international standard date format.

signPaymentChannelClaim

  • signPaymentChannelClaim(channel: string, amount: string, privateKey: string): string

toRippledAmount

  • toRippledAmount(amount: RippledAmount): RippledAmount

verifyPaymentChannelClaim

  • verifyPaymentChannelClaim(channel: string, amount: string, signature: string, publicKey: string): boolean

xrpToDrops

  • xrpToDrops(xrp: BigNumber.Value): string

Generated using TypeDoc