ripple-binary-codec 2.7.0-smartescrow.0 → 2.8.0-smartcontract.0

package/src/types/serialized-type.ts

@@ -2,6 +2,69 @@ import { BytesList } from '../serdes/binary-serializer'
 import { BinaryParser } from '../serdes/binary-parser'
 import { XrplDefinitionsBase } from '../enums'
 import { bytesToHex } from '@xrplf/isomorphic/utils'
+import definitions from '../enums/definitions.json'
+
+/**
+ * Enum for SerializedTypeID values used in XRPL
+ * These match the C++ implementation's STI_ constants
+ */
+export enum SerializedTypeID {
+  STI_NOTPRESENT = 0,
+  STI_UINT16 = 1,
+  STI_UINT32 = 2,
+  STI_UINT64 = 3,
+  STI_UINT128 = 4,
+  STI_UINT256 = 5,
+  STI_AMOUNT = 6,
+  STI_VL = 7,
+  STI_ACCOUNT = 8,
+  STI_NUMBER = 9,
+  STI_INT32 = 10,
+  STI_INT64 = 11,
+
+  STI_OBJECT = 14,
+  STI_ARRAY = 15,
+
+  STI_UINT8 = 16,
+  STI_UINT160 = 17,
+  STI_PATHSET = 18,
+  STI_VECTOR256 = 19,
+  STI_UINT96 = 20,
+  STI_UINT192 = 21,
+  STI_UINT384 = 22,
+  STI_UINT512 = 23,
+  STI_ISSUE = 24,
+  STI_XCHAIN_BRIDGE = 25,
+  STI_CURRENCY = 26,
+  STI_DATA = 27,
+  STI_DATATYPE = 28,
+  STI_JSON = 29,
+}
+
+/**
+ * Maps built dynamically from definitions.json TYPES.
+ * This ensures type string names (e.g. "Hash256", "Hash128") stay in sync
+ * with the canonical definitions rather than using hardcoded uppercase variants.
+ */
+
+// Map of type name strings to SerializedTypeID values
+export const TYPE_STRING_TO_ID: Record<string, SerializedTypeID> = {}
+
+// Map of numeric type codes to SerializedTypeID values
+export const TYPE_NUMBER_TO_ID: Record<number, SerializedTypeID> = {}
+
+// Map of SerializedTypeID values to type name strings
+export const TYPE_ID_TO_STRING: Record<number, string> = {}
+
+// Populate all three maps from definitions.json TYPES
+for (const [name, id] of Object.entries(definitions.TYPES)) {
+  if (id >= 0) {
+    const typeId = id as SerializedTypeID
+    TYPE_STRING_TO_ID[name] = typeId
+    TYPE_NUMBER_TO_ID[id] = typeId
+    TYPE_ID_TO_STRING[typeId] = name
+  }
+}
 
 type JSON = string | number | boolean | null | undefined | JSON[] | JsonObject
 
@@ -77,6 +140,10 @@ class SerializedType {
   toString(): string {
     return this.toHex()
   }
+
+  getSType(): SerializedTypeID {
+    return this.getSType()
+  }
 }
 
 /**

package/src/types/st-array.ts

@@ -1,5 +1,5 @@
 import { DEFAULT_DEFINITIONS, XrplDefinitionsBase } from '../enums'
-import { SerializedType, JsonObject } from './serialized-type'
+import { SerializedType, JsonObject, SerializedTypeID } from './serialized-type'
 import { STObject } from './st-object'
 import { BinaryParser } from '../serdes/binary-parser'
 import { concat } from '@xrplf/isomorphic/utils'
@@ -108,6 +108,10 @@ class STArray extends SerializedType {
 
     return result
   }
+
+  getSType(): SerializedTypeID {
+    return SerializedTypeID.STI_ARRAY
+  }
 }
 
 export { STArray }

package/src/types/st-number.ts

@@ -1,6 +1,6 @@
 /* eslint-disable complexity -- required for various checks */
 import { BinaryParser } from '../serdes/binary-parser'
-import { SerializedType } from './serialized-type'
+import { SerializedType, SerializedTypeID } from './serialized-type'
 import { writeInt32BE, writeInt64BE, readInt32BE, readInt64BE } from '../utils'
 
 /**
@@ -307,4 +307,8 @@ export class STNumber extends SerializedType {
       fractionPart ? '.' + fractionPart : ''
     }`
   }
+
+  getSType(): SerializedTypeID {
+    return SerializedTypeID.STI_NUMBER
+  }
 }

package/src/types/st-object.ts

@@ -4,7 +4,7 @@ import {
   Bytes,
   XrplDefinitionsBase,
 } from '../enums'
-import { SerializedType, JsonObject } from './serialized-type'
+import { SerializedType, JsonObject, SerializedTypeID } from './serialized-type'
 import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
 import { BinaryParser } from '../serdes/binary-parser'
 import { BinarySerializer, BytesList } from '../serdes/binary-serializer'
@@ -151,7 +151,13 @@ class STObject extends SerializedType {
             ? STArray.from(xAddressDecoded[field.name], definitions)
             : field.type.name === 'UInt64'
               ? UInt64.from(xAddressDecoded[field.name], field.name)
-              : field.associatedType.from(xAddressDecoded[field.name])
+              : field.associatedType?.from
+                ? field.associatedType.from(xAddressDecoded[field.name])
+                : (() => {
+                    throw new Error(
+                      `Type ${field.type.name} for field ${field.name} is missing associatedType.from`,
+                    )
+                  })()
 
       if (associatedValue == undefined) {
         throw new TypeError(
@@ -201,6 +207,10 @@ class STObject extends SerializedType {
 
     return accumulator
   }
+
+  getSType(): SerializedTypeID {
+    return SerializedTypeID.STI_OBJECT
+  }
 }
 
 export { STObject }

package/src/types/uint-16.ts

@@ -1,6 +1,7 @@
 import { UInt } from './uint'
 import { BinaryParser } from '../serdes/binary-parser'
 import { readUInt16BE, writeUInt16BE } from '../utils'
+import { SerializedTypeID } from './serialized-type'
 
 /**
  * Derived UInt class for serializing/deserializing 16 bit UInt
@@ -48,6 +49,10 @@ class UInt16 extends UInt {
   valueOf(): number {
     return parseInt(readUInt16BE(this.bytes, 0))
   }
+
+  getSType(): SerializedTypeID {
+    return SerializedTypeID.STI_UINT16
+  }
 }
 
 export { UInt16 }

package/src/types/uint-32.ts

@@ -1,6 +1,7 @@
 import { UInt } from './uint'
 import { BinaryParser } from '../serdes/binary-parser'
 import { readUInt32BE, writeUInt32BE } from '../utils'
+import { SerializedTypeID } from './serialized-type'
 
 /**
  * Derived UInt class for serializing/deserializing 32 bit UInt
@@ -54,6 +55,10 @@ class UInt32 extends UInt {
   valueOf(): number {
     return parseInt(readUInt32BE(this.bytes, 0), 10)
   }
+
+  getSType(): SerializedTypeID {
+    return SerializedTypeID.STI_UINT32
+  }
 }
 
 export { UInt32 }

package/src/types/uint-64.ts

@@ -3,6 +3,7 @@ import { BinaryParser } from '../serdes/binary-parser'
 import { bytesToHex, concat, hexToBytes } from '@xrplf/isomorphic/utils'
 import { readUInt32BE, writeUInt32BE } from '../utils'
 import { DEFAULT_DEFINITIONS, XrplDefinitionsBase } from '../enums'
+import { SerializedTypeID } from './serialized-type'
 
 const HEX_REGEX = /^[a-fA-F0-9]{1,16}$/
 const BASE10_REGEX = /^[0-9]{1,20}$/
@@ -51,7 +52,7 @@ class UInt64 extends UInt {
       return val
     }
 
-    let buf = new Uint8Array(UInt64.width)
+    let buf: Uint8Array = new Uint8Array(UInt64.width)
 
     if (typeof val === 'number' && Number.isInteger(val)) {
       if (val < 0) {
@@ -131,6 +132,10 @@ class UInt64 extends UInt {
   toBytes(): Uint8Array {
     return this.bytes
   }
+
+  getSType(): SerializedTypeID {
+    return SerializedTypeID.STI_UINT64
+  }
 }
 
 export { UInt64 }

package/src/types/uint-8.ts

@@ -2,6 +2,7 @@ import { UInt } from './uint'
 import { BinaryParser } from '../serdes/binary-parser'
 import { bytesToHex } from '@xrplf/isomorphic/utils'
 import { writeUInt8 } from '../utils'
+import { SerializedTypeID } from './serialized-type'
 
 /**
  * Derived UInt class for serializing/deserializing 8 bit UInt
@@ -47,6 +48,10 @@ class UInt8 extends UInt {
   valueOf(): number {
     return parseInt(bytesToHex(this.bytes), 16)
   }
+
+  getSType(): SerializedTypeID {
+    return SerializedTypeID.STI_UINT8
+  }
 }
 
 export { UInt8 }

package/src/types/vector-256.ts

@@ -1,4 +1,4 @@
-import { SerializedType } from './serialized-type'
+import { SerializedType, SerializedTypeID } from './serialized-type'
 import { BinaryParser } from '../serdes/binary-parser'
 import { Hash256 } from './hash-256'
 import { BytesList } from '../serdes/binary-serializer'
@@ -74,6 +74,10 @@ class Vector256 extends SerializedType {
     }
     return result
   }
+
+  getSType(): SerializedTypeID {
+    return SerializedTypeID.STI_VECTOR256
+  }
 }
 
 export { Vector256 }

package/src/types/xchain-bridge.ts

@@ -1,7 +1,7 @@
 import { BinaryParser } from '../serdes/binary-parser'
 
 import { AccountID } from './account-id'
-import { JsonObject, SerializedType } from './serialized-type'
+import { JsonObject, SerializedType, SerializedTypeID } from './serialized-type'
 import { Issue, IssueObject } from './issue'
 import { concat } from '@xrplf/isomorphic/utils'
 
@@ -123,6 +123,10 @@ class XChainBridge extends SerializedType {
     })
     return json as XChainBridgeObject
   }
+
+  getSType(): SerializedTypeID {
+    return SerializedTypeID.STI_XCHAIN_BRIDGE
+  }
 }
 
 export { XChainBridge, XChainBridgeObject }

package/src/utils.ts

@@ -196,7 +196,7 @@ export function compare(a: TypedArray, b: TypedArray): 1 | -1 | 0 {
     throw new Error('Cannot compare arrays of different length')
   }
 
-  for (let i = 0; i < a.length - 1; i += 1) {
+  for (let i = 0; i < a.length; i += 1) {
     if (a[i] > b[i]) return 1
     if (a[i] < b[i]) return -1
   }