xrpl 2.12.0-beta.0 → 2.12.0

package/src/models/ledger/XChainOwnedClaimID.ts

@@ -1,3 +1,5 @@
+import { Amount } from 'ripple-binary-codec/dist/types'
+
 import { XChainBridge } from '../common'
 
 import BaseLedgerEntry from './BaseLedgerEntry'
@@ -35,14 +37,28 @@ export default interface XChainOwnedClaimID extends BaseLedgerEntry {
    */
   OtherChainSource: string
 
-  // TODO: type this better
   /**
    * Attestations collected from the witness servers. This includes the parameters
    * needed to recreate the message that was signed, including the amount, which
    * chain (locking or issuing), optional destination, and reward account for that
    * signature.
    */
-  XChainClaimAttestations: object[]
+  XChainClaimAttestations: Array<{
+    // TODO: add docs
+    XChainClaimProofSig: {
+      Amount: Amount
+
+      AttestationRewardAccount: string
+
+      AttestationSignerAccount: string
+
+      Destination?: string
+
+      PublicKey: string
+
+      WasLockingChainSend: 0 | 1
+    }
+  }>
 
   /**
    * The total amount to pay the witness servers for their signatures. It must be at

package/src/models/ledger/XChainOwnedCreateAccountClaimID.ts

@@ -27,7 +27,6 @@ export default interface XChainOwnedCreateAccountClaimID
    */
   XChainAccountCreateCount: number
 
-  // TODO: type this better
   /**
    * Attestations collected from the witness servers. This includes the parameters
    * needed to recreate the message that was signed, including the amount, destination,
@@ -35,7 +34,22 @@ export default interface XChainOwnedCreateAccountClaimID
    * exception of the reward account, all signatures must sign the message created with
    * common parameters.
    */
-  XChainCreateAccountAttestations: object[]
+  XChainCreateAccountAttestations: Array<{
+    // TODO: add docs
+    XChainCreateAccountProofSig: {
+      Amount: string
+
+      AttestationRewardAccount: string
+
+      AttestationSignerAccount: string
+
+      Destination: string
+
+      PublicKey: string
+
+      WasLockingChainSend: 0 | 1
+    }
+  }>
 
   /**
    * A bit-map of boolean flags. No flags are defined for,

package/src/models/ledger/index.ts

@@ -3,6 +3,7 @@ import AccountRoot, {
   AccountRootFlagsInterface,
 } from './AccountRoot'
 import Amendments, { Majority, AMENDMENTS_ID } from './Amendments'
+import AMM, { VoteSlot } from './AMM'
 import Bridge from './Bridge'
 import Check from './Check'
 import DepositPreauth from './DepositPreauth'
@@ -33,6 +34,7 @@ export {
   AccountRootFlagsInterface,
   AMENDMENTS_ID,
   Amendments,
+  AMM,
   Bridge,
   Check,
   DepositPreauth,
@@ -61,4 +63,5 @@ export {
   Ticket,
   XChainOwnedClaimID,
   XChainOwnedCreateAccountClaimID,
+  VoteSlot,
 }

package/src/models/methods/accountObjects.ts

@@ -1,4 +1,5 @@
 import {
+  AMM,
   Bridge,
   Check,
   DepositPreauth,
@@ -15,6 +16,7 @@ import {
 import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
 
 export type AccountObjectType =
+  | 'amm'
   | 'bridge'
   | 'check'
   | 'deposit_preauth'
@@ -70,6 +72,7 @@ export interface AccountObjectsRequest
  * PayChannel, a SignerList, a Ticket, or a RippleState.
  */
 export type AccountObject =
+  | AMM
   | Bridge
   | Check
   | DepositPreauth

package/src/models/methods/ammInfo.ts

@@ -11,15 +11,20 @@ import { BaseRequest, BaseResponse } from './baseMethod'
 export interface AMMInfoRequest extends BaseRequest {
   command: 'amm_info'
 
+  /**
+   * The address of the AMM Account to look up.
+   */
+  amm_account?: string
+
   /**
    * One of the assets of the AMM pool to look up.
    */
-  asset: Currency
+  asset?: Currency
 
   /**
    * The other asset of the AMM pool.
    */
-  asset2: Currency
+  asset2?: Currency
 }
 
 /**
@@ -93,7 +98,7 @@ export interface AMMInfoResponse extends BaseResponse {
          * The amount, in LP Tokens, that the auction slot holder paid to win the auction slot.
          * This affects the price to outbid the current slot holder.
          */
-        price: Amount
+        price: IssuedCurrencyAmount
 
         /**
          * The current 72-minute time interval this auction slot is in, from 0 to 19.

package/src/models/methods/ledgerEntry.ts

@@ -158,23 +158,23 @@ export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
 
   bridge?: XChainBridge
 
-  xchain_claim_id?:
+  xchain_owned_claim_id?:
     | {
         locking_chain_door: string
         locking_chain_issue: Currency
         issuing_chain_door: string
         issuing_chain_issue: Currency
-        xchain_claim_id: string | number
+        xchain_owned_claim_id: string | number
       }
     | string
 
-  xchain_create_account_claim_id?:
+  xchain_owned_create_account_claim_id?:
     | {
         locking_chain_door: string
         locking_chain_issue: Currency
         issuing_chain_door: string
         issuing_chain_issue: Currency
-        xchain_create_account_claim_id: string | number
+        xchain_owned_create_account_claim_id: string | number
       }
     | string
 }

package/src/models/methods/serverInfo.ts

@@ -33,6 +33,22 @@ export interface JobType {
   in_progress?: number
 }
 
+export type protocol =
+  | 'http'
+  | 'https'
+  | 'grpc'
+  | 'peer'
+  | 'ws'
+  | 'ws2'
+  | 'wss'
+  | 'wss2'
+
+export interface ServerPort {
+  port: string
+  /** The values in protocol are sorted in alphabetical order */
+  protocol: protocol[]
+}
+
 // The states for validating and proposing do not exist in the field state_accounting
 // See https://github.com/XRPLF/rippled/blob/develop/src/ripple/app/misc/NetworkOPs.cpp#L4545
 // https://github.com/XRPLF/rippled/blob/develop/src/ripple/app/misc/NetworkOPs.h#L66
@@ -181,6 +197,11 @@ export interface ServerInfoResponse extends BaseResponse {
       network_ledger?: 'waiting'
       /** How many other rippled servers this one is currently connected to. */
       peers: number
+      /**
+       * What Websocket/RPC ports rippled is listening on. This allows crawlers to build a richer topology without needing to
+       * port-scan nodes. For non-admin users (including peers), info about admin ports is excluded.
+       */
+      ports: ServerPort[]
       /**
        * Public key used to verify this server for peer-to-peer communications.
        * This node key pair is automatically generated by the server the first

package/src/models/transactions/AMMBid.ts

@@ -1,6 +1,5 @@
-/* eslint-disable complexity -- required for validateAMMBid */
 import { ValidationError } from '../../errors'
-import { Amount, AuthAccount, Currency } from '../common'
+import { AuthAccount, Currency, IssuedCurrencyAmount } from '../common'
 
 import {
   BaseTransaction,
@@ -33,18 +32,18 @@ export interface AMMBid extends BaseTransaction {
   Asset2: Currency
 
   /**
-   * Pay at least this amount for the slot.
+   * Pay at least this LPToken amount for the slot.
    * Setting this value higher makes it harder for others to outbid you.
    * If omitted, pay the minimum necessary to win the bid.
    */
-  BidMin?: Amount
+  BidMin?: IssuedCurrencyAmount
 
   /**
-   * Pay at most this amount for the slot.
+   * Pay at most this LPToken amount for the slot.
    * If the cost to win the bid is higher than this amount, the transaction fails.
    * If omitted, pay as much as necessary to win the bid.
    */
-  BidMax?: Amount
+  BidMax?: IssuedCurrencyAmount
 
   /**
    * A list of up to 4 additional accounts that you allow to trade at the discounted fee.

package/src/models/transactions/AMMDeposit.ts

@@ -1,4 +1,3 @@
-/* eslint-disable complexity -- required for validateAMMDeposit */
 import { ValidationError } from '../../errors'
 import { Amount, Currency, IssuedCurrencyAmount } from '../common'
 

package/src/models/transactions/AMMWithdraw.ts

@@ -1,4 +1,3 @@
-/* eslint-disable complexity -- required for validateAMMWithdraw */
 import { ValidationError } from '../../errors'
 import { Amount, Currency, IssuedCurrencyAmount } from '../common'
 

package/src/models/transactions/XChainAccountCreateCommit.ts

@@ -1,4 +1,5 @@
-import { ValidationError } from '../../errors'
+import { isString } from 'lodash'
+
 import { Amount, XChainBridge } from '../common'
 
 import {
@@ -6,6 +7,7 @@ import {
   isAmount,
   isXChainBridge,
   validateBaseTransaction,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -47,61 +49,21 @@ export interface XChainAccountCreateCommit extends BaseTransaction {
 }
 
 /**
- * Verify the form and type of a XChainAccountCreateCommit at runtime.
+ * Verify the form and type of an XChainAccountCreateCommit at runtime.
  *
- * @param tx - A XChainAccountCreateCommit Transaction.
+ * @param tx - An XChainAccountCreateCommit Transaction.
  * @throws When the XChainAccountCreateCommit is malformed.
  */
-// eslint-disable-next-line max-lines-per-function --  okay for this function, there's a lot of things to check
 export function validateXChainAccountCreateCommit(
   tx: Record<string, unknown>,
 ): void {
   validateBaseTransaction(tx)
 
-  if (tx.XChainBridge == null) {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: missing field XChainBridge',
-    )
-  }
-
-  if (!isXChainBridge(tx.XChainBridge)) {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: invalid field XChainBridge',
-    )
-  }
-
-  if (tx.SignatureReward == null) {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: missing field SignatureReward',
-    )
-  }
-
-  if (
-    typeof tx.SignatureReward !== 'number' &&
-    typeof tx.SignatureReward !== 'string'
-  ) {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: invalid field SignatureReward',
-    )
-  }
-
-  if (tx.Destination == null) {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: missing field Destination',
-    )
-  }
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
 
-  if (typeof tx.Destination !== 'string') {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: invalid field Destination',
-    )
-  }
+  validateRequiredField(tx, 'SignatureReward', isAmount)
 
-  if (tx.Amount == null) {
-    throw new ValidationError('XChainAccountCreateCommit: missing field Amount')
-  }
+  validateRequiredField(tx, 'Destination', isString)
 
-  if (!isAmount(tx.Amount)) {
-    throw new ValidationError('XChainAccountCreateCommit: invalid field Amount')
-  }
+  validateRequiredField(tx, 'Amount', isAmount)
 }

package/src/models/transactions/XChainAddAccountCreateAttestation.ts

@@ -1,11 +1,13 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
   BaseTransaction,
   isAmount,
+  isNumber,
+  isString,
   isXChainBridge,
   validateBaseTransaction,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -77,149 +79,43 @@ export interface XChainAddAccountCreateAttestation extends BaseTransaction {
 }
 
 /**
- * Verify the form and type of a XChainAddAccountCreateAttestation at runtime.
+ * Verify the form and type of an XChainAddAccountCreateAttestation at runtime.
  *
- * @param tx - A XChainAddAccountCreateAttestation Transaction.
+ * @param tx - An XChainAddAccountCreateAttestation Transaction.
  * @throws When the XChainAddAccountCreateAttestation is malformed.
  */
-// eslint-disable-next-line max-lines-per-function, max-statements, complexity -- okay for this function, lots of things to check
 export function validateXChainAddAccountCreateAttestation(
   tx: Record<string, unknown>,
 ): void {
   validateBaseTransaction(tx)
 
-  if (tx.Amount == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field Amount',
-    )
-  }
-
-  if (!isAmount(tx.Amount)) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field Amount',
-    )
-  }
-
-  if (tx.AttestationRewardAccount == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field AttestationRewardAccount',
-    )
-  }
-
-  if (typeof tx.AttestationRewardAccount !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field AttestationRewardAccount',
-    )
-  }
-
-  if (tx.AttestationSignerAccount == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field AttestationSignerAccount',
-    )
-  }
-
-  if (typeof tx.AttestationSignerAccount !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field AttestationSignerAccount',
-    )
-  }
-
-  if (tx.Destination == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field Destination',
-    )
-  }
-
-  if (typeof tx.Destination !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field Destination',
-    )
-  }
-
-  if (tx.OtherChainSource == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field OtherChainSource',
-    )
-  }
-
-  if (typeof tx.OtherChainSource !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field OtherChainSource',
-    )
-  }
-
-  if (tx.PublicKey == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field PublicKey',
-    )
-  }
-
-  if (typeof tx.PublicKey !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field PublicKey',
-    )
-  }
-
-  if (tx.Signature == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field Signature',
-    )
-  }
-
-  if (typeof tx.Signature !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field Signature',
-    )
-  }
-
-  if (tx.SignatureReward == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field SignatureReward',
-    )
-  }
-
-  if (!isAmount(tx.SignatureReward)) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field SignatureReward',
-    )
-  }
-
-  if (tx.WasLockingChainSend == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field WasLockingChainSend',
-    )
-  }
-
-  if (tx.WasLockingChainSend !== 0 && tx.WasLockingChainSend !== 1) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field WasLockingChainSend',
-    )
-  }
-
-  if (tx.XChainAccountCreateCount == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field XChainAccountCreateCount',
-    )
-  }
-
-  if (
-    typeof tx.XChainAccountCreateCount !== 'string' &&
-    typeof tx.XChainAccountCreateCount !== 'number'
-  ) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field XChainAccountCreateCount',
-    )
-  }
-
-  if (tx.XChainBridge == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field XChainBridge',
-    )
-  }
-
-  if (!isXChainBridge(tx.XChainBridge)) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field XChainBridge',
-    )
-  }
+  validateRequiredField(tx, 'Amount', isAmount)
+
+  validateRequiredField(tx, 'AttestationRewardAccount', isString)
+
+  validateRequiredField(tx, 'AttestationSignerAccount', isString)
+
+  validateRequiredField(tx, 'Destination', isString)
+
+  validateRequiredField(tx, 'OtherChainSource', isString)
+
+  validateRequiredField(tx, 'PublicKey', isString)
+
+  validateRequiredField(tx, 'Signature', isString)
+
+  validateRequiredField(tx, 'SignatureReward', isAmount)
+
+  validateRequiredField(
+    tx,
+    'WasLockingChainSend',
+    (inp) => inp === 0 || inp === 1,
+  )
+
+  validateRequiredField(
+    tx,
+    'XChainAccountCreateCount',
+    (inp) => isNumber(inp) || isString(inp),
+  )
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
 }