xrpl 2.11.0 → 2.12.0

package/src/models/transactions/XChainAddAccountCreateAttestation.ts

@@ -0,0 +1,121 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  BaseTransaction,
+  isAmount,
+  isNumber,
+  isString,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainAddAccountCreateAttestation transaction provides an attestation
+ * from a witness server that a {@link XChainAccountCreateCommit} transaction
+ * occurred on the other chain.
+ *
+ * @category Transaction Models
+ */
+export interface XChainAddAccountCreateAttestation extends BaseTransaction {
+  TransactionType: 'XChainAddAccountCreateAttestation'
+
+  /**
+   * The amount committed by the {@link XChainAccountCreateCommit} transaction
+   * on the source chain.
+   */
+  Amount: Amount
+
+  /**
+   * The account that should receive this signer's share of the SignatureReward.
+   */
+  AttestationRewardAccount: string
+
+  /**
+   * The account on the door account's signer list that is signing the transaction.
+   */
+  AttestationSignerAccount: string
+
+  /**
+   * The destination account for the funds on the destination chain.
+   */
+  Destination: string
+
+  /**
+   * The account on the source chain that submitted the {@link XChainAccountCreateCommit}
+   * transaction that triggered the event associated with the attestation.
+   */
+  OtherChainSource: string
+
+  /**
+   * The public key used to verify the signature.
+   */
+  PublicKey: string
+
+  /**
+   * The signature attesting to the event on the other chain.
+   */
+  Signature: string
+
+  /**
+   * The signature reward paid in the {@link XChainAccountCreateCommit} transaction.
+   */
+  SignatureReward: Amount
+
+  /**
+   * A boolean representing the chain where the event occurred.
+   */
+  WasLockingChainSend: 0 | 1
+
+  /**
+   * The counter that represents the order that the claims must be processed in.
+   */
+  XChainAccountCreateCount: number | string
+
+  /**
+   * The bridge associated with the attestation.
+   */
+  XChainBridge: XChainBridge
+}
+
+/**
+ * Verify the form and type of an XChainAddAccountCreateAttestation at runtime.
+ *
+ * @param tx - An XChainAddAccountCreateAttestation Transaction.
+ * @throws When the XChainAddAccountCreateAttestation is malformed.
+ */
+export function validateXChainAddAccountCreateAttestation(
+  tx: Record<string, unknown>,
+): void {
+  validateBaseTransaction(tx)
+
+  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)
+}

package/src/models/transactions/XChainAddClaimAttestation.ts

@@ -0,0 +1,115 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  BaseTransaction,
+  isAmount,
+  isNumber,
+  isString,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainAddClaimAttestation transaction provides proof from a witness server,
+ * attesting to an {@link XChainCommit} transaction.
+ *
+ * @category Transaction Models
+ */
+export interface XChainAddClaimAttestation extends BaseTransaction {
+  TransactionType: 'XChainAddClaimAttestation'
+
+  /**
+   * The amount committed by the {@link XChainCommit} transaction on the source chain.
+   */
+  Amount: Amount
+
+  /**
+   * The account that should receive this signer's share of the SignatureReward.
+   */
+  AttestationRewardAccount: string
+
+  /**
+   * The account on the door account's signer list that is signing the transaction.
+   */
+  AttestationSignerAccount: string
+
+  /**
+   * The destination account for the funds on the destination chain (taken from
+   * the {@link XChainCommit} transaction).
+   */
+  Destination?: string
+
+  /**
+   * The account on the source chain that submitted the {@link XChainCommit}
+   * transaction that triggered the event associated with the attestation.
+   */
+  OtherChainSource: string
+
+  /**
+   * The public key used to verify the attestation signature.
+   */
+  PublicKey: string
+
+  /**
+   * The signature attesting to the event on the other chain.
+   */
+  Signature: string
+
+  /**
+   * A boolean representing the chain where the event occurred.
+   */
+  WasLockingChainSend: 0 | 1
+
+  /**
+   * The bridge to use to transfer funds.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The XChainClaimID associated with the transfer, which was included in the
+   * {@link XChainCommit} transaction.
+   */
+  XChainClaimID: number | string
+}
+
+/**
+ * Verify the form and type of an XChainAddClaimAttestation at runtime.
+ *
+ * @param tx - An XChainAddClaimAttestation Transaction.
+ * @throws When the XChainAddClaimAttestation is malformed.
+ */
+export function validateXChainAddClaimAttestation(
+  tx: Record<string, unknown>,
+): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'Amount', isAmount)
+
+  validateRequiredField(tx, 'AttestationRewardAccount', isString)
+
+  validateRequiredField(tx, 'AttestationSignerAccount', isString)
+
+  validateOptionalField(tx, 'Destination', isString)
+
+  validateRequiredField(tx, 'OtherChainSource', isString)
+
+  validateRequiredField(tx, 'PublicKey', isString)
+
+  validateRequiredField(tx, 'Signature', isString)
+
+  validateRequiredField(
+    tx,
+    'WasLockingChainSend',
+    (inp) => inp === 0 || inp === 1,
+  )
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(
+    tx,
+    'XChainClaimID',
+    (inp) => isNumber(inp) || isString(inp),
+  )
+}

package/src/models/transactions/XChainClaim.ts

@@ -0,0 +1,77 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  BaseTransaction,
+  isAmount,
+  isNumber,
+  isString,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainClaim transaction completes a cross-chain transfer of value. It
+ * allows a user to claim the value on the destination chain - the equivalent
+ * of the value locked on the source chain.
+ *
+ * @category Transaction Models
+ */
+export interface XChainClaim extends BaseTransaction {
+  TransactionType: 'XChainClaim'
+
+  /**
+   * The bridge to use for the transfer.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The unique integer ID for the cross-chain transfer that was referenced in the
+   * corresponding {@link XChainCommit} transaction.
+   */
+  XChainClaimID: number | string
+
+  /**
+   * The destination account on the destination chain. It must exist or the
+   * transaction will fail. However, if the transaction fails in this case, the
+   * sequence number and collected signatures won't be destroyed, and the
+   * transaction can be rerun with a different destination.
+   */
+  Destination: string
+
+  /**
+   * An integer destination tag.
+   */
+  DestinationTag?: number
+
+  /**
+   * The amount to claim on the destination chain. This must match the amount
+   * attested to on the attestations associated with this XChainClaimID.
+   */
+  Amount: Amount
+}
+
+/**
+ * Verify the form and type of an XChainClaim at runtime.
+ *
+ * @param tx - An XChainClaim Transaction.
+ * @throws When the XChainClaim is malformed.
+ */
+export function validateXChainClaim(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(
+    tx,
+    'XChainClaimID',
+    (inp) => isNumber(inp) || isString(inp),
+  )
+
+  validateRequiredField(tx, 'Destination', isString)
+
+  validateOptionalField(tx, 'DestinationTag', isNumber)
+
+  validateRequiredField(tx, 'Amount', isAmount)
+}

package/src/models/transactions/XChainCommit.ts

@@ -0,0 +1,74 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  BaseTransaction,
+  isAmount,
+  isNumber,
+  isString,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainCommit is the second step in a cross-chain transfer. It puts assets
+ * into trust on the locking chain so that they can be wrapped on the issuing
+ * chain, or burns wrapped assets on the issuing chain so that they can be returned
+ * on the locking chain.
+ *
+ * @category Transaction Models
+ */
+export interface XChainCommit extends BaseTransaction {
+  TransactionType: 'XChainCommit'
+
+  /**
+   * The bridge to use to transfer funds.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The unique integer ID for a cross-chain transfer. This must be acquired on
+   * the destination chain (via a {@link XChainCreateClaimID} transaction) and
+   * checked from a validated ledger before submitting this transaction. If an
+   * incorrect sequence number is specified, the funds will be lost.
+   */
+  XChainClaimID: number | string
+
+  /**
+   * The destination account on the destination chain. If this is not specified,
+   * the account that submitted the {@link XChainCreateClaimID} transaction on the
+   * destination chain will need to submit a {@link XChainClaim} transaction to
+   * claim the funds.
+   */
+  OtherChainDestination?: string
+
+  /**
+   * The asset to commit, and the quantity. This must match the door account's
+   * LockingChainIssue (if on the locking chain) or the door account's
+   * IssuingChainIssue (if on the issuing chain).
+   */
+  Amount: Amount
+}
+
+/**
+ * Verify the form and type of an XChainCommit at runtime.
+ *
+ * @param tx - An XChainCommit Transaction.
+ * @throws When the XChainCommit is malformed.
+ */
+export function validateXChainCommit(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(
+    tx,
+    'XChainClaimID',
+    (inp) => isNumber(inp) || isString(inp),
+  )
+
+  validateOptionalField(tx, 'OtherChainDestination', isString)
+
+  validateRequiredField(tx, 'Amount', isAmount)
+}

package/src/models/transactions/XChainCreateBridge.ts

@@ -0,0 +1,56 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  BaseTransaction,
+  isAmount,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainCreateBridge transaction creates a new {@link Bridge} ledger object
+ * and defines a new cross-chain bridge entrance on the chain that the transaction
+ * is submitted on. It includes information about door accounts and assets for the
+ * bridge.
+ *
+ * @category Transaction Models
+ */
+export interface XChainCreateBridge extends BaseTransaction {
+  TransactionType: 'XChainCreateBridge'
+
+  /**
+   * The bridge (door accounts and assets) to create.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The total amount to pay the witness servers for their signatures. This amount
+   * will be split among the signers.
+   */
+  SignatureReward: Amount
+
+  /**
+   * The minimum amount, in XRP, required for a {@link XChainAccountCreateCommit}
+   * transaction. If this isn't present, the {@link XChainAccountCreateCommit}
+   * transaction will fail. This field can only be present on XRP-XRP bridges.
+   */
+  MinAccountCreateAmount?: Amount
+}
+
+/**
+ * Verify the form and type of an XChainCreateBridge at runtime.
+ *
+ * @param tx - An XChainCreateBridge Transaction.
+ * @throws When the XChainCreateBridge is malformed.
+ */
+export function validateXChainCreateBridge(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(tx, 'SignatureReward', isAmount)
+
+  validateOptionalField(tx, 'MinAccountCreateAmount', isAmount)
+}

package/src/models/transactions/XChainCreateClaimID.ts

@@ -0,0 +1,53 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  BaseTransaction,
+  isAmount,
+  isString,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateRequiredField,
+} from './common'
+
+/**
+ * The XChainCreateClaimID transaction creates a new cross-chain claim ID that is
+ * used for a cross-chain transfer. A cross-chain claim ID represents one
+ * cross-chain transfer of value.
+ *
+ * @category Transaction Models
+ */
+export interface XChainCreateClaimID extends BaseTransaction {
+  TransactionType: 'XChainCreateClaimID'
+
+  /**
+   * The bridge to create the claim ID for.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The amount, in XRP, to reward the witness servers for providing signatures.
+   * This must match the amount on the {@link Bridge} ledger object.
+   */
+  SignatureReward: Amount
+
+  /**
+   * The account that must send the {@link XChainCommit} transaction on the source chain.
+   */
+  OtherChainSource: string
+}
+
+/**
+ * Verify the form and type of an XChainCreateClaimID at runtime.
+ *
+ * @param tx - An XChainCreateClaimID Transaction.
+ * @throws When the XChainCreateClaimID is malformed.
+ */
+export function validateXChainCreateClaimID(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(tx, 'SignatureReward', isAmount)
+
+  validateRequiredField(tx, 'OtherChainSource', isString)
+}

package/src/models/transactions/XChainModifyBridge.ts

@@ -0,0 +1,77 @@
+import { Amount, XChainBridge } from '../common'
+
+import {
+  BaseTransaction,
+  GlobalFlags,
+  isAmount,
+  isXChainBridge,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
+
+/**
+ * Enum representing values of {@link XChainModifyBridge} transaction flags.
+ *
+ * @category Transaction Flags
+ */
+export enum XChainModifyBridgeFlags {
+  /** Clears the MinAccountCreateAmount of the bridge. */
+  tfClearAccountCreateAmount = 0x00010000,
+}
+
+/**
+ * Map of flags to boolean values representing {@link XChainModifyBridge} transaction
+ * flags.
+ *
+ * @category Transaction Flags
+ */
+export interface XChainModifyBridgeFlagsInterface extends GlobalFlags {
+  /** Clears the MinAccountCreateAmount of the bridge. */
+  tfClearAccountCreateAmount?: boolean
+}
+
+/**
+ * The XChainModifyBridge transaction allows bridge managers to modify the parameters
+ * of the bridge.
+ *
+ * @category Transaction Models
+ */
+export interface XChainModifyBridge extends BaseTransaction {
+  TransactionType: 'XChainModifyBridge'
+
+  /**
+   * The bridge to modify.
+   */
+  XChainBridge: XChainBridge
+
+  /**
+   * The signature reward split between the witnesses for submitting attestations.
+   */
+  SignatureReward?: Amount
+
+  /**
+   * The minimum amount, in XRP, required for a {@link XChainAccountCreateCommit}
+   * transaction. If this is not present, the {@link XChainAccountCreateCommit}
+   * transaction will fail. This field can only be present on XRP-XRP bridges.
+   */
+  MinAccountCreateAmount?: Amount
+
+  Flags?: number | XChainModifyBridgeFlagsInterface
+}
+
+/**
+ * Verify the form and type of an XChainModifyBridge at runtime.
+ *
+ * @param tx - An XChainModifyBridge Transaction.
+ * @throws When the XChainModifyBridge is malformed.
+ */
+export function validateXChainModifyBridge(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateOptionalField(tx, 'SignatureReward', isAmount)
+
+  validateOptionalField(tx, 'MinAccountCreateAmount', isAmount)
+}

package/src/models/transactions/accountSet.ts

@@ -1,5 +1,3 @@
-/* eslint-disable complexity -- Necessary for validateAccountSet */
-
 import { isValidClassicAddress } from 'ripple-address-codec'
 
 import { ValidationError } from '../../errors'

package/src/models/transactions/checkCash.ts

@@ -1,4 +1,3 @@
-/* eslint-disable complexity -- Necessary for validateCheckCash */
 import { ValidationError } from '../../errors'
 import { Amount } from '../common'
 

package/src/models/transactions/checkCreate.ts

@@ -1,4 +1,3 @@
-/* eslint-disable complexity -- Necessary for validateCheckCreate */
 import { ValidationError } from '../../errors'
 import { Amount } from '../common'