xrpl 2.13.0 → 2.14.0

package/dist/npm/utils/parseNFTokenID.js.map

@@ -1 +1 @@
-{"version":3,"file":"parseNFTokenID.js","sourceRoot":"","sources":["../../../src/utils/parseNFTokenID.ts"],"names":[],"mappings":";;;;;AACA,gEAAoC;AACpC,+DAAsD;AAEtD,sCAAqC;AAoBrC,SAAS,eAAe,CAAC,KAAa,EAAE,QAAgB;IAEtD,OAAO,CAAC,KAAK,GAAG,CAAC,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAC,CAAC,GAAG,UAAU,CAAA;AAE7D,CAAC;AAyBD,SAAwB,cAAc,CAAC,SAAiB;IAQtD,MAAM,cAAc,GAAG,EAAE,CAAA;IACzB,IAAI,SAAS,CAAC,MAAM,KAAK,cAAc,EAAE;QACvC,MAAM,IAAI,kBAAS,CAAC,+CAA+C,SAAS,CAAC,MAAM;yCAC9C,cAAc,EAAE,CAAC,CAAA;KACvD;IAED,MAAM,cAAc,GAAG,IAAI,sBAAS,CAClC,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAC3B,EAAE,CACH,CAAC,QAAQ,EAAE,CAAA;IACZ,MAAM,QAAQ,GAAG,IAAI,sBAAS,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAA;IAE1E,MAAM,aAAa,GAAG;QACpB,SAAS,EAAE,SAAS;QACpB,KAAK,EAAE,IAAI,sBAAS,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE;QAC9D,WAAW,EAAE,IAAI,sBAAS,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE;QACpE,MAAM,EAAE,IAAA,sCAAe,EAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QACvE,KAAK,EAAE,eAAe,CAAC,cAAc,EAAE,QAAQ,CAAC;QAChD,QAAQ,EAAE,QAAQ;KACnB,CAAA;IAED,OAAO,aAAa,CAAA;AACtB,CAAC;AA9BD,iCA8BC"}
+{"version":3,"file":"parseNFTokenID.js","sourceRoot":"","sources":["../../../src/utils/parseNFTokenID.ts"],"names":[],"mappings":";;;;;AACA,gEAAoC;AACpC,+DAAsD;AAEtD,sCAAqC;AAoBrC,SAAS,eAAe,CAAC,KAAa,EAAE,QAAgB;IAEtD,MAAM,IAAI,GAAG,SAAS,CAAA;IACtB,MAAM,SAAS,GAAG,IAAI,CAAA;IACtB,MAAM,GAAG,GAAG,UAAU,CAAA;IAEtB,MAAM,QAAQ,GAAG,IAAI,sBAAS,CAAC,IAAI,CAAC;SACjC,YAAY,CAAC,QAAQ,CAAC;SACtB,MAAM,CAAC,GAAG,CAAC;SACX,IAAI,CAAC,SAAS,CAAC;SACf,MAAM,CAAC,GAAG,CAAC;SACX,QAAQ,EAAE,CAAA;IACb,OAAO,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;AAEjC,CAAC;AAyBD,SAAwB,cAAc,CAAC,SAAiB;IAQtD,MAAM,cAAc,GAAG,EAAE,CAAA;IACzB,IAAI,SAAS,CAAC,MAAM,KAAK,cAAc,EAAE;QACvC,MAAM,IAAI,kBAAS,CAAC,+CAA+C,SAAS,CAAC,MAAM;yCAC9C,cAAc,EAAE,CAAC,CAAA;KACvD;IAED,MAAM,cAAc,GAAG,IAAI,sBAAS,CAClC,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAC3B,EAAE,CACH,CAAC,QAAQ,EAAE,CAAA;IACZ,MAAM,QAAQ,GAAG,IAAI,sBAAS,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAA;IAE1E,MAAM,aAAa,GAAG;QACpB,SAAS,EAAE,SAAS;QACpB,KAAK,EAAE,IAAI,sBAAS,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE;QAC9D,WAAW,EAAE,IAAI,sBAAS,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE;QACpE,MAAM,EAAE,IAAA,sCAAe,EAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QACvE,KAAK,EAAE,eAAe,CAAC,cAAc,EAAE,QAAQ,CAAC;QAChD,QAAQ,EAAE,QAAQ;KACnB,CAAA;IAED,OAAO,aAAa,CAAA;AACtB,CAAC;AA9BD,iCA8BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xrpl",
-  "version": "2.13.0",
+  "version": "2.14.0",
   "license": "ISC",
   "description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
   "files": [
@@ -29,7 +29,7 @@
     "https-proxy-agent": "^5.0.0",
     "lodash": "^4.17.4",
     "ripple-address-codec": "^4.3.1",
-    "ripple-binary-codec": "^1.10.0",
+    "ripple-binary-codec": "^1.11.0",
     "ripple-keypairs": "^1.3.1",
     "ws": "^8.2.2",
     "xrpl-secret-numbers": "^0.3.3"
@@ -91,5 +91,5 @@
   "engines": {
     "node": ">=10.13.0"
   },
-  "gitHead": "29c5a70ebc717fee88354264d1ef9285c7142d90"
+  "gitHead": "99dd0eb44c00b6a4e934467a68036f15320ae69b"
 }

package/src/Wallet/defaultFaucets.ts

@@ -14,17 +14,13 @@ export interface FaucetWallet {
 export enum FaucetNetwork {
   Testnet = 'faucet.altnet.rippletest.net',
   Devnet = 'faucet.devnet.rippletest.net',
-  AMMDevnet = 'ammfaucet.devnet.rippletest.net',
   HooksV3Testnet = 'hooks-testnet-v3.xrpl-labs.com',
-  SidechainDevnet = 'sidechain-faucet.devnet.rippletest.net',
 }
 
 export const FaucetNetworkPaths: Record<string, string> = {
   [FaucetNetwork.Testnet]: '/accounts',
   [FaucetNetwork.Devnet]: '/accounts',
-  [FaucetNetwork.AMMDevnet]: '/accounts',
   [FaucetNetwork.HooksV3Testnet]: '/accounts',
-  [FaucetNetwork.SidechainDevnet]: '/accounts',
 }
 
 /**
@@ -46,10 +42,6 @@ export function getFaucetHost(client: Client): FaucetNetwork | undefined {
     return FaucetNetwork.Testnet
   }
 
-  if (connectionUrl.includes('amm')) {
-    return FaucetNetwork.AMMDevnet
-  }
-
   if (connectionUrl.includes('sidechain-net2')) {
     throw new XRPLFaucetError(
       'Cannot fund an account on an issuing chain. Accounts must be created via the bridge.',

package/src/Wallet/fundWallet.ts

@@ -67,7 +67,7 @@ const MAX_ATTEMPTS = 20
  * @param wallet - An existing XRPL Wallet to fund. If undefined or null, a new Wallet will be created.
  * @param options - See below.
  * @param options.faucetHost - A custom host for a faucet server. On devnet,
- * testnet, AMM devnet, and HooksV3 testnet, `fundWallet` will
+ * testnet, devnet, and HooksV3 testnet, `fundWallet` will
  * attempt to determine the correct server automatically. In other environments,
  * or if you would like to customize the faucet host in devnet or testnet,
  * you should provide the host using this option.

package/src/client/index.ts

@@ -98,6 +98,8 @@ import {
   // AMM methods
   AMMInfoRequest,
   AMMInfoResponse,
+  ServerDefinitionsRequest,
+  ServerDefinitionsResponse,
 } from '../models/methods'
 import { BaseRequest, BaseResponse } from '../models/methods/baseMethod'
 import {
@@ -346,6 +348,9 @@ class Client extends EventEmitter {
   public async request(
     r: RipplePathFindRequest,
   ): Promise<RipplePathFindResponse>
+  public async request(
+    r: ServerDefinitionsRequest,
+  ): Promise<ServerDefinitionsResponse>
   public async request(r: ServerInfoRequest): Promise<ServerInfoResponse>
   public async request(r: ServerStateRequest): Promise<ServerStateResponse>
   public async request(r: SubmitRequest): Promise<SubmitResponse>

package/src/models/ledger/Bridge.ts

@@ -22,13 +22,6 @@ export default interface Bridge extends BaseLedgerEntry, HasPreviousTxnID {
    */
   SignatureReward: Amount
 
-  /**
-   * The minimum amount, in XRP, required for an {@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?: string
-
   /**
    * The door accounts and assets of the bridge this object correlates to.
    */
@@ -58,6 +51,13 @@ export default interface Bridge extends BaseLedgerEntry, HasPreviousTxnID {
    */
   XChainAccountClaimCount: string
 
+  /**
+   * The minimum amount, in XRP, required for an {@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?: string
+
   /**
    * A bit-map of boolean flags. No flags are defined for Bridges, so this value
    * is always 0.

package/src/models/ledger/DID.ts

@@ -0,0 +1,22 @@
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+// TODO: add docs
+
+/**
+ * @category Ledger Entries
+ */
+export default interface DID extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'DID'
+
+  Account: string
+
+  Data: string
+
+  DIDDocument: string
+
+  URI: string
+
+  Flags: 0
+
+  OwnerNode: string
+}

package/src/models/ledger/LedgerEntry.ts

@@ -44,6 +44,7 @@ type LedgerEntryFilter =
   | 'bridge'
   | 'check'
   | 'deposit_preauth'
+  | 'did'
   | 'directory'
   | 'escrow'
   | 'fee'

package/src/models/ledger/index.ts

@@ -7,6 +7,7 @@ import AMM, { VoteSlot } from './AMM'
 import Bridge from './Bridge'
 import Check from './Check'
 import DepositPreauth from './DepositPreauth'
+import DID from './DID'
 import DirectoryNode from './DirectoryNode'
 import Escrow from './Escrow'
 import FeeSettings, {
@@ -39,6 +40,7 @@ export {
   Check,
   DepositPreauth,
   DirectoryNode,
+  DID,
   Escrow,
   FEE_SETTINGS_ID,
   FeeSettings,

package/src/models/methods/index.ts

@@ -108,6 +108,10 @@ import {
   RipplePathFindResponse,
   SourceCurrencyAmount,
 } from './ripplePathFind'
+import {
+  ServerDefinitionsRequest,
+  ServerDefinitionsResponse,
+} from './serverDefinitions'
 import {
   JobType,
   ServerInfoRequest,
@@ -186,6 +190,7 @@ type Request =
   // server info methods
   | FeeRequest
   | ManifestRequest
+  | ServerDefinitionsRequest
   | ServerInfoRequest
   | ServerStateRequest
   // utility methods
@@ -239,6 +244,7 @@ type Response =
   // server info methods
   | FeeResponse
   | ManifestResponse
+  | ServerDefinitionsResponse
   | ServerInfoResponse
   | ServerStateResponse
   // utility methods
@@ -360,6 +366,8 @@ export {
   FeeResponse,
   ManifestRequest,
   ManifestResponse,
+  ServerDefinitionsRequest,
+  ServerDefinitionsResponse,
   ServerInfoRequest,
   ServerInfoResponse,
   ServerStateRequest,

package/src/models/methods/ledgerEntry.ts

@@ -74,6 +74,12 @@ export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
       }
     | string
 
+  /**
+   * Specify a DID object to retrieve. If a string, must be the
+   * object ID of the DID object, as hexadecimal, or the account ID.
+   */
+  did?: string
+
   /**
    * The DirectoryNode to retrieve. If a string, must be the object ID of the
    * directory, as hexadecimal. If an object, requires either `dir_root` o

package/src/models/methods/nftInfo.ts

@@ -16,7 +16,7 @@ export interface NFTInfoRequest extends BaseRequest, LookupByLedgerRequest {
 }
 
 /**
- * Response expected from an {@link NFTInfoResponse}.
+ * Response expected from an {@link NFTInfoRequest}.
  *
  * @category Responses
  */

package/src/models/methods/serverDefinitions.ts

@@ -0,0 +1,61 @@
+import { BaseRequest, BaseResponse } from './baseMethod'
+
+/**
+ * The `server_definitions` method retrieves information about the definition
+ * enums available in this rippled node. Expects a response in the form of a
+ * {@link ServerDefinitionsResponse}.
+ *
+ * @category Requests
+ */
+export interface ServerDefinitionsRequest extends BaseRequest {
+  command: 'server_definitions'
+  /**
+   * The hash of a `server_definitions` response.
+   */
+  hash?: string
+}
+
+/**
+ * Response expected from an {@link ServerDefinitionsRequest}.
+ *
+ * @category Responses
+ */
+export interface ServerDefinitionsResponse extends BaseResponse {
+  result: {
+    hash: string
+  } & (
+    | {
+        FIELDS: Array<
+          [
+            string,
+            {
+              nth: number
+              isVLEncoded: boolean
+              isSerialized: boolean
+              isSigningField: boolean
+              type: string
+            },
+          ]
+        >
+
+        LEDGER_ENTRY_TYPES: Record<string, number>
+
+        TRANSACTION_RESULTS: Record<string, number>
+
+        TRANSACTION_TYPES: Record<string, number>
+
+        TYPES: Record<string, number>
+      }
+    | {
+        FIELDS?: never
+
+        LEDGER_ENTRY_TYPES?: never
+
+        TRANSACTION_RESULTS?: never
+
+        TRANSACTION_TYPES?: never
+
+        TYPES?: never
+      }
+  )
+}

package/src/models/methods/subscribe.ts

@@ -38,7 +38,7 @@ export interface SubscribeBook {
 
 /**
  * The subscribe method requests periodic notifications from the server when
- * certain events happen. Expects a response in the form of a.
+ * certain events happen. Expects a response in the form of a
  * {@link SubscribeResponse}.
  *
  * @category Requests

package/src/models/methods/tx.ts

@@ -12,7 +12,14 @@ import { BaseRequest, BaseResponse } from './baseMethod'
  */
 export interface TxRequest extends BaseRequest {
   command: 'tx'
-  transaction: string
+  /**
+   * The transaction hash to look up. Exactly one of `transaction` or `ctid` must be specified for a TxRequest.
+   */
+  transaction?: string
+  /**
+   * The Concise Transaction ID to look up. Exactly one of `transaction` or `ctid` must be specified for a TxRequest.
+   */
+  ctid?: string
   /**
    * If true, return transaction data and metadata as binary serialized to
    * hexadecimal strings. If false, return transaction data and metadata as.
@@ -46,6 +53,10 @@ export interface TxResponse<
   result: {
     /** The SHA-512 hash of the transaction. */
     hash: string
+    /**
+     * The Concise Transaction Identifier of the transaction (16-byte hex string)
+     */
+    ctid?: string
     /** The ledger index of the ledger that includes this transaction. */
     ledger_index?: number
     /** Transaction metadata, which describes the results of the transaction.

package/src/models/transactions/DIDDelete.ts

@@ -0,0 +1,20 @@
+import { BaseTransaction, validateBaseTransaction } from './common'
+
+// TODO: add docs
+
+/**
+ * @category Transaction Models
+ */
+export interface DIDDelete extends BaseTransaction {
+  TransactionType: 'DIDDelete'
+}
+
+/**
+ * Verify the form and type of a DIDDelete at runtime.
+ *
+ * @param tx - A DIDDelete Transaction.
+ * @throws When the DIDDelete is malformed.
+ */
+export function validateDIDDelete(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+}

package/src/models/transactions/DIDSet.ts

@@ -0,0 +1,49 @@
+import { ValidationError } from '../../errors'
+
+import {
+  BaseTransaction,
+  isString,
+  validateBaseTransaction,
+  validateOptionalField,
+} from './common'
+
+// TODO: add docs
+
+/**
+ * @category Transaction Models
+ */
+export interface DIDSet extends BaseTransaction {
+  TransactionType: 'DIDSet'
+
+  Data?: string
+
+  DIDDocument?: string
+
+  URI?: string
+}
+
+/**
+ * Verify the form and type of a DIDSet at runtime.
+ *
+ * @param tx - A DIDSet Transaction.
+ * @throws When the DIDSet is malformed.
+ */
+export function validateDIDSet(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateOptionalField(tx, 'Data', isString)
+
+  validateOptionalField(tx, 'DIDDocument', isString)
+
+  validateOptionalField(tx, 'URI', isString)
+
+  if (
+    tx.Data === undefined &&
+    tx.DIDDocument === undefined &&
+    tx.URI === undefined
+  ) {
+    throw new ValidationError(
+      'DIDSet: Must have at least one of `Data`, `DIDDocument`, and `URI`',
+    )
+  }
+}

package/src/models/transactions/XChainAccountCreateCommit.ts

@@ -14,7 +14,7 @@ import {
  * The XChainAccountCreateCommit transaction creates a new account on one of the
  * chains a bridge connects, which serves as the bridge entrance for that chain.
  *
- * Warning: This transaction should only be executed if the witness attestations
+ * WARNING: This transaction should only be executed if the witness attestations
  * will be reliably delivered to the destination chain. If the signatures aren't
  * delivered, then account creation will be blocked until attestations are received.
  * This can be used maliciously; to disable this transaction on XRP-XRP bridges,

package/src/models/transactions/index.ts

@@ -31,6 +31,8 @@ export { CheckCancel } from './checkCancel'
 export { CheckCash } from './checkCash'
 export { CheckCreate } from './checkCreate'
 export { Clawback } from './clawback'
+export { DIDDelete } from './DIDDelete'
+export { DIDSet } from './DIDSet'
 export { DepositPreauth } from './depositPreauth'
 export { EscrowCancel } from './escrowCancel'
 export { EscrowCreate } from './escrowCreate'

package/src/models/transactions/transaction.ts

@@ -20,6 +20,8 @@ import { CheckCreate, validateCheckCreate } from './checkCreate'
 import { Clawback, validateClawback } from './clawback'
 import { isIssuedCurrency } from './common'
 import { DepositPreauth, validateDepositPreauth } from './depositPreauth'
+import { DIDDelete, validateDIDDelete } from './DIDDelete'
+import { DIDSet, validateDIDSet } from './DIDSet'
 import { EnableAmendment } from './enableAmendment'
 import { EscrowCancel, validateEscrowCancel } from './escrowCancel'
 import { EscrowCreate, validateEscrowCreate } from './escrowCreate'
@@ -91,18 +93,20 @@ import {
  * @category Transaction Models
  */
 export type Transaction =
-  | AccountDelete
-  | AccountSet
   | AMMBid
+  | AMMCreate
   | AMMDelete
   | AMMDeposit
-  | AMMCreate
   | AMMVote
   | AMMWithdraw
+  | AccountDelete
+  | AccountSet
   | CheckCancel
   | CheckCash
   | CheckCreate
   | Clawback
+  | DIDDelete
+  | DIDSet
   | DepositPreauth
   | EscrowCancel
   | EscrowCreate
@@ -122,13 +126,13 @@ export type Transaction =
   | SignerListSet
   | TicketCreate
   | TrustSet
+  | XChainAccountCreateCommit
   | XChainAddAccountCreateAttestation
   | XChainAddClaimAttestation
   | XChainClaim
   | XChainCommit
   | XChainCreateBridge
   | XChainCreateClaimID
-  | XChainAccountCreateCommit
   | XChainModifyBridge
 
 export type PseudoTransaction = EnableAmendment | SetFee | UNLModify
@@ -210,18 +214,14 @@ export function validate(transaction: Record<string, unknown>): void {
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- okay here
   setTransactionFlagsToNumber(tx as unknown as Transaction)
   switch (tx.TransactionType) {
-    case 'AccountDelete':
-      validateAccountDelete(tx)
-      break
-
-    case 'AccountSet':
-      validateAccountSet(tx)
-      break
-
     case 'AMMBid':
       validateAMMBid(tx)
       break
 
+    case 'AMMCreate':
+      validateAMMCreate(tx)
+      break
+
     case 'AMMDelete':
       validateAMMDelete(tx)
       break
@@ -230,10 +230,6 @@ export function validate(transaction: Record<string, unknown>): void {
       validateAMMDeposit(tx)
       break
 
-    case 'AMMCreate':
-      validateAMMCreate(tx)
-      break
-
     case 'AMMVote':
       validateAMMVote(tx)
       break
@@ -242,6 +238,14 @@ export function validate(transaction: Record<string, unknown>): void {
       validateAMMWithdraw(tx)
       break
 
+    case 'AccountDelete':
+      validateAccountDelete(tx)
+      break
+
+    case 'AccountSet':
+      validateAccountSet(tx)
+      break
+
     case 'CheckCancel':
       validateCheckCancel(tx)
       break
@@ -258,6 +262,14 @@ export function validate(transaction: Record<string, unknown>): void {
       validateClawback(tx)
       break
 
+    case 'DIDDelete':
+      validateDIDDelete(tx)
+      break
+
+    case 'DIDSet':
+      validateDIDSet(tx)
+      break
+
     case 'DepositPreauth':
       validateDepositPreauth(tx)
       break
@@ -334,6 +346,10 @@ export function validate(transaction: Record<string, unknown>): void {
       validateTrustSet(tx)
       break
 
+    case 'XChainAccountCreateCommit':
+      validateXChainAccountCreateCommit(tx)
+      break
+
     case 'XChainAddAccountCreateAttestation':
       validateXChainAddAccountCreateAttestation(tx)
       break
@@ -358,10 +374,6 @@ export function validate(transaction: Record<string, unknown>): void {
       validateXChainCreateClaimID(tx)
       break
 
-    case 'XChainAccountCreateCommit':
-      validateXChainAccountCreateCommit(tx)
-      break
-
     case 'XChainModifyBridge':
       validateXChainModifyBridge(tx)
       break

package/src/utils/parseNFTokenID.ts

@@ -24,7 +24,17 @@ import { XrplError } from '../errors'
  */
 function unscrambleTaxon(taxon: number, tokenSeq: number): number {
   /* eslint-disable no-bitwise -- XOR is part of the encode/decode scheme. */
-  return (taxon ^ (384160001 * tokenSeq + 2459)) % 4294967296
+  const seed = 384160001
+  const increment = 2459
+  const max = 4294967296
+
+  const scramble = new BigNumber(seed)
+    .multipliedBy(tokenSeq)
+    .modulo(max)
+    .plus(increment)
+    .modulo(max)
+    .toNumber()
+  return (taxon ^ scramble) >>> 0
   /* eslint-enable no-bitwise */
 }