xrpl-ruby 0.7.0 → 0.8.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/types/uint.rb

@@ -10,6 +10,7 @@ module BinaryCodec
       OutstandingAmount
       MPTAmount
       LockedAmount
+      ConfidentialOutstandingAmount
     ].freeze
 
     # Returns the width of the Uint type in bytes.
@@ -29,22 +30,14 @@ module BinaryCodec
       return value if value.is_a?(self)
 
       if value.is_a?(String)
-        # Special handling for TransactionType and LedgerEntryType
-        if self == Uint16
-          transaction_types = Definitions.instance.instance_variable_get(:@transaction_types)
-          if transaction_types&.key?(value)
-            return new(int_to_bytes(transaction_types[value], width))
-          end
-          ledger_entry_types = Definitions.instance.instance_variable_get(:@ledger_entry_types)
-          if ledger_entry_types&.key?(value)
-            return new(int_to_bytes(ledger_entry_types[value], width))
-          end
-        elsif self == Uint8
-          transaction_results = Definitions.instance.instance_variable_get(:@transaction_results)
-          if transaction_results&.key?(value)
-            return new(int_to_bytes(transaction_results[value], width))
-          end
-        end
+        # Names for the fields that carry one: TransactionType and
+        # LedgerEntryType (UInt16), TransactionResult (UInt8) and the
+        # PermissionValue of a DelegateSet (UInt32). A name is never a valid
+        # number, so the lookup cannot capture a numeric string.
+        code = NAMED_VALUES.fetch(self, [])
+                           .filter_map { |table| Definitions.instance.public_send(table)[value] }
+                           .first
+        return new(int_to_bytes(code, width)) if code
 
         # Handle hex strings or numeric strings
         if valid_hex?(value) && value.length == self.width * 2
@@ -77,29 +70,12 @@ module BinaryCodec
     # Returns the JSON representation of the Uint.
     # @return [Integer, String] The value.
     def to_json(_definitions = nil, _field_name = nil)
-      # Special handling for TransactionType, LedgerEntryType, and TransactionResult
-      # ONLY when requested via a field name that matches.
-      if _field_name == 'TransactionType'
-        val = value_of
-        transaction_types = Definitions.instance.instance_variable_get(:@transaction_types)
-        if transaction_types
-          name = transaction_types.key(val)
-          return name if name
-        end
-      elsif _field_name == 'LedgerEntryType'
-        val = value_of
-        ledger_entry_types = Definitions.instance.instance_variable_get(:@ledger_entry_types)
-        if ledger_entry_types
-          name = ledger_entry_types.key(val)
-          return name if name
-        end
-      elsif _field_name == 'TransactionResult'
-        val = value_of
-        transaction_results = Definitions.instance.instance_variable_get(:@transaction_results)
-        if transaction_results
-          name = transaction_results.key(val)
-          return name if name
-        end
+      # The fields that carry a name render it, the way rippled does. A code
+      # without a name falls through and renders as the number.
+      table = NAMED_FIELDS[_field_name]
+      if table
+        name = Definitions.instance.public_send(table).key(value_of)
+        return name if name
       end
 
       # rippled renders the narrow unsigned integers as JSON numbers and UInt64
@@ -231,4 +207,21 @@ module BinaryCodec
     end
   end
 
+  class Uint
+    # Which name tables a width accepts on the way in ...
+    NAMED_VALUES = {
+      Uint16 => %i[transaction_types ledger_entry_types],
+      Uint8 => %i[transaction_results],
+      Uint32 => %i[delegatable_permissions]
+    }.freeze
+
+    # ... and which field renders its value by name on the way out.
+    NAMED_FIELDS = {
+      'TransactionType' => :transaction_types,
+      'LedgerEntryType' => :ledger_entry_types,
+      'TransactionResult' => :transaction_results,
+      'PermissionValue' => :delegatable_permissions
+    }.freeze
+  end
+
 end

data/lib/wallet/wallet.rb

@@ -162,6 +162,38 @@ module Wallet
       @key_pairs.verify(bytes_to_hex(signing_data), signature, @public_key)
     end
 
+    # Signs a payment channel claim: the promise that +amount+ drops of the
+    # channel's funds may be claimed. The signature goes into a
+    # PaymentChannelClaim transaction as its Signature.
+    #
+    # @param channel [String] the channel ID, 64 hex characters
+    # @param amount [String, Integer] the amount in drops
+    # @return [String] the signature as hex
+    def sign_payment_channel_claim(channel, amount)
+      data = BinaryCodec.signing_claim_data(channel: channel, amount: amount)
+      @key_pairs.sign(bytes_to_hex(data), @private_key, @algorithm)
+    end
+
+    # Verifies a payment channel claim against this wallet's public key.
+    #
+    # @param channel [String] the channel ID, 64 hex characters
+    # @param amount [String, Integer] the amount in drops
+    # @param signature [String] the signature as hex
+    # @return [Boolean] whether the claim was signed by this wallet
+    def verify_payment_channel_claim(channel, amount, signature)
+      self.class.verify_payment_channel_claim(channel, amount, signature, @public_key)
+    end
+
+    # Verifies a payment channel claim against any public key - the channel's
+    # PublicKey, as the receiving side has it.
+    #
+    # @param public_key [String] the public key as hex
+    # @return [Boolean] whether the claim was signed with that key
+    def self.verify_payment_channel_claim(channel, amount, signature, public_key)
+      data = BinaryCodec.signing_claim_data(channel: channel, amount: amount)
+      KeyPairs::KeyPairs.new.verify(bytes_to_hex(data), signature, public_key)
+    end
+
     # Derives the X-address for this wallet.
     # @param tag [Integer, false, nil] The destination tag.
     # @param test_network [Boolean] Whether the address is for a test network.