Publish

- @transia/ripple-binary-codec@1.4.6-alpha.1
 - @transia/xrpl@2.7.3-alpha.1

.github/workflows/codeql-analysis.yml

@@ -39,7 +39,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -50,7 +50,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -64,4 +64,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

CONTRIBUTING.md

@@ -169,48 +169,86 @@ npm install abbrev -w ripple-keypairs
 npm uninstall abbrev -w xrpl
 ```
 
-## Release process
+## Release process + checklist
 
-### Release
+## PR process
 
-1. Ensure that all tests passed on the last CI that ran on `main`.
+- [ ] Your changes should be on a branch.
+- [ ] Your changes should have unit tests.
+- [ ] Lint the code with `npm lint`
+- [ ] Build your code with `npm build`
+- [ ] Run the unit tests with `npm test`
+- [ ] Get a full code review.
+- [ ] Merge your branch into `main` and push to github.
+- [ ] Ensure that all tests passed on the last CI that ran on `main`.
 
-NOW WE ARE READY TO PUBLISH! No new code changes happen manually now.
+## Release
 
-2. Checkout `main` (or your beta branch) and `git pull`.
-3. Create a new branch (`git checkout -b <BRANCH_NAME>`) to capture updates that take place during this process.
-4. Update `HISTORY.md` to reflect release changes.
-5. Run `npm run docgen` if the docs were modified in this release to update them (skip this step for a beta).
-6. Run `npm run build` to triple check the build still works
-7. Run `npx lerna version --no-git-tag-version` - This creates a draft PR and bumps the versions of the packages.
-  * For each changed package, pick what the new version should be. Lerna will bump the versions, commit version bumps to `main`, and create a new git tag for each published package.
-  * If publishing a beta, make sure that the versions are all of the form `a.b.c-beta.d`, where `a`, `b`, and `c` are identical to the last normal release except for one, which has been incremented by 1.
-8. Run `npm i` to update the package-lock with the updated versions
-9. Create a new PR from this branch into `main` and merge it (you can directly merge into the beta branch for a beta).
-10. Checkout `main` and `git pull` (you can skip this step for a beta since you already have the latest version of the beta branch).
-11. Run `npx lerna publish from-package --yes` - This will actually publish the packages.
-  * NOTE: if you're releasing a beta, run `npx lerna publish from-package --dist-tag beta --yes` instead.
-  * If it asks for it, enter your [npmjs.com](https://npmjs.com) OTP (one-time password) to complete publication.
-12. Create a new branch (`git checkout -b <BRANCH_NAME>`)to capture the updated packages from the release. Merge those changes into `main`. (You can skip this step on a beta release).
+1. Checkout `main` (or your beta branch) and `git pull`.
+1. Create a new branch (`git checkout -b <BRANCH_NAME>`) to capture updates that take place during this process.
+1. Update `HISTORY.md` to reflect release changes.
 
-NOW YOU HAVE PUBLISHED! But you're not done; we have to notify people!
+   - [ ] Update the version number and release date, and ensure it lists the changes since the previous release.
 
-13. Pull the most recent changes to main locally.
-14. Run `git tag <tagname> -m <tagname>`, where `<tagname>` is the new package and version (e.g. `xrpl@2.1.1`), for each version released.
-15. Run `git push --follow-tags`, to push the tags to Github.
-16. On Github, click the "releases" link on the right-hand side of the page.
-17. Click "Draft a new release"
-18. Click "Choose a tag", and choose a tag that you just created.
-19. Edit the name of the release to match the tag (IE \<package\>@\<version\>) and edit the description as you see fit.
-20. Repeat steps 17-19 for each release.
-21. Send an email to [xrpl-announce](https://groups.google.com/g/xrpl-announce).
+1. Run `npm run docgen` if the docs were modified in this release to update them (skip this step for a beta).
+1. Run `npm run build` to triple check the build still works
+1. Run `npx lerna version --no-git-tag-version` - This creates a draft PR and bumps the versions of the packages.
+
+   - For each changed package, pick what the new version should be. Lerna will bump the versions, commit version bumps to `main`, and create a new git tag for each published package.
+   - If publishing a beta, make sure that the versions are all of the form `a.b.c-beta.d`, where `a`, `b`, and `c` are identical to the last normal release except for one, which has been incremented by 1.
+
+1. Run `npm i` to update the package-lock with the updated versions.
+1. Create a new PR from this branch into `main` and merge it (you can directly merge into the beta branch for a beta).
+1. Checkout `main` and `git pull` (you can skip this step for a beta since you already have the latest version of the beta branch).
+1. Actually publish the packages with one of the following:
+
+   - Stable release: Run `npx lerna publish from-package --yes`
+   - Beta release: Run `npx lerna publish from-package --dist-tag beta --yes`  
+     Notice this allows developers to install the package with `npm add xrpl@beta`
+
+1. If requested, enter your [npmjs.com](https://npmjs.com) OTP (one-time password) to complete publication.
+1. If not a beta release: Create a new branch (`git checkout -b <BRANCH_NAME>`) to capture the updated packages from the release. Merge those changes into `main`.
+
+   NOW YOU HAVE PUBLISHED! But you're not done; we have to notify people!
+
+1. Pull the most recent changes to `main` locally.
+1. Run `git tag <tagname> -m <tagname>`, where `<tagname>` is the new package and version (e.g. `xrpl@2.1.1`), for each version released.
+1. Run `git push --follow-tags`, to push the tags to Github.
+1. On GitHub, click the "Releases" link on the right-hand side of the page.
+
+1. Repeat for each release:
+
+   1. Click "Draft a new release"
+   1. Click "Choose a tag", and choose a tag that you just created.
+   1. Edit the name of the release to match the tag (IE \<package\>@\<version\>) and edit the description as you see fit.
+
+1. Lastly, send an email to [xrpl-announce](https://groups.google.com/g/xrpl-announce).
+
+# ripple-lib 1.x releases
+
+- [ ] Publish the release to npm.
+
+  - [ ] If you are publishing a 1.x release to the `xrpl` package, use:
+
+        npm publish --tag ripple-lib
+
+    This prevents the release from taking the `latest` tag.
+
+For ripple-lib:
+
+ - Have one of the ripple-lib package maintainers push to `ripple-lib` (npm package name). You can contact [@intelliot](https://github.com/intelliot) to request the npm publish.
+- For ripple-lib releases, cross-publish the package to `xrpl` with `--tag ripple-lib`
+  - [Here's why](https://blog.greenkeeper.io/one-simple-trick-for-javascript-package-maintainers-to-avoid-breaking-their-user-s-software-and-to-6edf06dc5617).
+
+- https://www.npmjs.com/package/ripple-lib
+- https://www.npmjs.com/package/xrpl
 
 ## Mailing Lists
 
 We have a low-traffic mailing list for announcements of new `xrpl.js` releases. (About 1 email every couple of weeks)
 
-+ [Subscribe to xrpl-announce](https://groups.google.com/g/xrpl-announce)
+- [Subscribe to xrpl-announce](https://groups.google.com/g/xrpl-announce)
 
 If you're using the XRP Ledger in production, you should run a [rippled server](https://github.com/ripple/rippled) and subscribe to the ripple-server mailing list as well.
 
-+ [Subscribe to ripple-server](https://groups.google.com/g/ripple-server)
+- [Subscribe to ripple-server](https://groups.google.com/g/ripple-server)

package.json

@@ -13,10 +13,10 @@
     "update:confirm": "npx npm-check-updates --configFileName .ncurc.json -u"
   },
   "dependencies": {
-    "ripple-address-codec": "file:packages/ripple-address-codec",
-    "ripple-binary-codec": "file:packages/ripple-binary-codec",
-    "ripple-keypairs": "file:packages/ripple-keypairs",
-    "xrpl": "file:packages/xrpl"
+    "@transia/ripple-address-codec": "file:packages/ripple-address-codec",
+    "@transia/ripple-binary-codec": "file:packages/ripple-binary-codec",
+    "@transia/ripple-keypairs": "file:packages/ripple-keypairs",
+    "@transia/xrpl": "file:packages/xrpl"
   },
   "devDependencies": {
     "@types/brorand": "^1.0.30",

packages/ripple-address-codec/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "ripple-address-codec",
-  "version": "4.2.5",
+  "version": "4.2.8-alpha.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "ripple-address-codec",
-      "version": "4.2.4",
+      "version": "4.2.8-alpha.0",
       "license": "ISC",
       "dependencies": {
         "base-x": "^3.0.9",

packages/ripple-address-codec/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "ripple-address-codec",
-  "version": "4.2.5",
+  "name": "@transia/ripple-address-codec",
+  "version": "4.2.8-alpha.0",
   "description": "encodes/decodes base58 encoded XRP Ledger identifiers",
   "files": [
     "dist/*",
@@ -15,7 +15,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:XRPLF/xrpl.js.git"
+    "url": "git@github.com/Transia-RnD/xrpl.js/tree/beta"
   },
   "prepublish": "tsc -b",
   "prepublishOnly": "tslint -b ./ && jest",

packages/ripple-binary-codec/HISTORY.md

@@ -1,6 +1,8 @@
 # ripple-binary-codec Release History
 
 ## Unreleased
+### Added
+- Allow custom type definitions to be used for encoding/decoding transactions at runtime (e.g. for sidechains/new amendments)
 
 ## 1.5.0 (2023-03-08)
 ### Changed

packages/ripple-binary-codec/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "ripple-binary-codec",
-  "version": "1.4.3",
+  "name": "@transia/ripple-binary-codec",
+  "version": "1.4.6-alpha.1",
   "description": "XRP Ledger binary codec",
   "files": [
     "dist/*",
@@ -12,12 +12,12 @@
     "test": "test"
   },
   "dependencies": {
+    "@transia/ripple-address-codec": "^4.2.8-alpha.0",
     "assert": "^2.0.0",
     "big-integer": "^1.6.48",
     "buffer": "5.6.0",
     "create-hash": "^1.2.0",
-    "decimal.js": "^10.2.0",
-    "ripple-address-codec": "^4.2.5"
+    "decimal.js": "^10.2.0"
   },
   "scripts": {
     "build": "tsc -b && copyfiles ./src/enums/definitions.json ./dist/enums/",
@@ -28,7 +28,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:XRPLF/xrpl.js.git"
+    "url": "git@github.com/Transia-RnD/xrpl.js/tree/beta"
   },
   "bugs": {
     "url": "https://github.com/XRPLF/xrpl.js/issues"

packages/ripple-binary-codec/src/binary.ts

@@ -6,7 +6,11 @@ import { AccountID } from './types/account-id'
 import { HashPrefix } from './hash-prefixes'
 import { BinarySerializer, BytesList } from './serdes/binary-serializer'
 import { sha512Half, transactionID } from './hashes'
-import { FieldInstance } from './enums'
+import {
+  type XrplDefinitionsBase,
+  DEFAULT_DEFINITIONS,
+  type FieldInstance,
+} from './enums'
 import { STObject } from './types/st-object'
 import { JsonObject } from './types/serialized-type'
 import { Buffer } from 'buffer/'
@@ -16,26 +20,41 @@ import bigInt = require('big-integer')
  * Construct a BinaryParser
  *
  * @param bytes hex-string to construct BinaryParser from
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
  * @returns A BinaryParser
  */
-const makeParser = (bytes: string): BinaryParser => new BinaryParser(bytes)
+const makeParser = (
+  bytes: string,
+  definitions?: XrplDefinitionsBase,
+): BinaryParser => new BinaryParser(bytes, definitions)
 
 /**
  * Parse BinaryParser into JSON
  *
  * @param parser BinaryParser object
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
  * @returns JSON for the bytes in the BinaryParser
  */
-const readJSON = (parser: BinaryParser): JsonObject =>
-  (parser.readType(coreTypes.STObject) as STObject).toJSON()
+const readJSON = (
+  parser: BinaryParser,
+  definitions: XrplDefinitionsBase = DEFAULT_DEFINITIONS,
+): JsonObject =>
+  (parser.readType(coreTypes.STObject) as STObject).toJSON(definitions)
 
 /**
  * Parse a hex-string into its JSON interpretation
  *
  * @param bytes hex-string to parse into JSON
+ * @param definitions rippled definitions used to parse the values of transaction types and such.
+ *                          Can be customized for sidechains and amendments.
  * @returns JSON
  */
-const binaryToJSON = (bytes: string): JsonObject => readJSON(makeParser(bytes))
+const binaryToJSON = (
+  bytes: string,
+  definitions?: XrplDefinitionsBase,
+): JsonObject => readJSON(makeParser(bytes, definitions), definitions)
 
 /**
  * Interface for passing parameters to SerializeObject
@@ -46,17 +65,18 @@ interface OptionObject {
   prefix?: Buffer
   suffix?: Buffer
   signingFieldsOnly?: boolean
+  definitions?: XrplDefinitionsBase
 }
 
 /**
  * Function to serialize JSON object representing a transaction
  *
  * @param object JSON object to serialize
- * @param opts options for serializing, including optional prefix, suffix, and signingFieldOnly
+ * @param opts options for serializing, including optional prefix, suffix, signingFieldOnly, and definitions
  * @returns A Buffer containing the serialized object
  */
 function serializeObject(object: JsonObject, opts: OptionObject = {}): Buffer {
-  const { prefix, suffix, signingFieldsOnly = false } = opts
+  const { prefix, suffix, signingFieldsOnly = false, definitions } = opts
   const bytesList = new BytesList()
 
   if (prefix) {
@@ -66,8 +86,9 @@ function serializeObject(object: JsonObject, opts: OptionObject = {}): Buffer {
   const filter = signingFieldsOnly
     ? (f: FieldInstance): boolean => f.isSigningField
     : undefined
-
-  coreTypes.STObject.from(object, filter).toBytesSink(bytesList)
+  ;(coreTypes.STObject as typeof STObject)
+    .from(object, filter, definitions)
+    .toBytesSink(bytesList)
 
   if (suffix) {
     bytesList.put(suffix)
@@ -81,13 +102,19 @@ function serializeObject(object: JsonObject, opts: OptionObject = {}): Buffer {
  *
  * @param transaction Transaction to serialize
  * @param prefix Prefix bytes to put before the serialized object
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns A Buffer with the serialized object
  */
 function signingData(
   transaction: JsonObject,
   prefix: Buffer = HashPrefix.transactionSig,
+  opts: { definitions?: XrplDefinitionsBase } = {},
 ): Buffer {
-  return serializeObject(transaction, { prefix, signingFieldsOnly: true })
+  return serializeObject(transaction, {
+    prefix,
+    signingFieldsOnly: true,
+    definitions: opts.definitions,
+  })
 }
 
 /**
@@ -102,6 +129,7 @@ interface ClaimObject extends JsonObject {
  * Serialize a signingClaim
  *
  * @param claim A claim object to serialize
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns the serialized object with appropriate prefix
  */
 function signingClaimData(claim: ClaimObject): Buffer {
@@ -123,11 +151,15 @@ function signingClaimData(claim: ClaimObject): Buffer {
  *
  * @param transaction transaction to serialize
  * @param signingAccount Account to sign the transaction with
+ * @param opts.definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns serialized transaction with appropriate prefix and suffix
  */
 function multiSigningData(
   transaction: JsonObject,
   signingAccount: string | AccountID,
+  opts: { definitions: XrplDefinitionsBase } = {
+    definitions: DEFAULT_DEFINITIONS,
+  },
 ): Buffer {
   const prefix = HashPrefix.transactionMultiSig
   const suffix = coreTypes.AccountID.from(signingAccount).toBytes()
@@ -135,6 +167,7 @@ function multiSigningData(
     prefix,
     suffix,
     signingFieldsOnly: true,
+    definitions: opts.definitions,
   })
 }
 

packages/ripple-binary-codec/src/coretypes.ts

@@ -1,4 +1,5 @@
 import {
+  DEFAULT_DEFINITIONS,
   Field,
   TransactionType,
   LedgerEntryType,
@@ -17,6 +18,7 @@ export {
   hashes,
   binary,
   ledgerHashes,
+  DEFAULT_DEFINITIONS,
   Field,
   TransactionType,
   LedgerEntryType,

packages/ripple-binary-codec/src/enums/README.md

@@ -1,12 +1,16 @@
 # Definitions
 
+This file is used to serialize/deserialize transactions and ledger objects for the XRPL. It's broken into 5 sections laid out below.
+
+At the bottom of this README you can find instructions and examples for how to define your own types in a definitions file in order to work on a custom sidechain or develop new amendments.
+
 ## Types
 
 These are the [types](https://xrpl.org/serialization.html#type-list) associated with a given Serialization Field. Each type has an arbitrary [type_code](https://xrpl.org/serialization.html#type-codes), with lower codes sorting first.
 
 ## Ledger Entry Types
 
-Each ledger's state tree contain [ledger objects](https://xrpl.org/ledger-object-types.html), which represent all settings, balances, and relationships in the shared ledger. 
+Each ledger's state tree contain [ledger objects](https://xrpl.org/ledger-object-types.html), which represent all settings, balances, and relationships in the shared ledger.
 
 ## Fields
 
@@ -53,8 +57,88 @@ See:
 - https://github.com/ripple/rippled/blob/develop/src/ripple/protocol/TER.h
 - https://xrpl.org/transaction-results.html
 
-TODO: Write a script to read rippled's source file and generate the necessary mapping.
+To generate a new definitions file from rippled source code, use this tool: https://github.com/RichardAH/xrpl-codec-gen
 
 ## Transaction Types
 
 See https://github.com/ripple/rippled/blob/develop/src/ripple/protocol/TxFormats.h
+
+# Defining Your Own Definitions
+
+If you're building your own sidechain or writing an amendment for the XRPL, you may need to create new XRPL definitions.
+
+To do that there are a couple things you need to do:
+
+1. Generate your own `definitions.json` file from rippled source code using [this tool](https://github.com/RichardAH/xrpl-codec-gen) (The default `definitions.json` for mainnet can be found [here](https://github.com/XRPLF/xrpl.js/blob/main/packages/ripple-binary-codec/src/enums/definitions.json))
+2. Create new SerializedType classes for any new Types (So that encode/decode behavior is defined). The SerializedType classes correspond to "ST..." classes in Rippled. Note: This is very rarely required.
+
+- For examples of how to implement that you can look at objects in the [`types` folder](../types/), such as `Amount`, `UInt8`, or `STArray`.
+
+3. Import your `definitions.json` file to construct your own `XrplDefinitions` object.
+4. Pass the `XrplDefinitions` object whenever you `encode` or `decode` a transaction.
+5. If you added any new transaction types, you should create an `interface` for the transaction that extends `BaseTransaction` from the `xrpl` repo to use it with the functions on `Client` (See the below example of adding a new transaction type)
+
+## Example of adding a new Transaction type
+
+```
+// newDefinitionsJson is where you can import your custom defined definitions.json file
+const newDefinitionsJson = require('./new-transaction-type-definitions.json')
+const { XrplDefinitions, Client } = require('xrpl')
+
+const newDefs = new XrplDefinitions(newDefinitionsJson)
+
+// Change to point at the server you care about
+const serverAddress = 'wss://s.devnet.rippletest.net:51233'
+const client = new Client(serverAddress)
+const wallet1 = await client.fundWallet()
+
+// Extending BaseTransaction allows typescript to recognize this as a transaction type
+interface NewTx extends BaseTransaction {
+    Amount: Amount
+}
+
+const tx: NewTx = {
+    // The TransactionType here needs to match what you added in your newDefinitionsJson file
+    TransactionType: 'NewTx',
+    Account: wallet1.address,
+    Amount: '100',
+}
+
+// By passing in your newDefs, your new transaction should be serializable.
+// Rippled will still throw an error though if it's not a supported transaction type.
+const result = await client.submitAndWait(tx, {
+    wallet: wallet1,
+    definitions: newDefs,
+})
+```
+
+## Example of adding a new serializable Type
+
+```
+const { XrplDefinitions } = require('../dist/coretypes')
+
+// newDefinitionsJson is where you can import your custom defined definitions.json file
+const newDefinitionsJson = require('./fixtures/new-definitions.json')
+
+
+// For any new Types you create, you'll need to make a class with the same name which extends a SerializedType object
+// In order to define how to serialize/deserialize that field. Here we simply make our NewType act like a UInt32.
+
+const { UInt32 } = require('../dist/types/uint-32')
+class NewType extends UInt32 {
+  // Should be the same as UInt32
+}
+
+const extendedCoreTypes = { NewType }
+
+const newDefs = new XrplDefinitions(newDefinitionsJson, extendedCoreTypes)
+
+// From this point on, we should be able to serialize / deserialize Transactions with fields that have 'NewType' as their Type.
+
+const encoded = encode(my_tx, newDefs)
+const decoded = decode(encoded, newDefs)
+```
+
+## Other examples
+
+You can find other examples of how to modify `definitions.json` in `definition.test.js` which contains tests for this feature, and uses various example modified `definition` files. You can find the tests and the corresponding example `definition` files in [this folder of test cases](https://github.com/XRPLF/xrpl.js/tree/main/packages/ripple-binary-codec/test)

packages/ripple-binary-codec/src/enums/bytes.ts

@@ -0,0 +1,75 @@
+import { BytesList, BinaryParser } from '../binary'
+import { Buffer } from 'buffer/'
+
+/*
+ * @brief: Bytes, name, and ordinal representing one type, ledger_type, transaction type, or result
+ */
+export class Bytes {
+  readonly bytes: Buffer
+
+  constructor(
+    readonly name: string,
+    readonly ordinal: number,
+    readonly ordinalWidth: number,
+  ) {
+    this.bytes = Buffer.alloc(ordinalWidth)
+    for (let i = 0; i < ordinalWidth; i++) {
+      this.bytes[ordinalWidth - i - 1] = (ordinal >>> (i * 8)) & 0xff
+    }
+  }
+
+  toJSON(): string {
+    return this.name
+  }
+
+  toBytesSink(sink: BytesList): void {
+    sink.put(this.bytes)
+  }
+
+  toBytes(): Uint8Array {
+    return this.bytes
+  }
+}
+
+/*
+ * @brief: Collection of Bytes objects, mapping bidirectionally
+ */
+export class BytesLookup {
+  constructor(types: Record<string, number>, readonly ordinalWidth: number) {
+    Object.entries(types).forEach(([k, v]) => {
+      this.add(k, v)
+    })
+  }
+
+  /**
+   * Add a new name value pair to the BytesLookup.
+   *
+   * @param name - A human readable name for the field.
+   * @param value - The numeric value for the field.
+   * @throws if the name or value already exist in the lookup because it's unclear how to decode.
+   */
+  add(name: string, value: number): void {
+    if (this[name]) {
+      throw new SyntaxError(
+        `Attempted to add a value with a duplicate name "${name}". This is not allowed because it is unclear how to decode.`,
+      )
+    }
+    if (this[value.toString()]) {
+      throw new SyntaxError(
+        `Attempted to add a duplicate value under a different name (Given name: "${name}" and previous name: "${
+          this[value.toString()]
+        }. This is not allowed because it is unclear how to decode.\nGiven value: ${value.toString()}`,
+      )
+    }
+    this[name] = new Bytes(name, value, this.ordinalWidth)
+    this[value.toString()] = this[name]
+  }
+
+  from(value: Bytes | string): Bytes {
+    return value instanceof Bytes ? value : (this[value] as Bytes)
+  }
+
+  fromParser(parser: BinaryParser): Bytes {
+    return this.from(parser.readUIntN(this.ordinalWidth).toString())
+  }
+}

packages/ripple-binary-codec/src/enums/constants.ts

@@ -0,0 +1,4 @@
+export const TYPE_WIDTH = 2
+export const LEDGER_ENTRY_WIDTH = 2
+export const TRANSACTION_TYPE_WIDTH = 2
+export const TRANSACTION_RESULT_WIDTH = 1

packages/ripple-binary-codec/src/enums/definitions.json

@@ -44,11 +44,16 @@
     "NegativeUNL": 78,
     "NFTokenPage": 80,
     "NFTokenOffer": 55,
+    "URIToken": 85,
     "Any": -3,
     "Child": -2,
     "Nickname": 110,
     "Contract": 99,
-    "GeneratorMap": 103
+    "GeneratorMap": 103,
+    "Hook": 72,
+    "HookState": 118,
+    "HookDefinition": 68,
+    "EmittedTxn": 69
   },
   "FIELDS": [
     [
@@ -321,6 +326,16 @@
         "type": "UInt16"
       }
     ],
+    [
+      "NetworkID",
+      {
+        "nth": 1,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt32"
+      }
+    ],
     [
       "Flags",
       {
@@ -761,6 +776,36 @@
         "type": "UInt32"
       }
     ],
+    [
+      "LockCount",
+      {
+        "nth": 49,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt32"
+      }
+    ],
+    [
+      "FirstNFTokenSequence",
+      {
+        "nth": 50,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt32"
+      }
+    ],
+    [
+      "ImportSequence",
+      {
+        "nth": 97,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt32"
+      }
+    ],
     [
       "IndexNext",
       {
@@ -891,16 +936,6 @@
         "type": "UInt64"
       }
     ],
-    [
-      "HookOn",
-      {
-        "nth": 16,
-        "isVLEncoded": false,
-        "isSerialized": true,
-        "isSigningField": true,
-        "type": "UInt64"
-      }
-    ],
     [
       "HookInstructionCount",
       {
@@ -1151,6 +1186,16 @@
         "type": "Hash256"
       }
     ],
+    [
+      "HookOn",
+      {
+        "nth": 20,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Hash256"
+      }
+    ],
     [
       "Digest",
       {
@@ -1281,6 +1326,36 @@
         "type": "Hash256"
       }
     ],
+    [
+      "OfferID",
+      {
+        "nth": 34,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Hash256"
+      }
+    ],
+    [
+      "EscrowID",
+      {
+        "nth": 35,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Hash256"
+      }
+    ],
+    [
+      "URITokenID",
+      {
+        "nth": 36,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Hash256"
+      }
+    ],
     [
       "Amount",
       {
@@ -1421,6 +1496,56 @@
         "type": "Amount"
       }
     ],
+    [
+      "HookCallbackFee",
+      {
+        "nth": 20,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Amount"
+      }
+    ],
+    [
+      "LockedBalance",
+      {
+        "nth": 21,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Amount"
+      }
+    ],
+    [
+      "BaseFeeDrops",
+      {
+        "nth": 22,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Amount"
+      }
+    ],
+    [
+      "ReserveBaseDrops",
+      {
+        "nth": 23,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Amount"
+      }
+    ],
+    [
+      "ReserveIncrementDrops",
+      {
+        "nth": 24,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Amount"
+      }
+    ],
     [
       "PublicKey",
       {
@@ -1661,6 +1786,16 @@
         "type": "Blob"
       }
     ],
+    [
+      "Blob",
+      {
+        "nth": 26,
+        "isVLEncoded": true,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Blob"
+      }
+    ],
     [
       "Account",
       {
@@ -1801,6 +1936,16 @@
         "type": "Vector256"
       }
     ],
+    [
+      "HookNamespaces",
+      {
+        "nth": 5,
+        "isVLEncoded": true,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Vector256"
+      }
+    ],
     [
       "Paths",
       {
@@ -2176,6 +2321,12 @@
     "telCAN_NOT_QUEUE_BLOCKED": -389,
     "telCAN_NOT_QUEUE_FEE": -388,
     "telCAN_NOT_QUEUE_FULL": -387,
+    "telWRONG_NETWORK": -386,
+    "telREQUIRES_NETWORK_ID": -385,
+    "telNETWORK_ID_MAKES_TX_NON_CANONICAL": -384,
+    "telNON_LOCAL_EMITTED_TXN": -383,
+    "telIMPORT_VL_KEY_NOT_RECOGNISED": -382,
+    "telCAN_NOT_QUEUE_IMPORT": -381,
 
     "temMALFORMED": -299,
     "temBAD_AMOUNT": -298,
@@ -2215,6 +2366,16 @@
     "temUNKNOWN": -264,
     "temSEQ_AND_TICKET": -263,
     "temBAD_NFTOKEN_TRANSFER_FEE": -262,
+    "temAMM_BAD_TOKENS": -261,
+    "temXCHAIN_EQUAL_DOOR_ACCOUNTS": -260,
+    "temXCHAIN_BAD_PROOF": -259,
+    "temXCHAIN_BRIDGE_BAD_ISSUES": -258,
+    "temXCHAIN_BRIDGE_NONDOOR_OWNER": -257,
+    "temXCHAIN_BRIDGE_BAD_MIN_ACCOUNT_CREATE_AMOUNT": -256,
+    "temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -255,
+    "temXCHAIN_TOO_MANY_ATTESTATIONS": -254,
+    "temHOOK_DATA_TOO_LARGE": -253,
+    "temHOOK_REJECTED": -252,
 
     "tefFAILURE": -199,
     "tefALREADY": -198,
@@ -2237,6 +2398,7 @@
     "tefTOO_BIG": -181,
     "tefNO_TICKET": -180,
     "tefNFTOKEN_IS_NOT_TRANSFERABLE": -179,
+    "tefPAST_IMPORT_SEQ": -178,
 
     "terRETRY": -99,
     "terFUNDS_SPENT": -98,
@@ -2250,6 +2412,8 @@
     "terNO_RIPPLE": -90,
     "terQUEUED": -89,
     "terPRE_TICKET": -88,
+    "terNO_AMM": -87,
+    "terNO_HOOK": -86,
 
     "tesSUCCESS": 0,
 
@@ -2291,6 +2455,7 @@
     "tecKILLED": 150,
     "tecHAS_OBLIGATIONS": 151,
     "tecTOO_SOON": 152,
+    "tecHOOK_REJECTED": 153,
     "tecMAX_SEQUENCE_REACHED": 154,
     "tecNO_SUITABLE_NFTOKEN_PAGE": 155,
     "tecNFTOKEN_BUY_SELL_MISMATCH": 156,
@@ -2298,7 +2463,33 @@
     "tecCANT_ACCEPT_OWN_NFTOKEN_OFFER": 158,
     "tecINSUFFICIENT_FUNDS": 159,
     "tecOBJECT_NOT_FOUND": 160,
-    "tecINSUFFICIENT_PAYMENT": 161
+    "tecINSUFFICIENT_PAYMENT": 161,
+    "tecAMM_UNFUNDED": 162,
+    "tecAMM_BALANCE": 163,
+    "tecAMM_FAILED_DEPOSIT": 164,
+    "tecAMM_FAILED_WITHDRAW": 165,
+    "tecAMM_INVALID_TOKENS": 166,
+    "tecAMM_FAILED_BID": 167,
+    "tecAMM_FAILED_VOTE": 168,
+    "tecREQUIRES_FLAG": 169,
+    "tecPRECISION_LOSS": 170,
+    "tecBAD_XCHAIN_TRANSFER_ISSUE": 171,
+    "tecXCHAIN_NO_CLAIM_ID": 172,
+    "tecXCHAIN_BAD_CLAIM_ID": 173,
+    "tecXCHAIN_CLAIM_NO_QUORUM": 174,
+    "tecXCHAIN_PROOF_UNKNOWN_KEY": 175,
+    "tecXCHAIN_CREATE_ACCOUNT_NONXRP_ISSUE": 176,
+    "tecXCHAIN_WRONG_CHAIN": 177,
+    "tecXCHAIN_REWARD_MISMATCH": 178,
+    "tecXCHAIN_NO_SIGNERS_LIST": 179,
+    "tecXCHAIN_SENDING_ACCOUNT_MISMATCH": 180,
+    "tecXCHAIN_INSUFF_CREATE_AMOUNT": 181,
+    "tecXCHAIN_ACCOUNT_CREATE_PAST": 182,
+    "tecXCHAIN_ACCOUNT_CREATE_TOO_MANY": 183,
+    "tecXCHAIN_PAYMENT_FAILED": 184,
+    "tecXCHAIN_SELF_COMMIT": 185,
+    "tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 186,
+    "tecLAST_POSSIBLE_ENTRY": 255
   },
   "TRANSACTION_TYPES": {
     "Invalid": -1,
@@ -2330,8 +2521,16 @@
     "NFTokenCreateOffer": 27,
     "NFTokenCancelOffer": 28,
     "NFTokenAcceptOffer": 29,
+    "URITokenMint": 45,
+    "URITokenBurn": 46,
+    "URITokenBuy": 47,
+    "URITokenCreateSellOffer": 48,
+    "URITokenCancelSellOffer": 49,
+    "Import": 97,
+    "Invoke": 99,
     "EnableAmendment": 100,
     "SetFee": 101,
-    "UNLModify": 102
+    "UNLModify": 102,
+    "EmitFailure": 103
   }
 }

packages/ripple-binary-codec/src/enums/field.ts

@@ -0,0 +1,85 @@
+import { Bytes } from './bytes'
+import { SerializedType } from '../types/serialized-type'
+import { TYPE_WIDTH } from './constants'
+import { Buffer } from 'buffer/'
+
+/**
+ * Encoding information for a rippled field, often used in transactions.
+ * See the enums [README.md](https://github.com/XRPLF/xrpl.js/tree/main/packages/ripple-binary-codec/src/enums) for more details on what each means.
+ */
+export interface FieldInfo {
+  nth: number
+  isVLEncoded: boolean
+  isSerialized: boolean
+  isSigningField: boolean
+  type: string
+}
+
+export interface FieldInstance {
+  readonly nth: number
+  readonly isVariableLengthEncoded: boolean
+  readonly isSerialized: boolean
+  readonly isSigningField: boolean
+  readonly type: Bytes
+  readonly ordinal: number
+  readonly name: string
+  readonly header: Buffer
+  readonly associatedType: typeof SerializedType
+}
+
+/*
+ * @brief: Serialize a field based on type_code and Field.nth
+ */
+function fieldHeader(type: number, nth: number): Buffer {
+  const header: Array<number> = []
+  if (type < 16) {
+    if (nth < 16) {
+      header.push((type << 4) | nth)
+    } else {
+      header.push(type << 4, nth)
+    }
+  } else if (nth < 16) {
+    header.push(nth, type)
+  } else {
+    header.push(0, type, nth)
+  }
+  return Buffer.from(header)
+}
+
+function buildField(
+  [name, info]: [string, FieldInfo],
+  typeOrdinal: number,
+): FieldInstance {
+  const field = fieldHeader(typeOrdinal, info.nth)
+  return {
+    name: name,
+    nth: info.nth,
+    isVariableLengthEncoded: info.isVLEncoded,
+    isSerialized: info.isSerialized,
+    isSigningField: info.isSigningField,
+    ordinal: (typeOrdinal << 16) | info.nth,
+    type: new Bytes(info.type, typeOrdinal, TYPE_WIDTH),
+    header: field,
+    associatedType: SerializedType, // For later assignment in ./types/index.js or Definitions.updateAll(...)
+  }
+}
+
+/*
+ * @brief: The collection of all fields as defined in definitions.json
+ */
+export class FieldLookup {
+  constructor(
+    fields: Array<[string, FieldInfo]>,
+    types: Record<string, number>,
+  ) {
+    fields.forEach(([name, field_info]) => {
+      const typeOrdinal = types[field_info.type]
+      this[name] = buildField([name, field_info], typeOrdinal)
+      this[this[name].ordinal.toString()] = this[name]
+    })
+  }
+
+  fromString(value: string): FieldInstance {
+    return this[value] as FieldInstance
+  }
+}

packages/ripple-binary-codec/src/enums/index.ts

@@ -1,164 +1,36 @@
 import * as enums from './definitions.json'
-import { SerializedType } from '../types/serialized-type'
-import { Buffer } from 'buffer/'
-import { BytesList } from '../binary'
+import {
+  XrplDefinitionsBase,
+  FieldInstance,
+  Bytes,
+} from './xrpl-definitions-base'
+/**
+ * By default, coreTypes from the `types` folder is where known type definitions are initialized to avoid import cycles.
+ */
+const DEFAULT_DEFINITIONS = new XrplDefinitionsBase(enums, {})
+
+const Type = DEFAULT_DEFINITIONS.type
+const LedgerEntryType = DEFAULT_DEFINITIONS.ledgerEntryType
+const TransactionType = DEFAULT_DEFINITIONS.transactionType
+const TransactionResult = DEFAULT_DEFINITIONS.transactionResult
+const Field = DEFAULT_DEFINITIONS.field
 
 /*
  * @brief: All valid transaction types
  */
-export const TRANSACTION_TYPES = Object.entries(enums.TRANSACTION_TYPES)
-  .filter(([_key, value]) => value >= 0)
-  .map(([key, _value]) => key)
-
-const TYPE_WIDTH = 2
-const LEDGER_ENTRY_WIDTH = 2
-const TRANSACTION_TYPE_WIDTH = 2
-const TRANSACTION_RESULT_WIDTH = 1
-
-/*
- * @brief: Serialize a field based on type_code and Field.nth
- */
-function fieldHeader(type: number, nth: number): Buffer {
-  const header: Array<number> = []
-  if (type < 16) {
-    if (nth < 16) {
-      header.push((type << 4) | nth)
-    } else {
-      header.push(type << 4, nth)
-    }
-  } else if (nth < 16) {
-    header.push(nth, type)
-  } else {
-    header.push(0, type, nth)
-  }
-  return Buffer.from(header)
-}
-
-/*
- * @brief: Bytes, name, and ordinal representing one type, ledger_type, transaction type, or result
- */
-export class Bytes {
-  readonly bytes: Buffer
-
-  constructor(
-    readonly name: string,
-    readonly ordinal: number,
-    readonly ordinalWidth: number,
-  ) {
-    this.bytes = Buffer.alloc(ordinalWidth)
-    for (let i = 0; i < ordinalWidth; i++) {
-      this.bytes[ordinalWidth - i - 1] = (ordinal >>> (i * 8)) & 0xff
-    }
-  }
-
-  toJSON(): string {
-    return this.name
-  }
-
-  toBytesSink(sink: BytesList): void {
-    sink.put(this.bytes)
-  }
-
-  toBytes(): Uint8Array {
-    return this.bytes
-  }
-}
-
-/*
- * @brief: Collection of Bytes objects, mapping bidirectionally
- */
-class BytesLookup {
-  constructor(types: Record<string, number>, readonly ordinalWidth: number) {
-    Object.entries(types).forEach(([k, v]) => {
-      this[k] = new Bytes(k, v, ordinalWidth)
-      this[v.toString()] = this[k]
-    })
-  }
-
-  from(value: Bytes | string): Bytes {
-    return value instanceof Bytes ? value : (this[value] as Bytes)
-  }
-
-  fromParser(parser): Bytes {
-    return this.from(parser.readUIntN(this.ordinalWidth).toString())
-  }
-}
-
-/*
- * type FieldInfo is the type of the objects containing information about each field in definitions.json
- */
-interface FieldInfo {
-  nth: number
-  isVLEncoded: boolean
-  isSerialized: boolean
-  isSigningField: boolean
-  type: string
-}
-
-interface FieldInstance {
-  readonly nth: number
-  readonly isVariableLengthEncoded: boolean
-  readonly isSerialized: boolean
-  readonly isSigningField: boolean
-  readonly type: Bytes
-  readonly ordinal: number
-  readonly name: string
-  readonly header: Buffer
-  readonly associatedType: typeof SerializedType
-}
-
-function buildField([name, info]: [string, FieldInfo]): FieldInstance {
-  const typeOrdinal = enums.TYPES[info.type]
-  const field = fieldHeader(typeOrdinal, info.nth)
-  return {
-    name: name,
-    nth: info.nth,
-    isVariableLengthEncoded: info.isVLEncoded,
-    isSerialized: info.isSerialized,
-    isSigningField: info.isSigningField,
-    ordinal: (typeOrdinal << 16) | info.nth,
-    type: new Bytes(info.type, typeOrdinal, TYPE_WIDTH),
-    header: field,
-    associatedType: SerializedType, // For later assignment in ./types/index.js
-  }
-}
-
-/*
- * @brief: The collection of all fields as defined in definitions.json
- */
-class FieldLookup {
-  constructor(fields: Array<[string, FieldInfo]>) {
-    fields.forEach(([k, v]) => {
-      this[k] = buildField([k, v])
-      this[this[k].ordinal.toString()] = this[k]
-    })
-  }
-
-  fromString(value: string): FieldInstance {
-    return this[value] as FieldInstance
-  }
-}
-
-const Type = new BytesLookup(enums.TYPES, TYPE_WIDTH)
-const LedgerEntryType = new BytesLookup(
-  enums.LEDGER_ENTRY_TYPES,
-  LEDGER_ENTRY_WIDTH,
-)
-const TransactionType = new BytesLookup(
-  enums.TRANSACTION_TYPES,
-  TRANSACTION_TYPE_WIDTH,
-)
-const TransactionResult = new BytesLookup(
-  enums.TRANSACTION_RESULTS,
-  TRANSACTION_RESULT_WIDTH,
-)
-const Field = new FieldLookup(enums.FIELDS as Array<[string, FieldInfo]>)
+const TRANSACTION_TYPES = DEFAULT_DEFINITIONS.transactionNames
+const TRANSACTION_TYPE_MAP = DEFAULT_DEFINITIONS.transactionMap
 
 export {
+  Bytes,
+  XrplDefinitionsBase,
+  DEFAULT_DEFINITIONS,
   Field,
   FieldInstance,
   Type,
   LedgerEntryType,
   TransactionResult,
   TransactionType,
+  TRANSACTION_TYPES,
+  TRANSACTION_TYPE_MAP,
 }

packages/ripple-binary-codec/src/enums/xrpl-definitions-base.ts

@@ -0,0 +1,123 @@
+import { SerializedType } from '../types/serialized-type'
+import { Bytes, BytesLookup } from './bytes'
+import { FieldInfo, FieldLookup, FieldInstance } from './field'
+import {
+  TYPE_WIDTH,
+  LEDGER_ENTRY_WIDTH,
+  TRANSACTION_TYPE_WIDTH,
+  TRANSACTION_RESULT_WIDTH,
+} from './constants'
+
+interface DefinitionsData {
+  TYPES: Record<string, number>
+  LEDGER_ENTRY_TYPES: Record<string, number>
+  FIELDS: (string | FieldInfo)[][]
+  TRANSACTION_RESULTS: Record<string, number>
+  TRANSACTION_TYPES: Record<string, number>
+}
+
+/**
+ * Stores the various types and fields for rippled to be used to encode/decode information later on.
+ * XrplDefinitions should be instantiated instead of this class.
+ */
+class XrplDefinitionsBase {
+  // A collection of fields that can be included in transactions
+  field: FieldLookup
+  // A collection of ids corresponding to types of ledger objects
+  ledgerEntryType: BytesLookup
+  // A collection of type flags used to determine how to serialize a field's data
+  type: BytesLookup
+  // Errors and result codes for transactions
+  transactionResult: BytesLookup
+  // Defined transactions that can be submitted to the ledger
+  transactionType: BytesLookup
+  // Valid transaction names
+  transactionNames: string[]
+  // Valid transaction names
+  transactionMap: Record<string, number>
+  // Maps serializable types to their TypeScript class implementation
+  dataTypes: Record<string, typeof SerializedType>
+
+  /**
+   * Present rippled types in a typed and updatable format.
+   * For an example of the input format see `definitions.json`
+   * To generate a new definitions file from rippled source code, use this tool: https://github.com/RichardAH/xrpl-codec-gen
+   *
+   * See the definitions.test.js file for examples of how to create your own updated definitions.json.
+   *
+   * @param enums - A json encoding of the core types, transaction types, transaction results, transaction names, and fields.
+   * @param types - A list of type objects with the same name as the fields defined.
+   *              You can use the coreTypes object if you are not adding new types.
+   */
+  constructor(
+    enums: DefinitionsData,
+    types: Record<string, typeof SerializedType>,
+  ) {
+    this.type = new BytesLookup(enums.TYPES, TYPE_WIDTH)
+    this.ledgerEntryType = new BytesLookup(
+      enums.LEDGER_ENTRY_TYPES,
+      LEDGER_ENTRY_WIDTH,
+    )
+    this.transactionType = new BytesLookup(
+      enums.TRANSACTION_TYPES,
+      TRANSACTION_TYPE_WIDTH,
+    )
+    this.transactionResult = new BytesLookup(
+      enums.TRANSACTION_RESULTS,
+      TRANSACTION_RESULT_WIDTH,
+    )
+    this.field = new FieldLookup(
+      enums.FIELDS as Array<[string, FieldInfo]>,
+      enums.TYPES,
+    )
+
+    this.transactionNames = Object.entries(enums.TRANSACTION_TYPES)
+      .filter(([_key, value]) => value >= 0)
+      .map(([key, _value]) => key)
+
+    const ignoreList = ['EnableAmendment', 'SetFee', 'UNLModify', 'EmitFailure']
+    this.transactionMap = Object.assign(
+      {},
+      ...Object.entries(enums.TRANSACTION_TYPES)
+
+        .filter(([_key, _value]) => _value >= 0 || ignoreList.includes(_key))
+        .map(([key, value]) => ({ [key]: value })),
+    )
+
+    this.dataTypes = {} // Filled in via associateTypes
+    this.associateTypes(types)
+  }
+
+  /**
+   * Associates each Field to a corresponding class that TypeScript can recognize.
+   *
+   * @param types a list of type objects with the same name as the fields defined.
+   *              Defaults to xrpl.js's core type definitions.
+   */
+  public associateTypes(types: Record<string, typeof SerializedType>): void {
+    // Overwrite any existing type definitions with the given types
+    this.dataTypes = Object.assign({}, this.dataTypes, types)
+
+    Object.values(this.field).forEach((field) => {
+      field.associatedType = this.dataTypes[field.type.name]
+    })
+
+    this.field['TransactionType'].associatedType = this.transactionType
+    this.field['TransactionResult'].associatedType = this.transactionResult
+    this.field['LedgerEntryType'].associatedType = this.ledgerEntryType
+  }
+
+  public getAssociatedTypes(): Record<string, typeof SerializedType> {
+    return this.dataTypes
+  }
+}
+
+export {
+  DefinitionsData,
+  XrplDefinitionsBase,
+  FieldLookup,
+  FieldInfo,
+  FieldInstance,
+  Bytes,
+  BytesLookup,
+}

packages/ripple-binary-codec/src/enums/xrpl-definitions.ts

@@ -0,0 +1,32 @@
+import {
+  type DefinitionsData,
+  XrplDefinitionsBase,
+} from './xrpl-definitions-base'
+import { coreTypes } from '../types'
+import { SerializedType } from '../types/serialized-type'
+
+/**
+ * Stores the various types and fields for rippled to be used to encode/decode information later on.
+ * Should be used instead of XrplDefinitionsBase since this defines default `types` for serializing/deserializing
+ * ledger data.
+ */
+export class XrplDefinitions extends XrplDefinitionsBase {
+  /**
+   * Present rippled types in a typed and updatable format.
+   * For an example of the input format see `definitions.json`
+   * To generate a new definitions file from rippled source code, use this tool: https://github.com/RichardAH/xrpl-codec-gen
+   *
+   * See the definitions.test.js file for examples of how to create your own updated definitions.json.
+   *
+   * @param enums - A json encoding of the core types, transaction types, transaction results, transaction names, and fields.
+   * @param additionalTypes - A list of SerializedType objects with the same name as the fields defined.
+   *              These types will be included in addition to the coreTypes used on mainnet.
+   */
+  constructor(
+    enums: DefinitionsData,
+    additionalTypes?: Record<string, typeof SerializedType>,
+  ) {
+    const types = Object.assign({}, coreTypes, additionalTypes)
+    super(enums, types)
+  }
+}

packages/ripple-binary-codec/src/index.ts

@@ -1,9 +1,16 @@
 import * as assert from 'assert'
-import { quality, binary } from './coretypes'
+import { quality, binary, HashPrefix } from './coretypes'
 import { decodeLedgerData } from './ledger-hashes'
 import { ClaimObject } from './binary'
 import { JsonObject } from './types/serialized-type'
-import { TRANSACTION_TYPES } from './enums'
+import {
+  XrplDefinitionsBase,
+  TRANSACTION_TYPES,
+  TRANSACTION_TYPE_MAP,
+  DEFAULT_DEFINITIONS,
+} from './enums'
+import { XrplDefinitions } from './enums/xrpl-definitions'
+import { coreTypes } from './types'
 
 const {
   signingData,
@@ -17,22 +24,25 @@ const {
  * Decode a transaction
  *
  * @param binary hex-string of the encoded transaction
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns the JSON representation of the transaction
  */
-function decode(binary: string): JsonObject {
+function decode(binary: string, definitions?: XrplDefinitionsBase): JsonObject {
   assert.ok(typeof binary === 'string', 'binary must be a hex string')
-  return binaryToJSON(binary)
+  return binaryToJSON(binary, definitions)
 }
 
 /**
  * Encode a transaction
  *
  * @param json The JSON representation of a transaction
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
+ *
  * @returns A hex-string of the encoded transaction
  */
-function encode(json: object): string {
+function encode(json: object, definitions?: XrplDefinitionsBase): string {
   assert.ok(typeof json === 'object')
-  return serializeObject(json as JsonObject)
+  return serializeObject(json as JsonObject, { definitions })
     .toString('hex')
     .toUpperCase()
 }
@@ -42,11 +52,17 @@ function encode(json: object): string {
  *
  * @param json JSON object representing the transaction
  * @param signer string representing the account to sign the transaction with
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns a hex string of the encoded transaction
  */
-function encodeForSigning(json: object): string {
+function encodeForSigning(
+  json: object,
+  definitions?: XrplDefinitionsBase,
+): string {
   assert.ok(typeof json === 'object')
-  return signingData(json as JsonObject)
+  return signingData(json as JsonObject, HashPrefix.transactionSig, {
+    definitions,
+  })
     .toString('hex')
     .toUpperCase()
 }
@@ -56,6 +72,7 @@ function encodeForSigning(json: object): string {
  *
  * @param json JSON object representing the transaction
  * @param signer string representing the account to sign the transaction with
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns a hex string of the encoded transaction
  */
 function encodeForSigningClaim(json: object): string {
@@ -70,12 +87,18 @@ function encodeForSigningClaim(json: object): string {
  *
  * @param json JSON object representing the transaction
  * @param signer string representing the account to sign the transaction with
+ * @param definitions Custom rippled types to use instead of the default. Used for sidechains and amendments.
  * @returns a hex string of the encoded transaction
  */
-function encodeForMultisigning(json: object, signer: string): string {
+function encodeForMultisigning(
+  json: object,
+  signer: string,
+  definitions?: XrplDefinitionsBase,
+): string {
   assert.ok(typeof json === 'object')
   assert.equal(json['SigningPubKey'], '')
-  return multiSigningData(json as JsonObject, signer)
+  const definitionsOpt = definitions ? { definitions } : undefined
+  return multiSigningData(json as JsonObject, signer, definitionsOpt)
     .toString('hex')
     .toUpperCase()
 }
@@ -112,4 +135,9 @@ export {
   decodeQuality,
   decodeLedgerData,
   TRANSACTION_TYPES,
+  TRANSACTION_TYPE_MAP,
+  XrplDefinitions,
+  XrplDefinitionsBase,
+  DEFAULT_DEFINITIONS,
+  coreTypes,
 }

packages/ripple-binary-codec/src/ledger-hashes.ts

@@ -11,6 +11,7 @@ import { UInt8 } from './types/uint-8'
 import { BinaryParser } from './serdes/binary-parser'
 import { JsonObject } from './types/serialized-type'
 import bigInt = require('big-integer')
+import { XrplDefinitionsBase } from './enums'
 
 /**
  * Computes the hash of a list of objects
@@ -160,11 +161,16 @@ function ledgerHash(header: ledgerObject): Hash256 {
  * Decodes a serialized ledger header
  *
  * @param binary A serialized ledger header
+ * @param definitions Type definitions to parse the ledger objects.
+ *      Used if there are non-default ledger objects to decode.
  * @returns A JSON object describing a ledger header
  */
-function decodeLedgerData(binary: string): object {
+function decodeLedgerData(
+  binary: string,
+  definitions?: XrplDefinitionsBase,
+): object {
   assert.ok(typeof binary === 'string', 'binary must be a hex string')
-  const parser = new BinaryParser(binary)
+  const parser = new BinaryParser(binary, definitions)
   return {
     ledger_index: parser.readUInt32(),
     total_coins: parser.readType(UInt64).valueOf().toString(),

packages/ripple-binary-codec/src/serdes/binary-parser.ts

@@ -1,6 +1,10 @@
 import * as assert from 'assert'
-import { Field, FieldInstance } from '../enums'
-import { SerializedType } from '../types/serialized-type'
+import {
+  XrplDefinitionsBase,
+  DEFAULT_DEFINITIONS,
+  FieldInstance,
+} from '../enums'
+import { type SerializedType } from '../types/serialized-type'
 import { Buffer } from 'buffer/'
 
 /**
@@ -8,14 +12,21 @@ import { Buffer } from 'buffer/'
  */
 class BinaryParser {
   private bytes: Buffer
+  definitions: XrplDefinitionsBase
 
   /**
    * Initialize bytes to a hex string
    *
    * @param hexBytes a hex string
+   * @param definitions Rippled definitions used to parse the values of transaction types and such.
+   *                          Can be customized for sidechains and amendments.
    */
-  constructor(hexBytes: string) {
+  constructor(
+    hexBytes: string,
+    definitions: XrplDefinitionsBase = DEFAULT_DEFINITIONS,
+  ) {
     this.bytes = Buffer.from(hexBytes, 'hex')
+    this.definitions = definitions
   }
 
   /**
@@ -146,7 +157,7 @@ class BinaryParser {
    * @return The field represented by the bytes at the head of the BinaryParser
    */
   readField(): FieldInstance {
-    return Field.fromString(this.readFieldOrdinal().toString())
+    return this.definitions.field.fromString(this.readFieldOrdinal().toString())
   }
 
   /**

packages/ripple-binary-codec/src/serdes/binary-serializer.ts

@@ -1,6 +1,6 @@
 import * as assert from 'assert'
 import { FieldInstance } from '../enums'
-import { SerializedType } from '../types/serialized-type'
+import { type SerializedType } from '../types/serialized-type'
 import { Buffer } from 'buffer/'
 
 /**

packages/ripple-binary-codec/src/shamap.ts

@@ -130,7 +130,7 @@ class ShaMapInner extends ShaMapNode {
    */
   hash(): Hash256 {
     if (this.empty()) {
-      return coreTypes.Hash256.ZERO_256
+      return (coreTypes.Hash256 as typeof Hash256).ZERO_256
     }
     const hash = Sha512Half.put(this.hashPrefix())
     this.toBytesSink(hash)
@@ -145,7 +145,9 @@ class ShaMapInner extends ShaMapNode {
   toBytesSink(list: BytesList): void {
     for (let i = 0; i < this.branches.length; i++) {
       const branch = this.branches[i]
-      const hash = branch ? branch.hash() : coreTypes.Hash256.ZERO_256
+      const hash = branch
+        ? branch.hash()
+        : (coreTypes.Hash256 as typeof Hash256).ZERO_256
       hash.toBytesSink(list)
     }
   }

packages/ripple-binary-codec/src/types/account-id.ts

@@ -3,7 +3,7 @@ import {
   encodeAccountID,
   isValidXAddress,
   xAddressToClassicAddress,
-} from 'ripple-address-codec'
+} from '@transia/ripple-address-codec'
 import { Hash160 } from './hash-160'
 import { Buffer } from 'buffer/'
 

packages/ripple-binary-codec/src/types/index.ts

@@ -1,9 +1,3 @@
-import {
-  Field,
-  TransactionResult,
-  TransactionType,
-  LedgerEntryType,
-} from '../enums'
 import { AccountID } from './account-id'
 import { Amount } from './amount'
 import { Blob } from './blob'
@@ -19,8 +13,10 @@ import { UInt32 } from './uint-32'
 import { UInt64 } from './uint-64'
 import { UInt8 } from './uint-8'
 import { Vector256 } from './vector-256'
+import { type SerializedType } from './serialized-type'
+import { DEFAULT_DEFINITIONS } from '../enums'
 
-const coreTypes = {
+const coreTypes: Record<string, typeof SerializedType> = {
   AccountID,
   Amount,
   Blob,
@@ -38,12 +34,26 @@ const coreTypes = {
   Vector256,
 }
 
-Object.values(Field).forEach((field) => {
-  field.associatedType = coreTypes[field.type.name]
-})
+// Ensures that the DEFAULT_DEFINITIONS object connects these types to fields for serializing/deserializing
+// This is done here instead of in enums/index.ts to avoid a circular dependency
+// because some of the above types depend on BinarySerailizer which depends on enums/index.ts.
+DEFAULT_DEFINITIONS.associateTypes(coreTypes)
 
-Field['TransactionType'].associatedType = TransactionType
-Field['TransactionResult'].associatedType = TransactionResult
-Field['LedgerEntryType'].associatedType = LedgerEntryType
-
-export { coreTypes }
+export {
+  coreTypes,
+  AccountID,
+  Amount,
+  Blob,
+  Currency,
+  Hash128,
+  Hash160,
+  Hash256,
+  PathSet,
+  STArray,
+  STObject,
+  UInt8,
+  UInt16,
+  UInt32,
+  UInt64,
+  Vector256,
+}

packages/ripple-binary-codec/src/types/st-object.ts

@@ -1,6 +1,11 @@
-import { Field, FieldInstance, Bytes } from '../enums'
+import {
+  DEFAULT_DEFINITIONS,
+  FieldInstance,
+  Bytes,
+  XrplDefinitionsBase,
+} from '../enums'
 import { SerializedType, JsonObject } from './serialized-type'
-import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
+import { xAddressToClassicAddress, isValidXAddress } from '@transia/ripple-address-codec'
 import { BinaryParser } from '../serdes/binary-parser'
 import { BinarySerializer, BytesList } from '../serdes/binary-serializer'
 import { Buffer } from 'buffer/'
@@ -83,11 +88,13 @@ class STObject extends SerializedType {
    *
    * @param value An object to include
    * @param filter optional, denote which field to include in serialized object
+   * @param definitions optional, types and values to use to encode/decode a transaction
    * @returns a STObject object
    */
   static from<T extends STObject | JsonObject>(
     value: T,
     filter?: (...any) => boolean,
+    definitions: XrplDefinitionsBase = DEFAULT_DEFINITIONS,
   ): STObject {
     if (value instanceof STObject) {
       return value
@@ -108,7 +115,7 @@ class STObject extends SerializedType {
     }, {})
 
     let sorted = Object.keys(xAddressDecoded)
-      .map((f: string): FieldInstance => Field[f] as FieldInstance)
+      .map((f: string): FieldInstance => definitions.field[f] as FieldInstance)
       .filter(
         (f: FieldInstance): boolean =>
           f !== undefined &&
@@ -155,11 +162,12 @@ class STObject extends SerializedType {
 
   /**
    * Get the JSON interpretation of this.bytes
-   *
+   * @param definitions rippled definitions used to parse the values of transaction types and such.
+   *                          Can be customized for sidechains and amendments.
    * @returns a JSON object
    */
-  toJSON(): JsonObject {
-    const objectParser = new BinaryParser(this.toString())
+  toJSON(definitions?: XrplDefinitionsBase): JsonObject {
+    const objectParser = new BinaryParser(this.toString(), definitions)
     const accumulator = {}
 
     while (!objectParser.end()) {

packages/ripple-binary-codec/test/binary-parser.test.js

@@ -1,7 +1,7 @@
 const { coreTypes } = require('../src/types')
 const Decimal = require('decimal.js')
 
-const { encodeAccountID } = require('ripple-address-codec')
+const { encodeAccountID } = require('@transia/ripple-address-codec')
 const { binary } = require('../src/coretypes')
 const { Amount, Hash160 } = coreTypes
 const { makeParser, readJSON } = binary

packages/ripple-binary-codec/test/definitions.test.js

@@ -0,0 +1,100 @@
+const { encode, decode, XrplDefinitions } = require('../src')
+const normalDefinitionsJson = require('../src/enums/definitions.json')
+const { UInt32 } = require('../dist/types/uint-32')
+
+const txJson = {
+  Account: 'r9LqNeG6qHxjeUocjvVki2XR35weJ9mZgQ',
+  Amount: '1000',
+  Destination: 'rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh',
+  Fee: '10',
+  Flags: 0,
+  Sequence: 1,
+  TransactionType: 'Payment',
+}
+
+describe('encode and decode using new types as a parameter', function () {
+  test('can encode and decode a new TransactionType', function () {
+    const tx = { ...txJson, TransactionType: 'NewTestTransaction' }
+    // Before updating the types, this should not be encodable
+    expect(() => encode(tx)).toThrow()
+
+    // Normally this would be generated directly from rippled with something like `server_definitions`.
+    // Added here to make it easier to see what is actually changing in the definitions.json file.
+    const definitions = JSON.parse(JSON.stringify(normalDefinitionsJson))
+    definitions.TRANSACTION_TYPES['NewTestTransaction'] = 30
+
+    const newDefs = new XrplDefinitions(definitions)
+
+    const encoded = encode(tx, newDefs)
+    expect(() => decode(encoded)).toThrow()
+    const decoded = decode(encoded, newDefs)
+    expect(decoded).toStrictEqual(tx)
+  })
+
+  test('can encode and decode a new Field', function () {
+    const tx = { ...txJson, NewFieldDefinition: 10 }
+
+    // Before updating the types, undefined fields will be ignored on encode
+    expect(decode(encode(tx))).not.toStrictEqual(tx)
+
+    // Normally this would be generated directly from rippled with something like `server_definitions`.
+    // Added here to make it easier to see what is actually changing in the definitions.json file.
+    const definitions = JSON.parse(JSON.stringify(normalDefinitionsJson))
+
+    definitions.FIELDS.push([
+      'NewFieldDefinition',
+      {
+        nth: 100,
+        isVLEncoded: false,
+        isSerialized: true,
+        isSigningField: true,
+        type: 'UInt32',
+      },
+    ])
+
+    const newDefs = new XrplDefinitions(definitions)
+
+    const encoded = encode(tx, newDefs)
+    expect(() => decode(encoded)).toThrow()
+    const decoded = decode(encoded, newDefs)
+    expect(decoded).toStrictEqual(tx)
+  })
+
+  test('can encode and decode a new Type', function () {
+    const tx = {
+      ...txJson,
+      TestField: 10, // Should work the same as a UInt32
+    }
+
+    // Normally this would be generated directly from rippled with something like `server_definitions`.
+    // Added here to make it easier to see what is actually changing in the definitions.json file.
+    const definitions = JSON.parse(JSON.stringify(normalDefinitionsJson))
+    definitions.TYPES.NewType = 24
+    definitions.FIELDS.push([
+      'TestField',
+      {
+        nth: 100,
+        isVLEncoded: true,
+        isSerialized: true,
+        isSigningField: true,
+        type: 'NewType',
+      },
+    ])
+
+    // Test that before updating the types this tx fails to decode correctly. Note that undefined fields are ignored on encode.
+    expect(decode(encode(tx))).not.toStrictEqual(tx)
+
+    class NewType extends UInt32 {
+      // Should be the same as UInt32
+    }
+
+    const extendedCoreTypes = { NewType }
+
+    const newDefs = new XrplDefinitions(definitions, extendedCoreTypes)
+
+    const encoded = encode(tx, newDefs)
+    expect(() => decode(encoded)).toThrow()
+    const decoded = decode(encoded, newDefs)
+    expect(decoded).toStrictEqual(tx)
+  })
+})

packages/ripple-binary-codec/test/signing-data-encoding.test.js

@@ -4,6 +4,9 @@ const {
   encodeForSigningClaim,
   encodeForMultisigning,
 } = require('../src')
+const { XrplDefinitions } = require('../src/enums/xrpl-definitions')
+
+const normalDefinitions = require('../src/enums/definitions.json')
 
 const tx_json = {
   Account: 'r9LqNeG6qHxjeUocjvVki2XR35weJ9mZgQ',
@@ -67,6 +70,53 @@ describe('Signing data', function () {
     )
   })
 
+  test('can create single signing blobs with modified type', function () {
+    const customPaymentDefinitions = JSON.parse(
+      JSON.stringify(normalDefinitions),
+    )
+    customPaymentDefinitions.TRANSACTION_TYPES.Payment = 31
+
+    const newDefs = new XrplDefinitions(customPaymentDefinitions)
+    const actual = encodeForSigning(tx_json, newDefs)
+    expect(actual).toBe(
+      [
+        '53545800', // signingPrefix
+        // TransactionType
+        '12',
+        '001F',
+        // Flags
+        '22',
+        '80000000',
+        // Sequence
+        '24',
+        '00000001',
+        // Amount
+        '61',
+        // native amount
+        '40000000000003E8',
+        // Fee
+        '68',
+        // native amount
+        '400000000000000A',
+        // SigningPubKey
+        '73',
+        // VLLength
+        '21',
+        'ED5F5AC8B98974A3CA843326D9B88CEBD0560177B973EE0B149F782CFAA06DC66A',
+        // Account
+        '81',
+        // VLLength
+        '14',
+        '5B812C9D57731E27A2DA8B1830195F88EF32A3B6',
+        // Destination
+        '83',
+        // VLLength
+        '14',
+        'B5F762798A53D543A014CAF8B297CFF8F2F937E8',
+      ].join(''),
+    )
+  })
+
   test('can fail gracefully for invalid TransactionType', function () {
     const invalidTransactionType = {
       ...tx_json,
@@ -78,7 +128,7 @@ describe('Signing data', function () {
 
   test('can create multi signing blobs', function () {
     const signingAccount = 'rJZdUusLDtY9NEsGea7ijqhVrXv98rYBYN'
-    const signingJson = Object.assign({}, tx_json, { SigningPubKey: '' })
+    const signingJson = { ...tx_json, SigningPubKey: '' }
     const actual = encodeForMultisigning(signingJson, signingAccount)
     expect(actual).toBe(
       [
@@ -120,6 +170,58 @@ describe('Signing data', function () {
       ].join(''),
     )
   })
+
+  test('can create multi signing blobs with custom definitions', function () {
+    const customPaymentDefinitions = JSON.parse(
+      JSON.stringify(normalDefinitions),
+    )
+    customPaymentDefinitions.TRANSACTION_TYPES.Payment = 31
+
+    const newDefs = new XrplDefinitions(customPaymentDefinitions)
+    const signingAccount = 'rJZdUusLDtY9NEsGea7ijqhVrXv98rYBYN'
+    const signingJson = { ...tx_json, SigningPubKey: '' }
+    const actual = encodeForMultisigning(signingJson, signingAccount, newDefs)
+    expect(actual).toBe(
+      [
+        '534D5400', // signingPrefix
+        // TransactionType
+        '12',
+        '001F',
+        // Flags
+        '22',
+        '80000000',
+        // Sequence
+        '24',
+        '00000001',
+        // Amount
+        '61',
+        // native amount
+        '40000000000003E8',
+        // Fee
+        '68',
+        // native amount
+        '400000000000000A',
+        // SigningPubKey
+        '73',
+        // VLLength
+        '00',
+        // '',
+        // Account
+        '81',
+        // VLLength
+        '14',
+        '5B812C9D57731E27A2DA8B1830195F88EF32A3B6',
+        // Destination
+        '83',
+        // VLLength
+        '14',
+        'B5F762798A53D543A014CAF8B297CFF8F2F937E8',
+        // signingAccount suffix
+        'C0A5ABEF242802EFED4B041E8F2D4A8CC86AE3D1',
+      ].join(''),
+    )
+  })
+
   test('can create claim blob', function () {
     const channel =
       '43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1'

packages/ripple-keypairs/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "ripple-keypairs",
-  "version": "1.1.5",
+  "name": "@transia/ripple-keypairs",
+  "version": "1.1.8-alpha.0",
   "description": "Cryptographic key pairs for the XRP Ledger",
   "scripts": {
     "build": "tsc -b",
@@ -17,15 +17,15 @@
     "test": "test"
   },
   "dependencies": {
+    "@transia/ripple-address-codec": "^4.2.8-alpha.0",
     "bn.js": "^5.1.1",
     "brorand": "^1.0.5",
     "elliptic": "^6.5.4",
-    "hash.js": "^1.0.3",
-    "ripple-address-codec": "^4.2.5"
+    "hash.js": "^1.0.3"
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:XRPLF/xrpl.js.git"
+    "url": "git@github.com/Transia-RnD/xrpl.js/tree/beta"
   },
   "license": "ISC",
   "prettier": "@xrplf/prettier-config",

packages/ripple-keypairs/src/index.ts

@@ -3,7 +3,7 @@ import brorand = require('brorand')
 import * as hashjs from 'hash.js'
 import * as elliptic from 'elliptic'
 
-import * as addressCodec from 'ripple-address-codec'
+import * as addressCodec from '@transia/ripple-address-codec'
 import { derivePrivateKey, accountPublicFromPublicGenerator } from './secp256k1'
 import * as utils from './utils'
 

packages/ripple-keypairs/test/codec.test.ts

@@ -1,5 +1,5 @@
 import assert from 'assert'
-import * as api from 'ripple-address-codec'
+import * as api from '@transia/ripple-address-codec'
 
 function toHex(bytes) {
   return Buffer.from(bytes).toString('hex').toUpperCase()

packages/ripple-keypairs/test/xrp-codec.test.ts

@@ -1,5 +1,5 @@
 import assert from 'assert'
-import * as api from 'ripple-address-codec'
+import * as api from '@transia/ripple-address-codec'
 
 function toHex(bytes: Buffer) {
   return Buffer.from(bytes).toString('hex').toUpperCase()

packages/xrpl/HISTORY.md

@@ -3,6 +3,12 @@
 Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xrpl-announce) for release announcements. We recommend that xrpl.js (ripple-lib) users stay up-to-date with the latest stable release.
 ## Unreleased
 
+### Added
+* Null and undefined values in transactions are now treated as though the field was not passed in.
+
+### Fixed
+* Added `destination_amount` to `PathOption` which is returned as part of a `path_find` request
+
 ## 2.7.0 (2023-03-08)
 
 ### Fixed

packages/xrpl/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "xrpl",
-  "version": "2.7.0",
+  "name": "@transia/xrpl",
+  "version": "2.7.3-alpha.1",
   "license": "ISC",
   "description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
   "files": [
@@ -22,14 +22,14 @@
     "https-proxy-agent": false
   },
   "dependencies": {
+    "@transia/ripple-address-codec": "^4.2.8-alpha.0",
+    "@transia/ripple-binary-codec": "^1.4.6-alpha.1",
+    "@transia/ripple-keypairs": "^1.1.8-alpha.0",
     "bignumber.js": "^9.0.0",
     "bip32": "^2.0.6",
     "bip39": "^3.0.4",
     "https-proxy-agent": "^5.0.0",
     "lodash": "^4.17.4",
-    "ripple-address-codec": "^4.2.5",
-    "ripple-binary-codec": "^1.4.3",
-    "ripple-keypairs": "^1.1.5",
     "ws": "^8.2.2"
   },
   "devDependencies": {
@@ -75,7 +75,7 @@
   "prettier": "@xrplf/prettier-config",
   "repository": {
     "type": "git",
-    "url": "git@github.com:XRPLF/xrpl.js.git"
+    "url": "git@github.com/Transia-RnD/xrpl.js/tree/beta"
   },
   "readmeFilename": "README.md",
   "engines": {

packages/xrpl/src/Wallet/fundWallet.ts

@@ -1,7 +1,7 @@
 import { IncomingMessage } from 'http'
 import { request as httpsRequest, RequestOptions } from 'https'
 
-import { isValidClassicAddress } from 'ripple-address-codec'
+import { isValidClassicAddress } from '@transia/ripple-address-codec'
 
 import type { Client } from '../client'
 import { RippledError, XRPLFaucetError } from '../errors'

packages/xrpl/src/Wallet/index.ts

@@ -3,30 +3,31 @@ import BigNumber from 'bignumber.js'
 import { fromSeed } from 'bip32'
 import { mnemonicToSeedSync, validateMnemonic } from 'bip39'
 import isEqual from 'lodash/isEqual'
+import omitBy from 'lodash/omitBy'
 import {
   classicAddressToXAddress,
   isValidXAddress,
   xAddressToClassicAddress,
   encodeSeed,
-} from 'ripple-address-codec'
+} from '@transia/ripple-address-codec'
 import {
   decode,
   encodeForSigning,
   encodeForMultisigning,
   encode,
-} from 'ripple-binary-codec'
+} from '@transia/ripple-binary-codec'
 import {
   deriveAddress,
   deriveKeypair,
   generateSeed,
   verify,
   sign,
-} from 'ripple-keypairs'
+} from '@transia/ripple-keypairs'
 
 import ECDSA from '../ECDSA'
 import { ValidationError, XrplError } from '../errors'
 import { IssuedCurrencyAmount } from '../models/common'
-import { Transaction } from '../models/transactions'
+import { Transaction, validate } from '../models/transactions'
 import { isIssuedCurrency } from '../models/transactions/common'
 import { isHex } from '../models/utils'
 import { ensureClassicAddress } from '../sugar/utils'
@@ -323,7 +324,12 @@ class Wallet {
       multisignAddress = this.classicAddress
     }
 
-    const tx = { ...transaction }
+    // clean null & undefined valued tx properties
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- ensure Transaction flows through
+    const tx = omitBy(
+      { ...transaction },
+      (value) => value == null,
+    ) as unknown as Transaction
 
     if (tx.TxnSignature || tx.Signers) {
       throw new ValidationError(
@@ -333,6 +339,12 @@ class Wallet {
 
     removeTrailingZeros(tx)
 
+    /*
+     * This will throw a more clear error for JS users if the supplied transaction has incorrect formatting
+     */
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- validate does not accept Transaction type
+    validate(tx as unknown as Record<string, unknown>)
+
     const txToSignAndEncode = { ...tx }
 
     txToSignAndEncode.SigningPubKey = multisignAddress ? '' : this.publicKey
@@ -460,9 +472,6 @@ class Wallet {
     })
 
     if (txCopy.TransactionType === 'NFTokenMint' && txCopy.URI) {
-      if (!isHex(txCopy.URI)) {
-        throw new ValidationError('URI must be a hex value')
-      }
       txCopy.URI = txCopy.URI.toUpperCase()
     }
 

packages/xrpl/src/Wallet/signer.ts

@@ -1,13 +1,13 @@
 import { BigNumber } from 'bignumber.js'
 import { flatMap } from 'lodash'
-import { decodeAccountID } from 'ripple-address-codec'
+import { decodeAccountID } from '@transia/ripple-address-codec'
 import {
   decode,
   encode,
   encodeForSigning,
   encodeForSigningClaim,
-} from 'ripple-binary-codec'
-import { sign as signWithKeypair, verify } from 'ripple-keypairs'
+} from '@transia/ripple-binary-codec'
+import { sign as signWithKeypair, verify } from '@transia/ripple-keypairs'
 
 import { ValidationError } from '../errors'
 import { Signer } from '../models/common'

packages/xrpl/src/client/index.ts

@@ -101,6 +101,7 @@ import {
   getXrpBalance,
   submit,
   submitAndWait,
+  getNetworkID,
 } from '../sugar'
 import fundWallet from '../Wallet/fundWallet'
 
@@ -200,6 +201,13 @@ class Client extends EventEmitter {
    */
   public readonly maxFeeXRP: string
 
+  /**
+   * Network ID of the server this sdk is connected to
+   *
+   * @category Fee
+   */
+  public networkID: number
+
   /**
    * Creates a new Client with a websocket connection to a rippled server.
    *
@@ -218,6 +226,7 @@ class Client extends EventEmitter {
 
     this.feeCushion = options.feeCushion ?? DEFAULT_FEE_CUSHION
     this.maxFeeXRP = options.maxFeeXRP ?? DEFAULT_MAX_FEE_XRP
+    this.networkID = 1
 
     this.connection = new Connection(server, options)
 
@@ -634,6 +643,11 @@ class Client extends EventEmitter {
    */
   public getLedgerIndex = getLedgerIndex
 
+  /**
+   * @category Abstraction
+   */
+  public getNetworkID = getNetworkID
+
   /**
    * @category Faucet
    */

packages/xrpl/src/client/partialPayment.ts

@@ -1,5 +1,5 @@
 import BigNumber from 'bignumber.js'
-import { decode } from 'ripple-binary-codec'
+import { decode } from '@transia/ripple-binary-codec'
 
 import type {
   AccountTxResponse,

packages/xrpl/src/models/common/index.ts

@@ -51,6 +51,84 @@ interface PathStep {
 
 export type Path = PathStep[]
 
+/**
+ * The object that describes the grant in HookGrants.
+ */
+export interface HookGrant {
+  /**
+   * The object that describes the grant in HookGrants.
+   */
+  HookGrant: {
+    /**
+     * The hook hash of the grant.
+     */
+    HookHash: string
+    /**
+     * The account authorized on the grant.
+     */
+    Authorize?: string
+  }
+}
+
+/**
+ * The object that describes the parameter in HookParameters.
+ */
+export interface HookParameter {
+  /**
+   * The object that describes the parameter in HookParameters.
+   */
+  HookParameter: {
+    /**
+     * The name of the parameter.
+     */
+    HookParameterName: string
+    /**
+     * The value of the parameter.
+     */
+    HookParameterValue: string
+  }
+}
+
+/**
+ * The object that describes the hook in Hooks.
+ */
+export interface Hook {
+  /**
+   * The object that describes the hook in Hooks.
+   */
+  Hook: {
+    HookHash?: string
+    /**
+     * The code that is executed when the hook is triggered.
+     */
+    CreateCode?: string
+    /**
+     * The flags that are set on the hook.
+     */
+    Flags?: number
+    /**
+     * The transactions that triggers the hook. Represented as a 256Hash
+     */
+    HookOn?: string
+    /**
+     * The namespace of the hook.
+     */
+    HookNamespace?: string
+    /**
+     * The API version of the hook.
+     */
+    HookApiVersion?: number
+    /**
+     * The parameters of the hook.
+     */
+    HookParameters?: HookParameter[]
+    /**
+     * The grants of the hook.
+     */
+    HookGrants?: HookGrant[]
+  }
+}
+
 /**
  * The object that describes the signer in SignerEntries.
  */

packages/xrpl/src/models/ledger/EmittedTxn.ts

@@ -0,0 +1,20 @@
+import { Transaction } from '../transactions'
+
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The EmittedTxn object type contains the
+ *
+ * @category Ledger Entries
+ */
+export default interface EmittedTxn extends BaseLedgerEntry {
+  LedgerEntryType: 'EmittedTxn'
+
+  EmittedTxn: Transaction
+
+  /**
+   * A hint indicating which page of the sender's owner directory links to this
+   * object, in case the directory consists of multiple pages.
+   */
+  OwnerNode: string
+}

packages/xrpl/src/models/ledger/Hook.ts

@@ -0,0 +1,27 @@
+import { Hook as WHook } from '../common'
+
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The Hook object type contains the
+ *
+ * @category Ledger Entries
+ */
+export default interface Hook extends BaseLedgerEntry {
+  LedgerEntryType: 'Hook'
+
+  /** The identifying (classic) address of this account. */
+  Account: string
+
+  /**
+   * A hint indicating which page of the sender's owner directory links to this
+   * object, in case the directory consists of multiple pages.
+   */
+  OwnerNode: string
+
+  PreviousTxnID: string
+
+  PreviousTxnLgrSeq: number
+
+  Hooks: WHook[]
+}

packages/xrpl/src/models/ledger/HookDefinition.ts

@@ -0,0 +1,67 @@
+import { HookParameter } from '../common'
+
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The HookDefintion object type contains the
+ *
+ * @category Ledger Entries
+ */
+export default interface HookDefintion extends BaseLedgerEntry {
+  LedgerEntryType: 'HookDefintion'
+
+  /**
+   * The flags that are set on the hook.
+   */
+  Flags: number
+
+  /**
+   * This field contains a string that is used to uniquely identify the hook.
+   */
+  HookHash: string
+
+  /**
+   * The transactions that triggers the hook. Represented as a 256Hash
+   */
+  HookOn?: string
+
+  /**
+   * The namespace of the hook.
+   */
+  HookNamespace?: string
+
+  /**
+   * The API version of the hook.
+   */
+  HookApiVersion?: string
+
+  /**
+   * The parameters of the hook.
+   */
+  HookParameters?: HookParameter[]
+
+  /**
+   * The code that is executed when the hook is triggered.
+   */
+  CreateCode?: string
+
+  /**
+   * This is an optional field that contains the transaction ID of the hook set.
+   */
+  HookSetTxnID?: string
+
+  /**
+   * This is an optional field that contains the number of references to this hook.
+   */
+  ReferenceCount?: number
+
+  /**
+   * This is an optional field that contains the fee associated with the hook.
+   */
+  Fee?: string
+
+  /**
+   * This is an optional field that contains the callback fee associated with the hook.
+   */
+  HookCallbackFee?: number
+}

packages/xrpl/src/models/ledger/HookState.ts

@@ -0,0 +1,29 @@
+import BaseLedgerEntry from './BaseLedgerEntry'
+
+/**
+ * The HookState object type contains the
+ *
+ * @category Ledger Entries
+ */
+export default interface HookState extends BaseLedgerEntry {
+  LedgerEntryType: 'HookState'
+
+  /**
+   * A hint indicating which page of the sender's owner directory links to this
+   * object, in case the directory consists of multiple pages.
+   */
+  OwnerNode: string
+
+  /**
+   * The HookStateKey property contains the key associated with this hook state,
+   * and the HookStateData property contains the data associated with this hook state.
+   */
+  HookStateKey: string
+
+  /**
+   * The `HookStateData` property contains the data associated with this hook state.
+   * It is typically a string containing the data associated with this hook state,
+   * such as an identifier or other information.
+   */
+  HookStateData: string
+}

packages/xrpl/src/models/ledger/LedgerEntry.ts

@@ -3,8 +3,12 @@ import Amendments from './Amendments'
 import Check from './Check'
 import DepositPreauth from './DepositPreauth'
 import DirectoryNode from './DirectoryNode'
+import EmittedTxn from './EmittedTxn'
 import Escrow from './Escrow'
 import FeeSettings from './FeeSettings'
+import Hook from './Hook'
+import HookDefinition from './HookDefinition'
+import HookState from './HookState'
 import LedgerHashes from './LedgerHashes'
 import NegativeUNL from './NegativeUNL'
 import Offer from './Offer'
@@ -19,8 +23,12 @@ type LedgerEntry =
   | Check
   | DepositPreauth
   | DirectoryNode
+  | EmittedTxn
   | Escrow
   | FeeSettings
+  | Hook
+  | HookDefinition
+  | HookState
   | LedgerHashes
   | NegativeUNL
   | Offer

packages/xrpl/src/models/ledger/index.ts

@@ -6,8 +6,12 @@ import Amendments from './Amendments'
 import Check from './Check'
 import DepositPreauth from './DepositPreauth'
 import DirectoryNode from './DirectoryNode'
+import EmittedTxn from './EmittedTxn'
 import Escrow from './Escrow'
 import FeeSettings from './FeeSettings'
+import Hook from './Hook'
+import HookDefinition from './HookDefinition'
+import HookState from './HookState'
 import Ledger from './Ledger'
 import LedgerEntry from './LedgerEntry'
 import LedgerHashes from './LedgerHashes'
@@ -26,8 +30,12 @@ export {
   Check,
   DepositPreauth,
   DirectoryNode,
+  EmittedTxn,
   Escrow,
   FeeSettings,
+  Hook,
+  HookDefinition,
+  HookState,
   Ledger,
   LedgerEntry,
   LedgerHashes,

packages/xrpl/src/models/methods/ledgerEntry.ts

@@ -137,6 +137,40 @@ export interface LedgerEntryRequest extends BaseRequest {
         ticket_sequence: number
       }
     | string
+  /**
+   * The object ID of a transaction emitted by the ledger entry.
+   */
+  emitted_txn?: string
+
+  /**
+   * The hash of the Hook object to retrieve.
+   */
+  hook_definition?: string
+
+  /**
+   * The Hook object to retrieve. If a string, must be the object ID of the Hook.
+   * If an object, requires `account` sub-field.
+   */
+  hook?:
+    | {
+        /** The account of the Hook object. */
+        account: string
+      }
+    | string
+
+  /**
+   * Object specifying the HookState object to retrieve. Requires the sub-fields
+   * `account`, `key`, and `namespace_id` to uniquely specify the HookState entry
+   * to retrieve.
+   */
+  hook_state?: {
+    /** The account of the Hook object. */
+    account: string
+    /** The key of the state. */
+    key: string
+    /** The namespace of the state. */
+    namespace_id: string
+  }
 }
 
 /**

packages/xrpl/src/models/methods/pathFind.ts

@@ -63,6 +63,11 @@ interface PathOption {
    * Destination to receive the desired amount.
    */
   source_amount: Amount
+  /**
+   * Destination Amount that the destination would receive along this path.
+   * If the `send_max` field is set, this field will be set.
+   */
+  destination_amount?: Amount
 }
 
 /**
@@ -80,7 +85,7 @@ export interface PathFindResponse extends BaseResponse {
     alternatives: PathOption[]
     /** Unique address of the account that would receive a transaction. */
     destination_account: string
-    /** Currency amount that the destination would receive in a transaction. */
+    /** Currency amount provided in the WebSocket request. */
     destination_amount: Amount
     /** Unique address that would send a transaction. */
     source_account: string

packages/xrpl/src/models/methods/serverInfo.ts

@@ -136,6 +136,10 @@ export interface ServerInfoResponse extends BaseResponse {
        * overall network's load factor.
        */
       load_factor?: number
+      /**
+       * The network id of the server.
+       */
+      network_id?: number
       /**
        * Current multiplier to the transaction cost based on
        * load to this server.

packages/xrpl/src/models/transactions/NFTokenMint.ts

@@ -86,8 +86,11 @@ export interface NFTokenMint extends BaseTransaction {
    *
    * This field must be hex-encoded. You can use `convertStringToHex` to
    * convert this field to the proper encoding.
+   *
+   * This field must not be an empty string. Omit it from the transaction or
+   * set to `undefined` value if you do not use it.
    */
-  URI?: string
+  URI?: string | null
   Flags?: number | NFTokenMintFlagsInterface
 }
 
@@ -106,6 +109,10 @@ export function validateNFTokenMint(tx: Record<string, unknown>): void {
     )
   }
 
+  if (typeof tx.URI === 'string' && tx.URI === '') {
+    throw new ValidationError('NFTokenMint: URI must not be empty string')
+  }
+
   if (typeof tx.URI === 'string' && !isHex(tx.URI)) {
     throw new ValidationError('NFTokenMint: URI must be in hex format')
   }

packages/xrpl/src/models/transactions/accountSet.ts

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

packages/xrpl/src/models/transactions/common.ts

@@ -1,10 +1,16 @@
 /* eslint-disable max-lines-per-function -- Necessary for validateBaseTransaction */
 /* eslint-disable complexity -- Necessary for validateBaseTransaction */
 /* eslint-disable max-statements -- Necessary for validateBaseTransaction */
-import { TRANSACTION_TYPES } from 'ripple-binary-codec'
+import { TRANSACTION_TYPES } from '@transia/ripple-binary-codec'
 
 import { ValidationError } from '../../errors'
-import { Amount, IssuedCurrencyAmount, Memo, Signer } from '../common'
+import {
+  Amount,
+  HookParameter,
+  IssuedCurrencyAmount,
+  Memo,
+  Signer,
+} from '../common'
 import { onlyHasFields } from '../utils'
 
 const MEMO_SIZE = 3
@@ -159,6 +165,14 @@ export interface BaseTransaction {
    * account it says it is from.
    */
   TxnSignature?: string
+  /**
+   * The network id of the transaction.
+   */
+  NetworkID?: number
+  /**
+   * The hook parameters of the transaction.
+   */
+  HookParameters?: HookParameter[]
 }
 
 /**
@@ -252,6 +266,9 @@ export function validateBaseTransaction(common: Record<string, unknown>): void {
   ) {
     throw new ValidationError('BaseTransaction: invalid TxnSignature')
   }
+  if (common.NetworkID !== undefined && typeof common.NetworkID !== 'number') {
+    throw new ValidationError('BaseTransaction: invalid NetworkID')
+  }
 }
 
 /**

packages/xrpl/src/models/transactions/import.ts

@@ -0,0 +1,24 @@
+import { BaseTransaction, validateBaseTransaction } from './common'
+
+/**
+ *
+ *
+ * @category Transaction Models
+ */
+export interface Import extends BaseTransaction {
+  TransactionType: 'Import'
+  /**
+   * Hex value representing a VL Blob.
+   */
+  Blob?: string
+}
+
+/**
+ * Verify the form and type of an Import at runtime.
+ *
+ * @param tx - An Import Transaction.
+ * @throws When the Import is Malformed.
+ */
+export function validateImport(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+}

packages/xrpl/src/models/transactions/index.ts

@@ -14,6 +14,8 @@ export { DepositPreauth } from './depositPreauth'
 export { EscrowCancel } from './escrowCancel'
 export { EscrowCreate } from './escrowCreate'
 export { EscrowFinish } from './escrowFinish'
+export { Import } from './import'
+export { Invoke } from './invoke'
 export { NFTokenAcceptOffer } from './NFTokenAcceptOffer'
 export { NFTokenBurn } from './NFTokenBurn'
 export { NFTokenCancelOffer } from './NFTokenCancelOffer'
@@ -42,6 +44,7 @@ export {
 export { PaymentChannelCreate } from './paymentChannelCreate'
 export { PaymentChannelFund } from './paymentChannelFund'
 export { SetRegularKey } from './setRegularKey'
+export { SetHookFlagsInterface, SetHookFlags, SetHook } from './setHook'
 export { SignerListSet } from './signerListSet'
 export { TicketCreate } from './ticketCreate'
 export { TrustSetFlagsInterface, TrustSetFlags, TrustSet } from './trustSet'

packages/xrpl/src/models/transactions/invoke.ts

@@ -0,0 +1,36 @@
+import { ValidationError } from '../../errors'
+
+import { BaseTransaction, validateBaseTransaction } from './common'
+
+/**
+ *
+ *
+ * @category Transaction Models
+ */
+export interface Invoke extends BaseTransaction {
+  TransactionType: 'Invoke'
+  /**
+   * If present, invokes the Hook on the Destination account.
+   */
+  Destination?: string
+  /**
+   * Hex value representing a VL Blob.
+   */
+  Blob?: string
+}
+
+/**
+ * Verify the form and type of an Invoke at runtime.
+ *
+ * @param tx - An Invoke Transaction.
+ * @throws When the Invoke is Malformed.
+ */
+export function validateInvoke(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  if (tx.Account === tx.Destination) {
+    throw new ValidationError(
+      'Invoke: Destination and Account must not be equal',
+    )
+  }
+}

packages/xrpl/src/models/transactions/metadata.ts

@@ -1,5 +1,19 @@
 import { Amount } from '../common'
 
+export interface HookExecution {
+  HookExecution: {
+    HookAccount: string
+    HookEmitCount: number
+    HookExecutionIndex: number
+    HookHash: string
+    HookInstructionCount: string
+    HookResult: number
+    HookReturnCode: number
+    HookReturnString: string
+    HookStateChangeCount: number
+  }
+}
+
 export interface CreatedNode {
   CreatedNode: {
     LedgerEntryType: string
@@ -60,6 +74,7 @@ export function isDeletedNode(node: Node): node is DeletedNode {
 }
 
 export interface TransactionMetadata {
+  HookExecutions: HookExecution[]
   AffectedNodes: Node[]
   DeliveredAmount?: Amount
   // "unavailable" possible for transactions before 2014-01-20

packages/xrpl/src/models/transactions/setHook.ts

@@ -0,0 +1,81 @@
+import { ValidationError } from '../../errors'
+import { Hook } from '../common'
+
+import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common'
+
+/**
+ * Enum representing values for Set Hook Transaction Flags.
+ *
+ * @category Transaction Flags
+ */
+export enum SetHookFlags {
+  /**
+   */
+  hsfOverride = 0x00000001,
+  /**
+   */
+  hsfNSDelete = 0x00000010,
+  /**
+   */
+  hsfCollect = 0x00000100,
+}
+
+export interface SetHookFlagsInterface extends GlobalFlags {
+  hsfOverride?: boolean
+  hsfNSDelete?: boolean
+  hsfCollect?: boolean
+}
+
+/**
+ *
+ *
+ * @category Transaction Models
+ */
+export interface SetHook extends BaseTransaction {
+  TransactionType: 'SetHook'
+  /**
+   *
+   */
+  Hooks: Hook[]
+
+  Flags?: number | SetHookFlagsInterface
+}
+
+const MAX_HOOKS = 4
+const HEX_REGEX = /^[0-9A-Fa-f]{64}$/u
+
+/**
+ * Verify the form and type of an SetHook at runtime.
+ *
+ * @param tx - An SetHook Transaction.
+ * @throws When the SetHook is Malformed.
+ */
+export function validateSetHook(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  if (!Array.isArray(tx.Hooks)) {
+    throw new ValidationError('SetHook: invalid Hooks')
+  }
+
+  if (tx.Hooks.length > MAX_HOOKS) {
+    throw new ValidationError(
+      `SetHook: maximum of ${MAX_HOOKS} hooks allowed in Hooks`,
+    )
+  }
+
+  for (const hook of tx.Hooks) {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Should be a Hook
+    const hookObject = hook as Hook
+    const { HookOn, HookNamespace } = hookObject.Hook
+    if (HookOn !== undefined && !HEX_REGEX.test(HookOn)) {
+      throw new ValidationError(
+        `SetHook: HookOn in Hook must be a 256-bit (32-byte) hexadecimal value`,
+      )
+    }
+    if (HookNamespace !== undefined && !HEX_REGEX.test(HookNamespace)) {
+      throw new ValidationError(
+        `SetHook: HookNamespace in Hook must be a 256-bit (32-byte) hexadecimal value`,
+      )
+    }
+  }
+}

packages/xrpl/src/models/transactions/transaction.ts

@@ -1,10 +1,6 @@
 /* eslint-disable complexity -- verifies 19 tx types hence a lot of checks needed */
 /* eslint-disable max-lines-per-function -- need to work with a lot of Tx verifications */
 
-import isEqual from 'lodash/isEqual'
-import omitBy from 'lodash/omitBy'
-import { encode, decode } from 'ripple-binary-codec'
-
 import { ValidationError } from '../../errors'
 import { setTransactionFlagsToNumber } from '../utils/flags'
 
@@ -17,6 +13,8 @@ import { DepositPreauth, validateDepositPreauth } from './depositPreauth'
 import { EscrowCancel, validateEscrowCancel } from './escrowCancel'
 import { EscrowCreate, validateEscrowCreate } from './escrowCreate'
 import { EscrowFinish, validateEscrowFinish } from './escrowFinish'
+import { Import, validateImport } from './import'
+import { Invoke, validateInvoke } from './invoke'
 import { TransactionMetadata } from './metadata'
 import {
   NFTokenAcceptOffer,
@@ -47,6 +45,7 @@ import {
   PaymentChannelFund,
   validatePaymentChannelFund,
 } from './paymentChannelFund'
+import { SetHook, validateSetHook } from './setHook'
 import { SetRegularKey, validateSetRegularKey } from './setRegularKey'
 import { SignerListSet, validateSignerListSet } from './signerListSet'
 import { TicketCreate, validateTicketCreate } from './ticketCreate'
@@ -65,6 +64,8 @@ export type Transaction =
   | EscrowCancel
   | EscrowCreate
   | EscrowFinish
+  | Import
+  | Invoke
   | NFTokenAcceptOffer
   | NFTokenBurn
   | NFTokenCancelOffer
@@ -76,6 +77,7 @@ export type Transaction =
   | PaymentChannelClaim
   | PaymentChannelCreate
   | PaymentChannelFund
+  | SetHook
   | SetRegularKey
   | SignerListSet
   | TicketCreate
@@ -144,6 +146,14 @@ export function validate(transaction: Record<string, unknown>): void {
       validateEscrowFinish(tx)
       break
 
+    case 'Import':
+      validateImport(tx)
+      break
+
+    case 'Invoke':
+      validateInvoke(tx)
+      break
+
     case 'NFTokenAcceptOffer':
       validateNFTokenAcceptOffer(tx)
       break
@@ -192,6 +202,10 @@ export function validate(transaction: Record<string, unknown>): void {
       validateSetRegularKey(tx)
       break
 
+    case 'SetHook':
+      validateSetHook(tx)
+      break
+
     case 'SignerListSet':
       validateSignerListSet(tx)
       break
@@ -209,13 +223,4 @@ export function validate(transaction: Record<string, unknown>): void {
         `Invalid field TransactionType: ${tx.TransactionType}`,
       )
   }
-
-  if (
-    !isEqual(
-      decode(encode(tx)),
-      omitBy(tx, (value) => value == null),
-    )
-  ) {
-    throw new ValidationError(`Invalid Transaction: ${tx.TransactionType}`)
-  }
 }

packages/xrpl/src/models/utils/flags.ts

@@ -20,6 +20,7 @@ import {
   PaymentChannelClaimFlagsInterface,
   PaymentChannelClaimFlags,
 } from '../transactions/paymentChannelClaim'
+import { SetHookFlagsInterface, SetHookFlags } from '../transactions/setHook'
 import type { Transaction } from '../transactions/transaction'
 import { TrustSetFlagsInterface, TrustSetFlags } from '../transactions/trustSet'
 
@@ -75,6 +76,15 @@ export function setTransactionFlagsToNumber(tx: Transaction): void {
     case 'TrustSet':
       tx.Flags = convertTrustSetFlagsToNumber(tx.Flags)
       return
+    case 'SetHook':
+      tx.Flags = convertSetHookFlagsToNumber(tx.Flags)
+      tx.Hooks.forEach((h) => {
+        h.Hook.Flags = convertSetHookFlagsToNumber(
+          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- idk
+          h.Hook.Flags as SetHookFlagsInterface,
+        )
+      })
+      return
     default:
       tx.Flags = 0
   }
@@ -108,6 +118,10 @@ function convertTrustSetFlagsToNumber(flags: TrustSetFlagsInterface): number {
   return reduceFlags(flags, TrustSetFlags)
 }
 
+function convertSetHookFlagsToNumber(flags: SetHookFlagsInterface): number {
+  return reduceFlags(flags, SetHookFlags)
+}
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any -- added ValidationError check for flagEnum
 function reduceFlags(flags: GlobalFlags, flagEnum: any): number {
   return Object.keys(flags).reduce((resultFlags, flag) => {

packages/xrpl/src/sugar/autofill.ts

@@ -1,5 +1,5 @@
 import BigNumber from 'bignumber.js'
-import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
+import { xAddressToClassicAddress, isValidXAddress } from '@transia/ripple-address-codec'
 
 import type { Client } from '..'
 import { ValidationError, XrplError } from '../errors'
@@ -8,10 +8,11 @@ import { Transaction } from '../models/transactions'
 import { setTransactionFlagsToNumber } from '../models/utils/flags'
 import { xrpToDrops } from '../utils'
 
-import getFeeXrp from './getFeeXrp'
+import { getFeeXrp } from './getFeeXrp'
 
 // Expire unconfirmed transactions after 20 ledger versions, approximately 1 minute, by default
 const LEDGER_OFFSET = 20
+const RESTRICTED_NETWORKS = 1024
 interface ClassicAccountAndTag {
   classicAccount: string
   tag: number | false | undefined
@@ -39,8 +40,10 @@ async function autofill<T extends Transaction>(
   setValidAddresses(tx)
 
   setTransactionFlagsToNumber(tx)
-
   const promises: Array<Promise<void>> = []
+  if (this.networkID > RESTRICTED_NETWORKS && tx.NetworkID == null) {
+    tx.NetworkID = this.networkID
+  }
   if (tx.Sequence == null) {
     promises.push(setNextValidSequenceNumber(this, tx))
   }

packages/xrpl/src/sugar/getFeeXrp.ts

@@ -14,7 +14,7 @@ const BASE_10 = 10
  * @param cushion - The fee cushion to use.
  * @returns The transaction fee.
  */
-export default async function getFeeXrp(
+export async function getFeeXrp(
   client: Client,
   cushion?: number,
 ): Promise<string> {
@@ -43,3 +43,22 @@ export default async function getFeeXrp(
   // Round fee to 6 decimal places
   return new BigNumber(fee.toFixed(NUM_DECIMAL_PLACES)).toString(BASE_10)
 }
+
+/**
+ * Calculates the estimated transaction fee.
+ * Note: This is a public API that can be called directly.
+ *
+ * @param client - The Client used to connect to the ledger.
+ * @param txBlob - The encoded transaction to estimate the fee for.
+ * @returns The transaction fee.
+ */
+export async function getFeeEstimateXrp(
+  client: Client,
+  txBlob: string,
+): Promise<string> {
+  const response = await client.request({
+    command: 'fee',
+    tx_blob: txBlob,
+  })
+  return response.result.drops.base_fee
+}

packages/xrpl/src/sugar/getNetworkID.ts

@@ -0,0 +1,15 @@
+import type { Client } from '..'
+// import { XrplError } from '../errors'
+
+/**
+ * Returns the network ID of the rippled server.
+ *
+ * @param this - The Client used to connect to the ledger.
+ * @returns The network id.
+ */
+export default async function getNetworkID(this: Client): Promise<number> {
+  const response = await this.request({
+    command: 'server_info',
+  })
+  return response.result.info.network_id ?? 1
+}

packages/xrpl/src/sugar/index.ts

@@ -5,6 +5,9 @@ export { getBalances, getXrpBalance } from './balances'
 export { default as getLedgerIndex } from './getLedgerIndex'
 
 export { default as getOrderbook } from './getOrderbook'
+export { getFeeXrp, getFeeEstimateXrp } from './getFeeXrp'
+
+export { default as getNetworkID } from './getNetworkID'
 
 export * from './submit'
 

packages/xrpl/src/sugar/submit.ts

@@ -1,4 +1,4 @@
-import { decode, encode } from 'ripple-binary-codec'
+import { decode, encode } from '@transia/ripple-binary-codec'
 
 import type { Client, SubmitRequest, SubmitResponse, Wallet } from '..'
 import { ValidationError, XrplError } from '../errors'

packages/xrpl/src/sugar/utils.ts

@@ -1,4 +1,4 @@
-import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
+import { xAddressToClassicAddress, isValidXAddress } from '@transia/ripple-address-codec'
 
 /**
  * If an address is an X-Address, converts it to a classic address.

packages/xrpl/src/utils/derive.ts

@@ -1,5 +1,5 @@
-import { classicAddressToXAddress } from 'ripple-address-codec'
-import { deriveKeypair, deriveAddress } from 'ripple-keypairs'
+import { classicAddressToXAddress } from '@transia/ripple-address-codec'
+import { deriveKeypair, deriveAddress } from '@transia/ripple-keypairs'
 
 /**
  * Derive an X-Address from a public key and a destination tag.

packages/xrpl/src/utils/hashes/hashLedger.ts

@@ -4,7 +4,7 @@
    bitwise operators for and-ing numbers with a mask and bit shifting. */
 
 import BigNumber from 'bignumber.js'
-import { decode, encode } from 'ripple-binary-codec'
+import { decode, encode } from '@transia/ripple-binary-codec'
 
 import { ValidationError, XrplError } from '../../errors'
 import type { Ledger } from '../../models/ledger'

packages/xrpl/src/utils/hashes/index.ts

@@ -4,7 +4,7 @@
    bitwise operators for and-ing numbers with a mask and bit shifting. */
 
 import BigNumber from 'bignumber.js'
-import { decodeAccountID } from 'ripple-address-codec'
+import { decodeAccountID } from '@transia/ripple-address-codec'
 
 import hashLedger, {
   hashLedgerHeader,

packages/xrpl/src/utils/hooks.ts

@@ -0,0 +1,125 @@
+/**
+ * @module tts
+ * @description
+ * This module contains the transaction types and the function to calculate the hook on
+ */
+
+import {
+  TRANSACTION_TYPES,
+  TRANSACTION_TYPE_MAP,
+} from '@transia/ripple-binary-codec'
+import createHash = require('create-hash')
+
+import { XrplError } from '../errors'
+import { HookParameter } from '../models/common'
+
+/**
+ * @constant tts
+ * @description
+ * Transaction types
+ */
+
+/**
+ * @typedef TTS
+ * @description
+ * Transaction types
+ */
+export type TTS = typeof TRANSACTION_TYPE_MAP
+
+/**
+ * Calculate the hook on
+ *
+ * @param arr - array of transaction types
+ * @returns the hook on
+ */
+export function calculateHookOn(arr: Array<keyof TTS>): string {
+  let hash =
+    '0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffbfffff'
+  arr.forEach((nth) => {
+    if (typeof nth !== 'string') {
+      throw new XrplError(`HookOn transaction type must be string`)
+    }
+    if (!TRANSACTION_TYPES.includes(String(nth))) {
+      throw new XrplError(
+        `invalid transaction type '${String(nth)}' in HookOn array`,
+      )
+    }
+
+    const tts: Record<string, number> = TRANSACTION_TYPE_MAP
+    let value = BigInt(hash)
+    // eslint-disable-next-line no-bitwise -- Required
+    value ^= BigInt(1) << BigInt(tts[nth])
+    // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- Required
+    hash = `0x${value.toString(16)}`
+  })
+  hash = hash.replace('0x', '')
+  // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- Required
+  hash = hash.padStart(64, '0')
+  return hash.toUpperCase()
+}
+
+/**
+ * Calculate the sha256 of a string
+ *
+ * @param string - the string to calculate the sha256
+ * @returns the sha256
+ */
+export async function sha256(string: string): Promise<string> {
+  const hash = createHash('sha256')
+  hash.update(string)
+  const hashBuffer = hash.digest()
+  const hashArray = Array.from(new Uint8Array(hashBuffer))
+  const hashHex = hashArray
+    // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- Required
+    .map((bytes) => bytes.toString(16).padStart(2, '0'))
+    .join('')
+  return hashHex
+}
+
+/**
+ * Calculate the hex of a namespace
+ *
+ * @param namespace - the namespace to calculate the hex
+ * @returns the hex
+ */
+export async function hexNamespace(namespace: string): Promise<string> {
+  return (await sha256(namespace)).toUpperCase()
+}
+
+function isHex(value: string): boolean {
+  return /^[0-9A-F]+$/iu.test(value)
+}
+
+function hexValue(value: string): string {
+  return Buffer.from(value, 'utf8').toString('hex').toUpperCase()
+}
+
+/**
+ * Calculate the hex of the hook parameters
+ *
+ * @param data - the hook parameters
+ * @returns the hex of the hook parameters
+ */
+export function hexHookParameters(data: HookParameter[]): HookParameter[] {
+  const hookParameters: HookParameter[] = []
+  for (const parameter of data) {
+    let hookPName = parameter.HookParameter.HookParameterName
+    let hookPValue = parameter.HookParameter.HookParameterValue
+
+    if (!isHex(hookPName)) {
+      hookPName = hexValue(hookPName)
+    }
+
+    if (!isHex(hookPValue)) {
+      hookPValue = hexValue(hookPValue)
+    }
+
+    hookParameters.push({
+      HookParameter: {
+        HookParameterName: hookPName,
+        HookParameterValue: hookPValue,
+      },
+    })
+  }
+  return hookParameters
+}

packages/xrpl/src/utils/index.ts

@@ -13,9 +13,9 @@ import {
   isValidClassicAddress,
   isValidXAddress,
   xAddressToClassicAddress,
-} from 'ripple-address-codec'
-import * as rbc from 'ripple-binary-codec'
-import { verify as verifyKeypairSignature } from 'ripple-keypairs'
+} from '@transia/ripple-address-codec'
+import * as rbc from '@transia/ripple-binary-codec'
+import { verify as verifyKeypairSignature } from '@transia/ripple-keypairs'
 
 import { LedgerEntry } from '../models/ledger'
 import { Response } from '../models/methods'
@@ -40,6 +40,7 @@ import {
   hashEscrow,
   hashPaymentChannel,
 } from './hashes'
+import { calculateHookOn, hexNamespace, hexHookParameters, TTS } from './hooks'
 import parseNFTokenID from './parseNFTokenID'
 import {
   percentToTransferRate,
@@ -222,4 +223,8 @@ export {
   getNFTokenID,
   createCrossChainPayment,
   parseNFTokenID,
+  calculateHookOn,
+  hexNamespace,
+  hexHookParameters,
+  TTS,
 }

packages/xrpl/src/utils/parseNFTokenID.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-magic-numbers -- Doing hex string parsing. */
 import BigNumber from 'bignumber.js'
-import { encodeAccountID } from 'ripple-address-codec'
+import { encodeAccountID } from '@transia/ripple-address-codec'
 
 import { XrplError } from '../errors'
 

packages/xrpl/src/utils/signPaymentChannelClaim.ts

@@ -1,5 +1,5 @@
-import { encodeForSigningClaim } from 'ripple-binary-codec'
-import { sign } from 'ripple-keypairs'
+import { encodeForSigningClaim } from '@transia/ripple-binary-codec'
+import { sign } from '@transia/ripple-keypairs'
 
 import { xrpToDrops } from './xrpConversion'
 

packages/xrpl/src/utils/verifyPaymentChannelClaim.ts

@@ -1,5 +1,5 @@
-import { encodeForSigningClaim } from 'ripple-binary-codec'
-import { verify } from 'ripple-keypairs'
+import { encodeForSigningClaim } from '@transia/ripple-binary-codec'
+import { verify } from '@transia/ripple-keypairs'
 
 import { xrpToDrops } from './xrpConversion'
 

packages/xrpl/test/client/getFeeXrp.test.ts

@@ -1,6 +1,6 @@
 import { assert } from 'chai'
 
-import getFeeXrp from '../../src/sugar/getFeeXrp'
+import { getFeeXrp } from '../../src/sugar/getFeeXrp'
 import rippled from '../fixtures/rippled'
 import {
   setupClient,

packages/xrpl/test/integration/requests/submit.test.ts

@@ -1,5 +1,5 @@
 import { assert } from 'chai'
-import { decode } from 'ripple-binary-codec'
+import { decode } from '@transia/ripple-binary-codec'
 
 import {
   AccountSet,

packages/xrpl/test/integration/requests/submitMultisigned.test.ts

@@ -1,5 +1,5 @@
 import { assert } from 'chai'
-import { decode } from 'ripple-binary-codec'
+import { decode } from '@transia/ripple-binary-codec'
 
 import {
   AccountSet,

packages/xrpl/test/integration/utils.ts

@@ -1,7 +1,7 @@
 import { assert } from 'chai'
 import omit from 'lodash/omit'
 import throttle from 'lodash/throttle'
-import { decode } from 'ripple-binary-codec'
+import { decode } from '@transia/ripple-binary-codec'
 
 import {
   Client,

packages/xrpl/test/models/NFTokenMint.test.ts

@@ -68,6 +68,26 @@ describe('NFTokenMint', function () {
     )
   })
 
+  it(`throws w/ URI being an empty string`, function () {
+    const invalid = {
+      TransactionType: 'NFTokenMint',
+      Account: 'rWYkbWkCeg8dP6rXALnjgZSjjLyih5NXm',
+      Fee: '5000000',
+      Sequence: 2470665,
+      Flags: NFTokenMintFlags.tfTransferable,
+      NFTokenTaxon: 0,
+      Issuer: 'r9LqNeG6qHxjeUocjvVki2XR35weJ9mZgQ',
+      TransferFee: 1,
+      URI: '',
+    } as any
+
+    assert.throws(
+      () => validate(invalid),
+      ValidationError,
+      'NFTokenMint: URI must not be empty string',
+    )
+  })
+
   it(`throws w/ URI not in hex format`, function () {
     const invalid = {
       TransactionType: 'NFTokenMint',

packages/xrpl/test/models/setHook.test.ts

@@ -0,0 +1,150 @@
+import { assert } from 'chai'
+
+import { validate, ValidationError } from '../../src'
+import { validateSetHook } from '../../src/models/transactions/setHook'
+
+/**
+ * SetHook Transaction Verification Testing.
+ *
+ * Providing runtime verification testing for each specific transaction type.
+ */
+describe('SetHook', function () {
+  let setHookTx
+
+  beforeEach(function () {
+    setHookTx = {
+      Flags: 0,
+      TransactionType: 'SetHook',
+      Account: 'rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn',
+      Fee: '12',
+      Hooks: [
+        {
+          Hook: {
+            CreateCode:
+              '0061736D01000000011C0460057F7F7F7F7F017E60037F7F7E017E60027F7F017F60017F017E02230303656E76057472616365000003656E7606616363657074000103656E76025F670002030201030503010002062B077F0141B088040B7F004180080B7F0041A6080B7F004180080B7F0041B088040B7F0041000B7F0041010B07080104686F6F6B00030AC4800001C0800001017F230041106B220124002001200036020C41920841134180084112410010001A410022002000420010011A41012200200010021A200141106A240042000B0B2C01004180080B254163636570742E633A2043616C6C65642E00224163636570742E633A2043616C6C65642E22',
+            HookOn:
+              'FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFBFFFF7',
+            Flags: 1,
+            HookApiVersion: 0,
+            HookNamespace:
+              '4FF9961269BF7630D32E15276569C94470174A5DA79FA567C0F62251AA9A36B9',
+          },
+        },
+      ],
+    } as any
+  })
+
+  it(`verifies valid SetHook`, function () {
+    assert.doesNotThrow(() => validateSetHook(setHookTx))
+    assert.doesNotThrow(() => validate(setHookTx))
+  })
+
+  // it(`throws w/ empty Hooks`, function () {
+  //   setHookTx.Hooks = []
+
+  //   assert.throws(
+  //     () => validateSetHook(setHookTx),
+  //     ValidationError,
+  //     'SetHook: need at least 1 member in Hooks',
+  //   )
+  //   assert.throws(
+  //     () => validate(setHookTx),
+  //     ValidationError,
+  //     'SetHook: need at least 1 member in Hooks',
+  //   )
+  // })
+
+  it(`throws w/ invalid Hooks`, function () {
+    setHookTx.Hooks = 'khgfgyhujk'
+
+    assert.throws(
+      () => validateSetHook(setHookTx),
+      ValidationError,
+      'SetHook: invalid Hooks',
+    )
+    assert.throws(
+      () => validate(setHookTx),
+      ValidationError,
+      'SetHook: invalid Hooks',
+    )
+  })
+
+  it(`throws w/ maximum of 4 members allowed in Hooks`, function () {
+    setHookTx.Hooks = []
+    const hook = {
+      Hook: {
+        CreateCode:
+          '0061736D01000000011C0460057F7F7F7F7F017E60037F7F7E017E60027F7F017F60017F017E02230303656E76057472616365000003656E7606616363657074000103656E76025F670002030201030503010002062B077F0141B088040B7F004180080B7F0041A6080B7F004180080B7F0041B088040B7F0041000B7F0041010B07080104686F6F6B00030AC4800001C0800001017F230041106B220124002001200036020C41920841134180084112410010001A410022002000420010011A41012200200010021A200141106A240042000B0B2C01004180080B254163636570742E633A2043616C6C65642E00224163636570742E633A2043616C6C65642E22',
+        HookOn:
+          'FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFBFFFF7',
+        Flags: 1,
+        HookApiVersion: 0,
+        HookNamespace:
+          '4FF9961269BF7630D32E15276569C94470174A5DA79FA567C0F62251AA9A36B9',
+      },
+    }
+    setHookTx.Hooks.push(hook)
+    setHookTx.Hooks.push(hook)
+    setHookTx.Hooks.push(hook)
+    setHookTx.Hooks.push(hook)
+    setHookTx.Hooks.push(hook)
+
+    const errorMessage = 'SetHook: maximum of 4 hooks allowed in Hooks'
+    assert.throws(
+      () => validateSetHook(setHookTx),
+      ValidationError,
+      errorMessage,
+    )
+    assert.throws(() => validate(setHookTx), ValidationError, errorMessage)
+  })
+
+  it(`throws w/ invalid HookOn in Hooks`, function () {
+    setHookTx.SignerQuorum = 2
+    setHookTx.Hooks = [
+      {
+        Hook: {
+          CreateCode:
+            '0061736D01000000011C0460057F7F7F7F7F017E60037F7F7E017E60027F7F017F60017F017E02230303656E76057472616365000003656E7606616363657074000103656E76025F670002030201030503010002062B077F0141B088040B7F004180080B7F0041A6080B7F004180080B7F0041B088040B7F0041000B7F0041010B07080104686F6F6B00030AC4800001C0800001017F230041106B220124002001200036020C41920841134180084112410010001A410022002000420010011A41012200200010021A200141106A240042000B0B2C01004180080B254163636570742E633A2043616C6C65642E00224163636570742E633A2043616C6C65642E22',
+          HookOn: '',
+          Flags: 1,
+          HookApiVersion: 0,
+          HookNamespace:
+            '4FF9961269BF7630D32E15276569C94470174A5DA79FA567C0F62251AA9A36B9',
+        },
+      },
+    ]
+    const errorMessage =
+      'SetHook: HookOn in Hook must be a 256-bit (32-byte) hexadecimal value'
+    assert.throws(
+      () => validateSetHook(setHookTx),
+      ValidationError,
+      errorMessage,
+    )
+    assert.throws(() => validate(setHookTx), ValidationError, errorMessage)
+  })
+
+  it(`throws w/ invalid HookNamespace in Hooks`, function () {
+    setHookTx.SignerQuorum = 2
+    setHookTx.Hooks = [
+      {
+        Hook: {
+          CreateCode:
+            '0061736D01000000011C0460057F7F7F7F7F017E60037F7F7E017E60027F7F017F60017F017E02230303656E76057472616365000003656E7606616363657074000103656E76025F670002030201030503010002062B077F0141B088040B7F004180080B7F0041A6080B7F004180080B7F0041B088040B7F0041000B7F0041010B07080104686F6F6B00030AC4800001C0800001017F230041106B220124002001200036020C41920841134180084112410010001A410022002000420010011A41012200200010021A200141106A240042000B0B2C01004180080B254163636570742E633A2043616C6C65642E00224163636570742E633A2043616C6C65642E22',
+          HookOn:
+            'FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFBFFFF7',
+          Flags: 1,
+          HookApiVersion: 0,
+          HookNamespace: '',
+        },
+      },
+    ]
+    const errorMessage =
+      'SetHook: HookNamespace in Hook must be a 256-bit (32-byte) hexadecimal value'
+    assert.throws(
+      () => validateSetHook(setHookTx),
+      ValidationError,
+      errorMessage,
+    )
+    assert.throws(() => validate(setHookTx), ValidationError, errorMessage)
+  })
+})

packages/xrpl/test/utils/hashes.test.ts

@@ -2,7 +2,7 @@ import fs from 'fs'
 import path from 'path'
 
 import { assert } from 'chai'
-import { encode } from 'ripple-binary-codec'
+import { encode } from '@transia/ripple-binary-codec'
 
 import { OfferCreate, Transaction, ValidationError } from '../../src'
 import {

packages/xrpl/test/utils/hooks.test.ts

@@ -0,0 +1,64 @@
+import { assert } from 'chai'
+
+import {
+  calculateHookOn,
+  hexNamespace,
+  hexHookParameters,
+  TTS,
+} from '../../src'
+
+describe('test hook on', function () {
+  it('invalid', function () {
+    const invokeOn: Array<keyof TTS> = ['AccountSet1']
+    expect(() => {
+      calculateHookOn(invokeOn)
+    }).toThrow("invalid transaction type 'AccountSet1' in HookOn array")
+  })
+  it('all', function () {
+    const result = calculateHookOn([])
+    assert.equal(
+      result,
+      'FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFBFFFFF',
+    )
+  })
+  it('one', function () {
+    const invokeOn: Array<keyof TTS> = ['AccountSet']
+    const result = calculateHookOn(invokeOn)
+    assert.equal(
+      result,
+      'FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFBFFFF7',
+    )
+  })
+})
+
+describe('test hook namespace', function () {
+  it('basic', async function () {
+    const result = await hexNamespace('starter')
+    assert.equal(
+      result,
+      '4FF9961269BF7630D32E15276569C94470174A5DA79FA567C0F62251AA9A36B9',
+    )
+  })
+})
+
+describe('test hook parameters', function () {
+  it('basic', async function () {
+    const parameters = [
+      {
+        HookParameter: {
+          HookParameterName: 'name1',
+          HookParameterValue: 'value1',
+        },
+      },
+    ]
+    const result = hexHookParameters(parameters)
+    assert.deepEqual(result, [
+      {
+        HookParameter: {
+          HookParameterName: '6E616D6531',
+          HookParameterValue: '76616C756531',
+        },
+      },
+    ])
+  })
+})

packages/xrpl/test/wallet/index.test.ts

@@ -1,5 +1,5 @@
 import { assert } from 'chai'
-import { decode } from 'ripple-binary-codec'
+import { decode } from '@transia/ripple-binary-codec'
 
 import { NFTokenMint, Payment, Transaction } from '../../src'
 import ECDSA from '../../src/ECDSA'
@@ -864,6 +864,171 @@ describe('Wallet', function () {
       assert.deepEqual(result, expectedResult)
     })
 
+    it('sign throws when NFTokenMint.URI is empty string', async function () {
+      const tx: NFTokenMint = {
+        TransactionType: 'NFTokenMint',
+        Account: wallet.address,
+        TransferFee: 314,
+        NFTokenTaxon: 0,
+        Flags: 8,
+        Fee: '10',
+        URI: '',
+        Memos: [
+          {
+            Memo: {
+              MemoType:
+                '687474703a2f2f6578616d706c652e636f6d2f6d656d6f2f67656e65726963',
+              MemoData: '72656e74',
+            },
+          },
+        ],
+      }
+
+      assert.throws(() => {
+        wallet.sign(tx)
+      }, /URI must not be empty string/u)
+    })
+
+    it('sign removes undefined NFTokenMint.URI property from transaction blob', async function () {
+      const tx: NFTokenMint = {
+        TransactionType: 'NFTokenMint',
+        Account: wallet.address,
+        TransferFee: 314,
+        NFTokenTaxon: 0,
+        Flags: 8,
+        Fee: '10',
+        URI: undefined,
+        Memos: [
+          {
+            Memo: {
+              MemoType:
+                '687474703a2f2f6578616d706c652e636f6d2f6d656d6f2f67656e65726963',
+              MemoData: '72656e74',
+            },
+          },
+        ],
+      }
+      const result = wallet.sign(tx)
+      const decodedTx = decode(result.tx_blob) as unknown as NFTokenMint
+
+      assert.notExists(decodedTx.URI)
+    })
+
+    it('sign removes nulled NFTokenMint.URI property from transaction blob', async function () {
+      const tx: NFTokenMint = {
+        TransactionType: 'NFTokenMint',
+        Account: wallet.address,
+        TransferFee: 314,
+        NFTokenTaxon: 0,
+        Flags: 8,
+        Fee: '10',
+        URI: null,
+        Memos: [
+          {
+            Memo: {
+              MemoType:
+                '687474703a2f2f6578616d706c652e636f6d2f6d656d6f2f67656e65726963',
+              MemoData: '72656e74',
+            },
+          },
+        ],
+      }
+      const result = wallet.sign(tx)
+      const decodedTx = decode(result.tx_blob) as unknown as NFTokenMint
+
+      assert.notExists(decodedTx.URI)
+    })
+
+    it('sign allows undefined value for NFTokenMint.URI', async function () {
+      // transaction with explicit URI: undefined
+      const tx_1: NFTokenMint = {
+        TransactionType: 'NFTokenMint',
+        Account: wallet.address,
+        TransferFee: 314,
+        NFTokenTaxon: 0,
+        Flags: 8,
+        Fee: '10',
+        URI: undefined,
+        Memos: [
+          {
+            Memo: {
+              MemoType:
+                '687474703a2f2f6578616d706c652e636f6d2f6d656d6f2f67656e65726963',
+              MemoData: '72656e74',
+            },
+          },
+        ],
+      }
+      const result_1 = wallet.sign(tx_1)
+
+      // transaction with no URI
+      const tx_2: NFTokenMint = {
+        TransactionType: 'NFTokenMint',
+        Account: wallet.address,
+        TransferFee: 314,
+        NFTokenTaxon: 0,
+        Flags: 8,
+        Fee: '10',
+        Memos: [
+          {
+            Memo: {
+              MemoType:
+                '687474703a2f2f6578616d706c652e636f6d2f6d656d6f2f67656e65726963',
+              MemoData: '72656e74',
+            },
+          },
+        ],
+      }
+      const result_2 = wallet.sign(tx_2)
+
+      assert.deepEqual(result_1, result_2)
+    })
+
+    it('sign allows nulled value for NFTokenMint.URI', async function () {
+      // transaction with explicit URI: null
+      const tx_1: NFTokenMint = {
+        TransactionType: 'NFTokenMint',
+        Account: wallet.address,
+        TransferFee: 314,
+        NFTokenTaxon: 0,
+        Flags: 8,
+        Fee: '10',
+        URI: null,
+        Memos: [
+          {
+            Memo: {
+              MemoType:
+                '687474703a2f2f6578616d706c652e636f6d2f6d656d6f2f67656e65726963',
+              MemoData: '72656e74',
+            },
+          },
+        ],
+      }
+      const result_1 = wallet.sign(tx_1)
+
+      // transaction with no URI
+      const tx_2: NFTokenMint = {
+        TransactionType: 'NFTokenMint',
+        Account: wallet.address,
+        TransferFee: 314,
+        NFTokenTaxon: 0,
+        Flags: 8,
+        Fee: '10',
+        Memos: [
+          {
+            Memo: {
+              MemoType:
+                '687474703a2f2f6578616d706c652e636f6d2f6d656d6f2f67656e65726963',
+              MemoData: '72656e74',
+            },
+          },
+        ],
+      }
+      const result_2 = wallet.sign(tx_2)
+
+      assert.deepEqual(result_1, result_2)
+    })
+
     it('sign allows lowercase hex value for NFTokenMint.URI', async function () {
       const tx: NFTokenMint = {
         TransactionType: 'NFTokenMint',
@@ -915,7 +1080,7 @@ describe('Wallet', function () {
 
       assert.throws(() => {
         wallet.sign(tx)
-      }, /URI must be a hex value/u)
+      }, /URI must be in hex format/u)
     })
   })
 

packages/xrpl/test/wallet/signer.test.ts

@@ -1,5 +1,5 @@
 import { assert } from 'chai'
-import { decode, encode } from 'ripple-binary-codec'
+import { decode, encode } from '@transia/ripple-binary-codec'
 
 import { Transaction, ValidationError } from '../../src'
 import Wallet from '../../src/Wallet'
@@ -139,7 +139,9 @@ describe('Signer', function () {
   it('multisign runs successfully with tx_blobs', function () {
     const transactions = [multisignTxToCombine1, multisignTxToCombine2]
 
-    const encodedTransactions: string[] = transactions.map(encode)
+    const encodedTransactions: string[] = transactions.map((transaction) =>
+      encode(transaction),
+    )
 
     assert.deepEqual(multisign(encodedTransactions), expectedMultisign)
   })