xrpl-ruby 0.7.0 → 0.9.0

data/lib/binary-codec/enums/definitions.json

@@ -148,46 +148,6 @@
         "type": "UInt16"
       }
     ],
-    [
-      "HookStateChangeCount",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 17,
-        "type": "UInt16"
-      }
-    ],
-    [
-      "HookEmitCount",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 18,
-        "type": "UInt16"
-      }
-    ],
-    [
-      "HookExecutionIndex",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 19,
-        "type": "UInt16"
-      }
-    ],
-    [
-      "HookApiVersion",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 20,
-        "type": "UInt16"
-      }
-    ],
     [
       "LedgerFixType",
       {
@@ -648,26 +608,6 @@
         "type": "UInt32"
       }
     ],
-    [
-      "HookStateCount",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 45,
-        "type": "UInt32"
-      }
-    ],
-    [
-      "EmitGeneration",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 46,
-        "type": "UInt32"
-      }
-    ],
     [
       "VoteWeight",
       {
@@ -928,6 +868,26 @@
         "type": "UInt32"
       }
     ],
+    [
+      "SubscriptionDate",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 75,
+        "type": "UInt32"
+      }
+    ],
+    [
+      "RedemptionDate",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 76,
+        "type": "UInt32"
+      }
+    ],
     [
       "IndexNext",
       {
@@ -1058,36 +1018,6 @@
         "type": "UInt64"
       }
     ],
-    [
-      "HookOn",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 16,
-        "type": "UInt64"
-      }
-    ],
-    [
-      "HookInstructionCount",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 17,
-        "type": "UInt64"
-      }
-    ],
-    [
-      "HookReturnCode",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 18,
-        "type": "UInt64"
-      }
-    ],
     [
       "ReferenceCount",
       {
@@ -1518,46 +1448,6 @@
         "type": "Hash256"
       }
     ],
-    [
-      "HookStateKey",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 30,
-        "type": "Hash256"
-      }
-    ],
-    [
-      "HookHash",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 31,
-        "type": "Hash256"
-      }
-    ],
-    [
-      "HookNamespace",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 32,
-        "type": "Hash256"
-      }
-    ],
-    [
-      "HookSetTxnID",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 33,
-        "type": "Hash256"
-      }
-    ],
     [
       "DomainID",
       {
@@ -2158,46 +2048,6 @@
         "type": "Blob"
       }
     ],
-    [
-      "HookStateData",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": true,
-        "nth": 22,
-        "type": "Blob"
-      }
-    ],
-    [
-      "HookReturnString",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": true,
-        "nth": 23,
-        "type": "Blob"
-      }
-    ],
-    [
-      "HookParameterName",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": true,
-        "nth": 24,
-        "type": "Blob"
-      }
-    ],
-    [
-      "HookParameterValue",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": true,
-        "nth": 25,
-        "type": "Blob"
-      }
-    ],
     [
       "DIDDocument",
       {
@@ -2518,16 +2368,6 @@
         "type": "AccountID"
       }
     ],
-    [
-      "HookAccount",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": true,
-        "nth": 16,
-        "type": "AccountID"
-      }
-    ],
     [
       "OtherChainSource",
       {
@@ -2978,16 +2818,6 @@
         "type": "STObject"
       }
     ],
-    [
-      "Hook",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 14,
-        "type": "STObject"
-      }
-    ],
     [
       "Permission",
       {
@@ -3028,56 +2858,6 @@
         "type": "STObject"
       }
     ],
-    [
-      "EmittedTxn",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 20,
-        "type": "STObject"
-      }
-    ],
-    [
-      "HookExecution",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 21,
-        "type": "STObject"
-      }
-    ],
-    [
-      "HookDefinition",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 22,
-        "type": "STObject"
-      }
-    ],
-    [
-      "HookParameter",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 23,
-        "type": "STObject"
-      }
-    ],
-    [
-      "HookGrant",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 24,
-        "type": "STObject"
-      }
-    ],
     [
       "VoteEntry",
       {
@@ -3298,16 +3078,6 @@
         "type": "STArray"
       }
     ],
-    [
-      "Hooks",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 11,
-        "type": "STArray"
-      }
-    ],
     [
       "VoteSlots",
       {
@@ -3348,36 +3118,6 @@
         "type": "STArray"
       }
     ],
-    [
-      "HookExecutions",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 18,
-        "type": "STArray"
-      }
-    ],
-    [
-      "HookParameters",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 19,
-        "type": "STArray"
-      }
-    ],
-    [
-      "HookGrants",
-      {
-        "isSerialized": true,
-        "isSigningField": true,
-        "isVLEncoded": false,
-        "nth": 20,
-        "type": "STArray"
-      }
-    ],
     [
       "XChainClaimAttestations",
       {
@@ -3529,32 +3269,32 @@
       }
     ],
     [
-      "TickSize",
+      "LEVersion",
       {
         "isSerialized": true,
         "isSigningField": true,
         "isVLEncoded": false,
-        "nth": 16,
+        "nth": 6,
         "type": "UInt8"
       }
     ],
     [
-      "UNLModifyDisabling",
+      "TickSize",
       {
         "isSerialized": true,
         "isSigningField": true,
         "isVLEncoded": false,
-        "nth": 17,
+        "nth": 16,
         "type": "UInt8"
       }
     ],
     [
-      "HookResult",
+      "UNLModifyDisabling",
       {
         "isSerialized": true,
         "isSigningField": true,
         "isVLEncoded": false,
-        "nth": 18,
+        "nth": 17,
         "type": "UInt8"
       }
     ],
@@ -3578,6 +3318,26 @@
         "type": "UInt8"
       }
     ],
+    [
+      "ContractResult",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 21,
+        "type": "UInt8"
+      }
+    ],
+    [
+      "VaultKind",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 22,
+        "type": "UInt8"
+      }
+    ],
     [
       "TakerPaysCurrency",
       {
@@ -5239,6 +4999,22 @@
       {
         "name": "Scale",
         "optionality": 2
+      },
+      {
+        "name": "LEVersion",
+        "optionality": 2
+      },
+      {
+        "name": "VaultKind",
+        "optionality": 2
+      },
+      {
+        "name": "SubscriptionDate",
+        "optionality": 1
+      },
+      {
+        "name": "RedemptionDate",
+        "optionality": 1
       }
     ],
     "XChainOwnedClaimID": [
@@ -6090,6 +5866,10 @@
       {
         "name": "DestinationTag",
         "optionality": 1
+      },
+      {
+        "name": "CredentialIDs",
+        "optionality": 1
       }
     ],
     "LoanBrokerDelete": [
@@ -6730,6 +6510,18 @@
       {
         "name": "Scale",
         "optionality": 1
+      },
+      {
+        "name": "VaultKind",
+        "optionality": 1
+      },
+      {
+        "name": "SubscriptionDate",
+        "optionality": 1
+      },
+      {
+        "name": "RedemptionDate",
+        "optionality": 1
       }
     ],
     "VaultDelete": [
@@ -6786,6 +6578,10 @@
       {
         "name": "DestinationTag",
         "optionality": 1
+      },
+      {
+        "name": "CredentialIDs",
+        "optionality": 1
       }
     ],
     "XChainAccountCreateCommit": [
@@ -7374,5 +7170,5 @@
     "Vector256": 19,
     "XChainBridge": 25
   },
-  "hash": "F3DCCAD774156538A6AB3E6003A41273D5AE394A90989204838AE52A006F245B"
-}
+  "hash": "1EA05B0FC11101F7C500BD0DAC794A8BC746A7FBA6250B75489603EB820E0FF5"
+}

data/lib/binary-codec/enums/definitions.rb

@@ -8,6 +8,26 @@ module BinaryCodec
 
     @@instance = nil
 
+    # The permissions a DelegateSet can grant that are narrower than a whole
+    # transaction type. rippled numbers them from 65537 upwards, above the
+    # range the transaction types occupy. The table is not part of
+    # definitions.json - xrpl.js carries it in code as well
+    # (XrplDefinitionsBase#granularPermissions) - so it lives here.
+    GRANULAR_PERMISSIONS = {
+      'TrustlineAuthorize' => 65_537,
+      'TrustlineFreeze' => 65_538,
+      'TrustlineUnfreeze' => 65_539,
+      'AccountDomainSet' => 65_540,
+      'AccountEmailHashSet' => 65_541,
+      'AccountMessageKeySet' => 65_542,
+      'AccountTransferRateSet' => 65_543,
+      'AccountTickSizeSet' => 65_544,
+      'PaymentMint' => 65_545,
+      'PaymentBurn' => 65_546,
+      'MPTokenIssuanceLock' => 65_547,
+      'MPTokenIssuanceUnlock' => 65_548
+    }.freeze
+
      def initialize
       file_path = File.join(__dir__, 'definitions.json') #
       contents = File.read(file_path)
@@ -18,6 +38,15 @@ module BinaryCodec
       @transaction_results = @definitions['TRANSACTION_RESULTS']
       @transaction_types = @definitions['TRANSACTION_TYPES']
 
+      # PermissionValue names a delegatable permission. A whole transaction
+      # type is its type code plus one, so that Payment (type 0) is not
+      # confused with "no permission"; the granular permissions follow above.
+      @delegatable_permissions = @transaction_types
+                                 .reject { |_, code| code.negative? }
+                                 .transform_values { |code| code + 1 }
+                                 .merge(GRANULAR_PERMISSIONS)
+                                 .freeze
+
       @field_info_map = {}
       @field_id_name_map = {}
       @field_header_map = {}
@@ -55,6 +84,11 @@ module BinaryCodec
     attr_reader :definitions
     alias raw definitions
 
+    # Name -> code tables, for the types that render as names in JSON.
+    # @return [Hash{String => Integer}]
+    attr_reader :transaction_types, :ledger_entry_types, :transaction_results,
+                :delegatable_permissions
+
     # Returns the singleton instance of the Definitions class.
     # @return [Definitions] The singleton instance.
     def self.instance
@@ -77,9 +111,12 @@ module BinaryCodec
 
     # Returns a FieldInstance for a given field name.
     # @param field_name [String] The name of the field.
-    # @return [FieldInstance] The field instance.
+    # @return [FieldInstance, nil] The field instance, nil for a name the
+    #   definitions do not know
     def get_field_instance(field_name)
        field_info = @field_info_map[field_name]
+       return nil if field_info.nil?
+
        field_header = get_field_header_from_name(field_name)
 
        FieldInstance.new(

data/lib/binary-codec/serdes/binary_serializer.rb

@@ -47,7 +47,13 @@ module BinaryCodec
       end
 
       field_header = field.header
-      associated_value = field.associated_type.from(value)
+      # A UInt reads a String by its field: a UInt64 is hex, or decimal in a
+      # base-10 field.
+      associated_value = if field.associated_type <= Uint
+                           field.associated_type.from(value, field.name)
+                         else
+                           field.associated_type.from(value)
+                         end
 
       @sink.put(field_header.to_bytes)
 

data/lib/binary-codec/types/st_array.rb

@@ -3,6 +3,7 @@
 module BinaryCodec
   class STArray < SerializedType
     ARRAY_END_MARKER = 0xF1
+    OBJECT_END_MARKER = 0xE1
 
     def initialize(byte_buf = nil)
       super(byte_buf || [])
@@ -35,7 +36,11 @@ module BinaryCodec
             
             obj = STObject.from(field_value, nil, definitions)
             bytes.concat(obj.to_bytes)
-            bytes.concat([0xE1]) unless bytes.last == 0xE1
+            # Every element is closed by its own ObjectEndMarker. Testing the
+            # last byte for 0xE1 instead dropped it whenever the element
+            # happened to end in that byte - an AccountID, a Memo, or a nested
+            # object, whose own marker is 0xE1 too.
+            bytes.concat([OBJECT_END_MARKER])
           else
             raise StandardError, "STArray item must be a Hash, got #{item.class}"
           end
@@ -70,7 +75,7 @@ module BinaryCodec
         # Reconstruct the serialized item: [FieldHeader][STObject][ObjectEndMarker]
         bytes.concat(field_header.to_bytes)
         bytes.concat(obj.to_bytes)
-        bytes.concat([0xE1]) unless bytes.last == 0xE1
+        bytes.concat([OBJECT_END_MARKER])
       end
 
       # The ArrayEndMarker has to go back in. Without it the reconstructed

data/lib/binary-codec/types/st_object.rb

@@ -100,20 +100,16 @@ module BinaryCodec
       list = BytesList.new
       bytes = BinarySerializer.new(list)
 
+      # Malformed input raises rather than ending the object early: a silent
+      # break here returned a truncated object that nothing could trace.
       until parser.end?
-        begin
-          field = parser.read_field
-          break if field.name == OBJECT_END_MARKER
+        field = parser.read_field
+        break if field.name == OBJECT_END_MARKER
 
-          associated_value = parser.read_field_value(field)
+        associated_value = parser.read_field_value(field)
 
-          bytes.write_field_and_value(field, associated_value)
-          bytes.put(OBJECT_END_MARKER_BYTE) if field.type == ST_OBJECT
-        rescue => e
-          # If we fail to read a field (e.g. unknown header), we might have hit 
-          # the end of the object without an end marker, or just malformed data.
-          break
-        end
+        # Closes a nested STObject with its ObjectEndMarker itself.
+        bytes.write_field_and_value(field, associated_value)
       end
 
       STObject.new(list.to_bytes)