Expose new request interface, implement first few request typings

src/api.ts

@@ -39,6 +39,14 @@ import signPaymentChannelClaim from './offline/sign-payment-channel-claim'
 import verifyPaymentChannelClaim from './offline/verify-payment-channel-claim'
 import getLedger from './ledger/ledger'
 
+import {
+  AccountOffersRequest, AccountOffersResponse,
+  AccountInfoRequest, AccountInfoResponse,
+  AccountLinesRequest, AccountLinesResponse,
+  BookOffersRequest, BookOffersResponse,
+  GatewayBalancesRequest, GatewayBalancesResponse
+} from './common/types/commands'
+
 
 import RangeSet from './common/rangeset'
 import * as ledgerUtils from './ledger/utils'
@@ -52,6 +60,23 @@ type APIOptions = {
   timeout?: number
 }
 
+/**
+ * Get the response key / property name that contains the listed data for a
+ * command. This varies from command to command, but we need to know it to
+ * properly count across many requests.
+ */
+function getCollectKeyFromCommand(command: string): string|undefined {
+  switch (command) {
+    case 'account_offers':
+    case 'book_offers':
+      return 'offers'
+    case 'account_lines':
+      return 'lines'
+    default:
+      return undefined
+  }
+}
+
 // prevent access to non-validated ledger versions
 class RestrictedConnection extends Connection {
   request(request: any, timeout?: number) {
@@ -106,6 +131,84 @@ class RippleAPI extends EventEmitter {
     }
   }
 
+  /**
+   * Makes a simple request to the API with the given command and any
+   * additional request body parameters.
+   *
+   * NOTE: This command is under development and should not yet be relied
+   * on by external consumers.
+   */
+  async _request(command: 'account_info', params: AccountInfoRequest):
+    Promise<AccountInfoResponse>
+  async _request(command: 'account_lines', params: AccountLinesRequest):
+    Promise<AccountLinesResponse>
+  async _request(command: 'account_offers', params: AccountOffersRequest):
+  Promise<AccountOffersResponse>
+  async _request(command: 'book_offers', params: BookOffersRequest):
+    Promise<BookOffersResponse>
+  async _request(command: 'gateway_balances', params: GatewayBalancesRequest):
+    Promise<GatewayBalancesResponse>
+  async _request(command: string, params: any = {}) {
+    return this.connection.request({
+      ...params,
+      command
+    })
+  }
+
+  /**
+   * Makes multiple paged requests to the API to return a given number of
+   * resources. __requestAll() will make multiple requests until the `limit`
+   * number of resources is reached (if no `limit` is provided, a single request
+   * will be made).
+   *
+   * If the command is unknown, an additional `collect` property is required to
+   * know which response key contains the array of resources.
+   *
+   * NOTE: This command is under development and should not yet be relied
+   * on by external consumers.
+   */
+  async _requestAll(command: 'account_offers', params: AccountOffersRequest):
+    Promise<AccountOffersResponse[]>
+  async _requestAll(command: 'book_offers', params: BookOffersRequest):
+    Promise<BookOffersResponse[]>
+  async _requestAll(command: 'account_lines', params: AccountLinesRequest):
+    Promise<AccountLinesResponse[]>
+  async _requestAll(
+    command: string,
+    params: any = {},
+    options: {collect?: string} = {}): Promise<any[]> {
+    // The data under collection is keyed based on the command. Fail if command
+    // not recognized and collection key not provided.
+    const collectKey = options.collect || getCollectKeyFromCommand(command)
+    if (!collectKey) {
+      throw new errors.ValidationError(`no collect key for command ${command}`)
+    }
+    // If limit is not provided, fetches all data over multiple requests.
+    // NOTE: This may return much more than needed. Set limit when possible.
+    const countTo = (params.limit !== undefined) ? params.limit : Infinity
+    const results = []
+    let count = 0
+    let marker = params.marker
+    let lastBatchLength
+    do {
+      const countRemaining = countTo - count
+      const repeatProps = {
+        ...params,
+        limit: countRemaining,
+        marker
+      }
+      // NOTE: We have to generalize the `this._request()` function signature
+      // here until we add support for unknown commands (since command is some
+      // unknown string).
+      const singleResult = await (<Function>this._request)(command, repeatProps)
+      marker = singleResult.marker
+      count += singleResult[collectKey].length
+      lastBatchLength = singleResult[collectKey].length
+      results.push(singleResult)
+    } while(!!marker && count < countTo && lastBatchLength !== 0)
+    return results
+  }
+
   connect = connect
   disconnect = disconnect
   isConnected = isConnected

src/common/types/commands/account_info.ts

@@ -0,0 +1,36 @@
+import {AccountRoot, SignerList} from '../objects'
+
+export interface AccountInfoRequest {
+  account: string,
+  strict?: boolean,
+  queue?: boolean,
+  ledger_hash?: string,
+  ledger_index?: number | ('validated' | 'closed' | 'current'),
+  signer_lists?: boolean
+}
+
+export interface AccountInfoResponse {
+  account_data: AccountRoot,
+  signer_lists?: SignerList[],
+  ledger_current_index?: number,
+  ledger_index?: number,
+  queue_data?: QueueData,
+  validated?: boolean
+}
+
+interface QueueData {
+  txn_count: number,
+  auth_change_queued?: boolean,
+  lowest_sequence?: number,
+  highest_sequence?: number,
+  max_spend_drops_total?: string,
+  transactions?: TransactionData[]
+}
+
+interface TransactionData {
+  auth_change?: boolean,
+  fee?: string,
+  fee_level?: string,
+  max_spend_drops?: string,
+  seq?: number
+}

src/common/types/commands/account_lines.ts

@@ -0,0 +1,19 @@
+import {Trustline} from '../objects'
+
+export interface AccountLinesRequest {
+  account: string,
+  ledger_hash?: string,
+  ledger_index?: number | ('validated' | 'closed' | 'current'),
+  peer?: string,
+  limit?: number,
+  marker?: any,
+}
+
+export interface AccountLinesResponse {
+  account: string,
+  lines: Trustline[],
+  ledger_current_index?: number,
+  ledger_index?: number,
+  ledger_hash?: string,
+  marker?: any,
+}

src/common/types/commands/account_offers.ts

@@ -0,0 +1,27 @@
+import {RippledAmount} from '../objects'
+
+export interface AccountOffersRequest {
+  account: string,
+  ledger_hash?: string,
+  ledger_index?: number | ('validated' | 'closed' | 'current'),
+  limit?: number,
+  marker?: any,
+}
+
+export interface AccountOffersResponse {
+  account: string,
+  ledger_hash?: string,
+  ledger_current_index?: number,
+  ledger_index?: number,
+  marker?: any,
+  offers?: AccountOffer[],
+}
+
+export interface AccountOffer {
+  seq: number,
+  flags: number,
+  taker_gets: RippledAmount,
+  taker_pays: RippledAmount,
+  quality: string,
+  expiration?: number
+}

src/common/types/commands/book_offers.ts

@@ -0,0 +1,31 @@
+import {
+  TakerRequestAmount,
+  OfferCreateTransaction,
+  RippledAmount
+} from '../objects'
+
+export interface BookOffersRequest {
+  taker?: string,
+  taker_gets: TakerRequestAmount,
+  taker_pays: TakerRequestAmount,
+  ledger_hash?: string,
+  ledger_index?: number | ('validated' | 'closed' | 'current'),
+  limit?: number,
+  marker?: any
+}
+
+export interface BookOffersResponse {
+  account: string,
+  offers: OrderBookOffer[],
+  ledger_hash?: string,
+  ledger_current_index?: number,
+  ledger_index?: number,
+  marker?: any
+}
+
+interface OrderBookOffer extends OfferCreateTransaction {
+  quality?: number
+  owner_funds?: string,
+  taker_gets_funded?: RippledAmount,
+  taker_pays_funded?: RippledAmount
+}

src/common/types/commands/gateway_balances.ts

@@ -0,0 +1,20 @@
+import {Amount} from '../objects'
+
+
+export interface GatewayBalancesRequest {
+  account: string,
+  strict?: boolean,
+  hotwallet: string|Array<string>,
+  ledger_hash?: string,
+  ledger_index?: number | ('validated' | 'closed' | 'current')
+}
+
+export interface GatewayBalancesResponse {
+  account: string,
+  obligations?: {[currency: string]: string},
+  balances?: {[address: string]: Amount[]},
+  assets?: {[address: string]: Amount[]},
+  ledger_hash?: string,
+  ledger_current_index?: number,
+  ledger_index?: number
+}

src/common/types/commands/index.ts

@@ -0,0 +1,5 @@
+export * from './account_info'
+export * from './account_lines'
+export * from './account_offers'
+export * from './book_offers'
+export * from './gateway_balances'

src/common/types/objects/accounts.ts

@@ -0,0 +1,17 @@
+export interface AccountRoot {
+  LedgerEntryType: string,
+  Account: string,
+  Flags: number,
+  Sequence: number,
+  Balance: string,
+  OwnerCount: number,
+  PreviousTxnID: string,
+  PreviousTxnLgrSeq: number,
+  AccountTxnID?: string,
+  RegularKey?: string,
+  EmailHash?: string,
+  MessageKey?: string
+  TickSize?: number,
+  TransferRate?: number,
+  Domain?: string
+}

src/common/types/objects/adjustments.ts

@@ -0,0 +1,19 @@
+import {Amount} from './amounts'
+
+export type Adjustment = {
+  address: string,
+  amount: Amount,
+  tag?: number
+}
+
+export type MaxAdjustment = {
+  address: string,
+  maxAmount: Amount,
+  tag?: number
+}
+
+export type MinAdjustment = {
+  address: string,
+  minAmount: Amount,
+  tag?: number
+}

src/common/types/objects/amounts.ts

@@ -0,0 +1,28 @@
+export type Amount = {
+  value: string,
+  currency: string,
+  issuer?: string,
+  counterparty?: string
+}
+
+
+export type RippledAmount = string | Amount
+
+/**
+ * Specification of which currency the account taking the offer would pay/
+ * receive, as an object with currency and issuer fields (omit issuer for XRP).
+ * Similar to currency amounts.
+ */
+export interface TakerRequestAmount {
+  currency: string
+  issuer?: string
+}
+
+/**
+ * A currency-counterparty pair, or just currency if it's XRP.
+ */
+export type Issue = {
+  currency: string,
+  issuer?: string,
+  counterparty?: string
+}