xrpl 2.10.0 → 2.12.0-beta.0

package/src/sugar/autofill.ts

@@ -0,0 +1,373 @@
+import BigNumber from 'bignumber.js'
+import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
+
+import type { Client } from '..'
+import { ValidationError, XrplError } from '../errors'
+import { AccountInfoRequest, AccountObjectsRequest } from '../models/methods'
+import { Transaction } from '../models/transactions'
+import { setTransactionFlagsToNumber } from '../models/utils/flags'
+import { xrpToDrops } from '../utils'
+
+import getFeeXrp from './getFeeXrp'
+
+// Expire unconfirmed transactions after 20 ledger versions, approximately 1 minute, by default
+const LEDGER_OFFSET = 20
+// Sidechains are expected to have network IDs above this.
+// Networks with ID above this restricted number are expected specify an accurate NetworkID field
+// in every transaction to that chain to prevent replay attacks.
+// Mainnet and testnet are exceptions. More context: https://github.com/XRPLF/rippled/pull/4370
+const RESTRICTED_NETWORKS = 1024
+const REQUIRED_NETWORKID_VERSION = '1.11.0'
+const HOOKS_TESTNET_ID = 21338
+interface ClassicAccountAndTag {
+  classicAccount: string
+  tag: number | false | undefined
+}
+
+/**
+ * Autofills fields in a transaction. This will set `Sequence`, `Fee`,
+ * `lastLedgerSequence` according to the current state of the server this Client
+ * is connected to. It also converts all X-Addresses to classic addresses and
+ * flags interfaces into numbers.
+ *
+ * @example
+ *
+ * ```ts
+ * const { Client } = require('xrpl')
+ *
+ * const client = new Client('wss://s.altnet.rippletest.net:51233')
+ *
+ * async function createAndAutofillTransaction() {
+ *   const transaction = {
+ *     TransactionType: 'Payment',
+ *     Account: 'rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh',
+ *     Destination: 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59',
+ *     Amount: '10000000' // 10 XRP in drops (1/1,000,000th of an XRP)
+ *   }
+ *
+ *   try {
+ *     const autofilledTransaction = await client.autofill(transaction)
+ *     console.log(autofilledTransaction)
+ *   } catch (error) {
+ *     console.error(`Failed to autofill transaction: ${error}`)
+ *   }
+ * }
+ *
+ * createAndAutofillTransaction()
+ * ```
+ *
+ * Autofill helps fill in fields which should be included in a transaction, but can be determined automatically
+ * such as `LastLedgerSequence` and `Fee`. If you override one of the fields `autofill` changes, your explicit
+ * values will be used instead. By default, this is done as part of `submit` and `submitAndWait` when you pass
+ * in an unsigned transaction along with your wallet to be submitted.
+ *
+ * @param this - A client.
+ * @param transaction - A {@link Transaction} in JSON format
+ * @param signersCount - The expected number of signers for this transaction.
+ * Only used for multisigned transactions.
+ * @returns The autofilled transaction.
+ */
+async function autofill<T extends Transaction>(
+  this: Client,
+  transaction: T,
+  signersCount?: number,
+): Promise<T> {
+  const tx = { ...transaction }
+
+  setValidAddresses(tx)
+
+  setTransactionFlagsToNumber(tx)
+  const promises: Array<Promise<void>> = []
+  if (tx.NetworkID == null) {
+    tx.NetworkID = txNeedsNetworkID(this) ? this.networkID : undefined
+  }
+  if (tx.Sequence == null) {
+    promises.push(setNextValidSequenceNumber(this, tx))
+  }
+  if (tx.Fee == null) {
+    promises.push(calculateFeePerTransactionType(this, tx, signersCount))
+  }
+  if (tx.LastLedgerSequence == null) {
+    promises.push(setLatestValidatedLedgerSequence(this, tx))
+  }
+  if (tx.TransactionType === 'AccountDelete') {
+    promises.push(checkAccountDeleteBlockers(this, tx))
+  }
+
+  return Promise.all(promises).then(() => tx)
+}
+
+/**
+ * Determines whether the source rippled version is not later than the target rippled version.
+ * Example usage: isNotLaterRippledVersion('1.10.0', '1.11.0') returns true.
+ *                isNotLaterRippledVersion('1.10.0', '1.10.0-b1') returns false.
+ *
+ * @param source -- The source rippled version.
+ * @param target -- The target rippled version.
+ * @returns True if source is earlier than target, false otherwise.
+ */
+// eslint-disable-next-line max-lines-per-function, max-statements -- Disable for this helper functions.
+function isNotLaterRippledVersion(source: string, target: string): boolean {
+  if (source === target) {
+    return true
+  }
+  const sourceDecomp = source.split('.')
+  const targetDecomp = target.split('.')
+  const sourceMajor = parseInt(sourceDecomp[0], 10)
+  const sourceMinor = parseInt(sourceDecomp[1], 10)
+  const targetMajor = parseInt(targetDecomp[0], 10)
+  const targetMinor = parseInt(targetDecomp[1], 10)
+  // Compare major version
+  if (sourceMajor !== targetMajor) {
+    return sourceMajor < targetMajor
+  }
+  // Compare minor version
+  if (sourceMinor !== targetMinor) {
+    return sourceMinor < targetMinor
+  }
+  const sourcePatch = sourceDecomp[2].split('-')
+  const targetPatch = targetDecomp[2].split('-')
+
+  const sourcePatchVersion = parseInt(sourcePatch[0], 10)
+  const targetPatchVersion = parseInt(targetPatch[0], 10)
+
+  // Compare patch version
+  if (sourcePatchVersion !== targetPatchVersion) {
+    return sourcePatchVersion < targetPatchVersion
+  }
+
+  // Compare release version
+  if (sourcePatch.length !== targetPatch.length) {
+    return sourcePatch.length > targetPatch.length
+  }
+
+  if (sourcePatch.length === 2) {
+    // Compare different release types
+    if (!sourcePatch[1][0].startsWith(targetPatch[1][0])) {
+      return sourcePatch[1] < targetPatch[1]
+    }
+    // Compare beta version
+    if (sourcePatch[1].startsWith('b')) {
+      return (
+        parseInt(sourcePatch[1].slice(1), 10) <
+        parseInt(targetPatch[1].slice(1), 10)
+      )
+    }
+    // Compare rc version
+    return (
+      parseInt(sourcePatch[1].slice(2), 10) <
+      parseInt(targetPatch[1].slice(2), 10)
+    )
+  }
+
+  return false
+}
+
+/**
+ * Determine if the transaction required a networkID to be valid.
+ * Transaction needs networkID if later than restricted ID and either the network is hooks testnet
+ * or build version is >= 1.11.0
+ *
+ * @param client -- The connected client.
+ * @returns True if required networkID, false otherwise.
+ */
+function txNeedsNetworkID(client: Client): boolean {
+  if (
+    client.networkID !== undefined &&
+    client.networkID > RESTRICTED_NETWORKS
+  ) {
+    // TODO: remove the buildVersion logic when 1.11.0 is out and widely used.
+    // Issue: https://github.com/XRPLF/xrpl.js/issues/2339
+    if (
+      (client.buildVersion &&
+        isNotLaterRippledVersion(
+          REQUIRED_NETWORKID_VERSION,
+          client.buildVersion,
+        )) ||
+      client.networkID === HOOKS_TESTNET_ID
+    ) {
+      return true
+    }
+  }
+  return false
+}
+
+function setValidAddresses(tx: Transaction): void {
+  validateAccountAddress(tx, 'Account', 'SourceTag')
+  // eslint-disable-next-line @typescript-eslint/dot-notation -- Destination can exist on Transaction
+  if (tx['Destination'] != null) {
+    validateAccountAddress(tx, 'Destination', 'DestinationTag')
+  }
+
+  // DepositPreauth:
+  convertToClassicAddress(tx, 'Authorize')
+  convertToClassicAddress(tx, 'Unauthorize')
+  // EscrowCancel, EscrowFinish:
+  convertToClassicAddress(tx, 'Owner')
+  // SetRegularKey:
+  convertToClassicAddress(tx, 'RegularKey')
+}
+
+function validateAccountAddress(
+  tx: Transaction,
+  accountField: string,
+  tagField: string,
+): void {
+  // if X-address is given, convert it to classic address
+  const { classicAccount, tag } = getClassicAccountAndTag(tx[accountField])
+  // eslint-disable-next-line no-param-reassign -- param reassign is safe
+  tx[accountField] = classicAccount
+
+  if (tag != null && tag !== false) {
+    if (tx[tagField] && tx[tagField] !== tag) {
+      throw new ValidationError(
+        `The ${tagField}, if present, must match the tag of the ${accountField} X-address`,
+      )
+    }
+    // eslint-disable-next-line no-param-reassign -- param reassign is safe
+    tx[tagField] = tag
+  }
+}
+
+function getClassicAccountAndTag(
+  Account: string,
+  expectedTag?: number,
+): ClassicAccountAndTag {
+  if (isValidXAddress(Account)) {
+    const classic = xAddressToClassicAddress(Account)
+    if (expectedTag != null && classic.tag !== expectedTag) {
+      throw new ValidationError(
+        'address includes a tag that does not match the tag specified in the transaction',
+      )
+    }
+    return {
+      classicAccount: classic.classicAddress,
+      tag: classic.tag,
+    }
+  }
+  return {
+    classicAccount: Account,
+    tag: expectedTag,
+  }
+}
+
+function convertToClassicAddress(tx: Transaction, fieldName: string): void {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- assignment is safe
+  const account = tx[fieldName]
+  if (typeof account === 'string') {
+    const { classicAccount } = getClassicAccountAndTag(account)
+    // eslint-disable-next-line no-param-reassign -- param reassign is safe
+    tx[fieldName] = classicAccount
+  }
+}
+
+async function setNextValidSequenceNumber(
+  client: Client,
+  tx: Transaction,
+): Promise<void> {
+  const request: AccountInfoRequest = {
+    command: 'account_info',
+    account: tx.Account,
+    ledger_index: 'current',
+  }
+  const data = await client.request(request)
+  // eslint-disable-next-line no-param-reassign, require-atomic-updates -- param reassign is safe with no race condition
+  tx.Sequence = data.result.account_data.Sequence
+}
+
+async function fetchOwnerReserveFee(client: Client): Promise<BigNumber> {
+  const response = await client.request({ command: 'server_state' })
+  const fee = response.result.state.validated_ledger?.reserve_inc
+
+  if (fee == null) {
+    return Promise.reject(new Error('Could not fetch Owner Reserve.'))
+  }
+
+  return new BigNumber(fee)
+}
+
+async function calculateFeePerTransactionType(
+  client: Client,
+  tx: Transaction,
+  signersCount = 0,
+): Promise<void> {
+  // netFee is usually 0.00001 XRP (10 drops)
+  const netFeeXRP = await getFeeXrp(client)
+  const netFeeDrops = xrpToDrops(netFeeXRP)
+  let baseFee = new BigNumber(netFeeDrops)
+
+  // EscrowFinish Transaction with Fulfillment
+  if (tx.TransactionType === 'EscrowFinish' && tx.Fulfillment != null) {
+    const fulfillmentBytesSize: number = Math.ceil(tx.Fulfillment.length / 2)
+    // 10 drops × (33 + (Fulfillment size in bytes / 16))
+    const product = new BigNumber(
+      // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- expected use of magic numbers
+      scaleValue(netFeeDrops, 33 + fulfillmentBytesSize / 16),
+    )
+    baseFee = product.dp(0, BigNumber.ROUND_CEIL)
+  }
+
+  if (
+    tx.TransactionType === 'AccountDelete' ||
+    tx.TransactionType === 'AMMCreate'
+  ) {
+    baseFee = await fetchOwnerReserveFee(client)
+  }
+
+  /*
+   * Multi-signed Transaction
+   * 10 drops × (1 + Number of Signatures Provided)
+   */
+  if (signersCount > 0) {
+    baseFee = BigNumber.sum(baseFee, scaleValue(netFeeDrops, 1 + signersCount))
+  }
+
+  const maxFeeDrops = xrpToDrops(client.maxFeeXRP)
+  const totalFee =
+    tx.TransactionType === 'AccountDelete'
+      ? baseFee
+      : BigNumber.min(baseFee, maxFeeDrops)
+
+  // Round up baseFee and return it as a string
+  // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-magic-numbers -- param reassign is safe, base 10 magic num
+  tx.Fee = totalFee.dp(0, BigNumber.ROUND_CEIL).toString(10)
+}
+
+function scaleValue(value, multiplier): string {
+  return new BigNumber(value).times(multiplier).toString()
+}
+
+async function setLatestValidatedLedgerSequence(
+  client: Client,
+  tx: Transaction,
+): Promise<void> {
+  const ledgerSequence = await client.getLedgerIndex()
+  // eslint-disable-next-line no-param-reassign -- param reassign is safe
+  tx.LastLedgerSequence = ledgerSequence + LEDGER_OFFSET
+}
+
+async function checkAccountDeleteBlockers(
+  client: Client,
+  tx: Transaction,
+): Promise<void> {
+  const request: AccountObjectsRequest = {
+    command: 'account_objects',
+    account: tx.Account,
+    ledger_index: 'validated',
+    deletion_blockers_only: true,
+  }
+  const response = await client.request(request)
+  return new Promise((resolve, reject) => {
+    if (response.result.account_objects.length > 0) {
+      reject(
+        new XrplError(
+          `Account ${tx.Account} cannot be deleted; there are Escrows, PayChannels, RippleStates, or Checks associated with the account.`,
+          response.result.account_objects,
+        ),
+      )
+    }
+    resolve()
+  })
+}
+
+export default autofill

package/src/sugar/balances.ts

@@ -0,0 +1,123 @@
+import flatMap from 'lodash/flatMap'
+
+import type { Balance, Client } from '..'
+import {
+  AccountLinesRequest,
+  AccountLinesTrustline,
+  LedgerIndex,
+  AccountInfoRequest,
+} from '../models'
+import { dropsToXrp } from '../utils'
+
+function formatBalances(trustlines: AccountLinesTrustline[]): Balance[] {
+  return trustlines.map((trustline) => ({
+    value: trustline.balance,
+    currency: trustline.currency,
+    issuer: trustline.account,
+  }))
+}
+
+/**
+ * Get the XRP balance for an account.
+ *
+ * @example
+ * ```ts
+ * const client = new Client(wss://s.altnet.rippletest.net:51233)
+ * const balance = await client.getXrpBalance('rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn')
+ * console.log(balance)
+ * /// '200'
+ * ```
+ *
+ * @param this - Client.
+ * @param address - Address of the account to retrieve XRP balance.
+ * @param options - Options to include for getting the XRP balance.
+ * @param options.ledger_index - Retrieve the account balances at a given
+ * ledger_index.
+ * @param options.ledger_hash - Retrieve the account balances at the ledger with
+ * a given ledger_hash.
+ * @returns The XRP balance of the account (as a string).
+ */
+async function getXrpBalance(
+  this: Client,
+  address: string,
+  options: {
+    ledger_hash?: string
+    ledger_index?: LedgerIndex
+  } = {},
+): Promise<string> {
+  const xrpRequest: AccountInfoRequest = {
+    command: 'account_info',
+    account: address,
+    ledger_index: options.ledger_index ?? 'validated',
+    ledger_hash: options.ledger_hash,
+  }
+  const response = await this.request(xrpRequest)
+  return dropsToXrp(response.result.account_data.Balance)
+}
+
+/**
+ * Get XRP/non-XRP balances for an account.
+ *
+ * @param this - Client.
+ * @param address - Address of the account to retrieve balances for.
+ * @param options - Allows the client to specify a ledger_hash, ledger_index,
+ * filter by peer, and/or limit number of balances.
+ * @param options.ledger_index - Retrieve the account balances at a given
+ * ledger_index.
+ * @param options.ledger_hash - Retrieve the account balances at the ledger with
+ * a given ledger_hash.
+ * @param options.peer - Filter balances by peer.
+ * @param options.limit - Limit number of balances to return.
+ * @returns An array of XRP/non-XRP balances for the given account.
+ */
+// eslint-disable-next-line max-lines-per-function -- Longer definition is required for end users to see the definition.
+async function getBalances(
+  this: Client,
+  address: string,
+  options: {
+    ledger_hash?: string
+    ledger_index?: LedgerIndex
+    peer?: string
+    limit?: number
+  } = {},
+): Promise<
+  Array<{ value: string; currency: string; issuer?: string | undefined }>
+> {
+  const balances: Balance[] = []
+
+  // get XRP balance
+  let xrpPromise: Promise<string> = Promise.resolve('')
+  if (!options.peer) {
+    xrpPromise = this.getXrpBalance(address, {
+      ledger_hash: options.ledger_hash,
+      ledger_index: options.ledger_index,
+    })
+  }
+
+  // get non-XRP balances
+  const linesRequest: AccountLinesRequest = {
+    command: 'account_lines',
+    account: address,
+    ledger_index: options.ledger_index ?? 'validated',
+    ledger_hash: options.ledger_hash,
+    peer: options.peer,
+    limit: options.limit,
+  }
+  const linesPromise = this.requestAll(linesRequest)
+
+  // combine results
+  await Promise.all([xrpPromise, linesPromise]).then(
+    ([xrpBalance, linesResponses]) => {
+      const accountLinesBalance = flatMap(linesResponses, (response) =>
+        formatBalances(response.result.lines),
+      )
+      if (xrpBalance !== '') {
+        balances.push({ currency: 'XRP', value: xrpBalance })
+      }
+      balances.push(...accountLinesBalance)
+    },
+  )
+  return balances.slice(0, options.limit)
+}
+
+export { getXrpBalance, getBalances }

package/src/sugar/getFeeXrp.ts

@@ -0,0 +1,45 @@
+import BigNumber from 'bignumber.js'
+
+import type { Client } from '..'
+import { XrplError } from '../errors'
+
+const NUM_DECIMAL_PLACES = 6
+const BASE_10 = 10
+
+/**
+ * Calculates the current transaction fee for the ledger.
+ * Note: This is a public API that can be called directly.
+ *
+ * @param client - The Client used to connect to the ledger.
+ * @param cushion - The fee cushion to use.
+ * @returns The transaction fee.
+ */
+export default async function getFeeXrp(
+  client: Client,
+  cushion?: number,
+): Promise<string> {
+  const feeCushion = cushion ?? client.feeCushion
+
+  const serverInfo = (await client.request({ command: 'server_info' })).result
+    .info
+
+  const baseFee = serverInfo.validated_ledger?.base_fee_xrp
+
+  if (baseFee == null) {
+    throw new XrplError(
+      'getFeeXrp: Could not get base_fee_xrp from server_info',
+    )
+  }
+
+  const baseFeeXrp = new BigNumber(baseFee)
+  if (serverInfo.load_factor == null) {
+    // https://github.com/ripple/rippled/issues/3812#issuecomment-816871100
+    serverInfo.load_factor = 1
+  }
+  let fee = baseFeeXrp.times(serverInfo.load_factor).times(feeCushion)
+
+  // Cap fee to `client.maxFeeXRP`
+  fee = BigNumber.min(fee, client.maxFeeXRP)
+  // Round fee to 6 decimal places
+  return new BigNumber(fee.toFixed(NUM_DECIMAL_PLACES)).toString(BASE_10)
+}

package/src/sugar/getLedgerIndex.ts

@@ -0,0 +1,15 @@
+import type { Client } from '..'
+
+/**
+ * Returns the index of the most recently validated ledger.
+ *
+ * @param this - The Client used to connect to the ledger.
+ * @returns The most recently validated ledger index.
+ */
+export default async function getLedgerIndex(this: Client): Promise<number> {
+  const ledgerResponse = await this.request({
+    command: 'ledger',
+    ledger_index: 'validated',
+  })
+  return ledgerResponse.result.ledger_index
+}

package/src/sugar/getOrderbook.ts

@@ -0,0 +1,152 @@
+/* eslint-disable max-lines-per-function -- Needs to process orderbooks. */
+import BigNumber from 'bignumber.js'
+import flatMap from 'lodash/flatMap'
+
+import type { Client } from '../client'
+import { ValidationError } from '../errors'
+import { LedgerIndex } from '../models/common'
+import { OfferFlags } from '../models/ledger/Offer'
+import {
+  BookOffer,
+  BookOfferCurrency,
+  BookOffersRequest,
+} from '../models/methods/bookOffers'
+
+const DEFAULT_LIMIT = 20
+
+function sortOffers(offers: BookOffer[]): BookOffer[] {
+  return offers.sort((offerA, offerB) => {
+    const qualityA = offerA.quality ?? 0
+    const qualityB = offerB.quality ?? 0
+
+    return new BigNumber(qualityA).comparedTo(qualityB)
+  })
+}
+
+const getOrderbookOptionsSet = new Set([
+  'limit',
+  'ledger_index',
+  'ledger_hash',
+  'taker',
+])
+
+/**
+ * Fetch orderbook (buy/sell orders) between two currency pairs. This checks both sides of the orderbook
+ * by making two `order_book` requests (with the second reversing takerPays and takerGets). Returned offers are
+ * not normalized in this function, so either currency could be takerGets or takerPays.
+ *
+ * @param this - Client.
+ * @param currency1 - Specification of one currency involved. (With a currency code and optionally an issuer)
+ * @param currency2 - Specification of a second currency involved. (With a currency code and optionally an issuer)
+ * @param options - Options allowing the client to specify ledger_index,
+ * ledger_hash, filter by taker, and/or limit number of orders.
+ * @param options.ledger_index - Retrieve the orderbook at a given ledger_index.
+ * @param options.ledger_hash - Retrieve the orderbook at the ledger with a
+ * given ledger_hash.
+ * @param options.taker - Filter orders by taker.
+ * @param options.limit - The limit passed into each book_offers request.
+ * Can return more than this due to two calls being made. Defaults to 20.
+ * @returns An object containing buy and sell objects.
+ */
+// eslint-disable-next-line max-params, complexity -- Once bound to Client, getOrderbook only has 3 parameters.
+async function getOrderbook(
+  this: Client,
+  currency1: BookOfferCurrency,
+  currency2: BookOfferCurrency,
+  options: {
+    limit?: number
+    ledger_index?: LedgerIndex
+    ledger_hash?: string | null
+    taker?: string | null
+  } = {},
+): Promise<{
+  buy: BookOffer[]
+  sell: BookOffer[]
+}> {
+  Object.keys(options).forEach((key) => {
+    if (!getOrderbookOptionsSet.has(key)) {
+      throw new ValidationError(`Unexpected option: ${key}`, options)
+    }
+  })
+
+  if (options.limit && typeof options.limit !== 'number') {
+    throw new ValidationError('limit must be a number', options.limit)
+  }
+
+  if (
+    options.ledger_index &&
+    !(
+      typeof options.ledger_index === 'number' ||
+      (typeof options.ledger_index === 'string' &&
+        ['validated', 'closed', 'current'].includes(options.ledger_index))
+    )
+  ) {
+    throw new ValidationError(
+      'ledger_index must be a number or a string of "validated", "closed", or "current"',
+      options.ledger_index,
+    )
+  }
+
+  if (
+    options.ledger_hash !== undefined &&
+    options.ledger_hash !== null &&
+    typeof options.ledger_hash !== 'string'
+  ) {
+    throw new ValidationError(
+      'ledger_hash must be a string',
+      options.ledger_hash,
+    )
+  }
+
+  if (options.taker !== undefined && typeof options.taker !== 'string') {
+    throw new ValidationError('taker must be a string', options.taker)
+  }
+
+  const request: BookOffersRequest = {
+    command: 'book_offers',
+    taker_pays: currency1,
+    taker_gets: currency2,
+    ledger_index: options.ledger_index ?? 'validated',
+    ledger_hash: options.ledger_hash === null ? undefined : options.ledger_hash,
+    limit: options.limit ?? DEFAULT_LIMIT,
+    taker: options.taker ? options.taker : undefined,
+  }
+  // 2. Make Request
+  const directOfferResults = await this.requestAll(request)
+  request.taker_gets = currency1
+  request.taker_pays = currency2
+  const reverseOfferResults = await this.requestAll(request)
+  // 3. Return Formatted Response
+  const directOffers = flatMap(
+    directOfferResults,
+    (directOfferResult) => directOfferResult.result.offers,
+  )
+  const reverseOffers = flatMap(
+    reverseOfferResults,
+    (reverseOfferResult) => reverseOfferResult.result.offers,
+  )
+
+  const orders = [...directOffers, ...reverseOffers]
+  // separate out the buy and sell orders
+  const buy: BookOffer[] = []
+  const sell: BookOffer[] = []
+  orders.forEach((order) => {
+    // eslint-disable-next-line no-bitwise -- necessary for flags check
+    if ((order.Flags & OfferFlags.lsfSell) === 0) {
+      buy.push(order)
+    } else {
+      sell.push(order)
+    }
+  })
+  /*
+   * Sort the orders
+   * for both buys and sells, lowest quality is closest to mid-market
+   * we sort the orders so that earlier orders are closer to mid-market
+   */
+  return {
+    buy: sortOffers(buy).slice(0, options.limit),
+    sell: sortOffers(sell).slice(0, options.limit),
+  }
+}
+
+export default getOrderbook