xrpl-ruby 0.0.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 601db38742606f9188b1f301ca9e6800308d7650ec4d6c7dd655db9eed6bab27
-  data.tar.gz: 188e2ff1112b079a7aed430882fe0c0599a839946dd9ed5842d6e55df964c5e8
+  metadata.gz: 6c84782686e7934255929a23850a5f514d0435ff79e47cde2739ed1e940a0235
+  data.tar.gz: b6b1c24d77a63365e8bf45f8a8b702332315057a8a7ec820ef830264e3ba446e
 SHA512:
-  metadata.gz: 4e819838c6ada42db05efebc7fec715ce22dd890911c7a40242a2945bacde3b832f9fbf4139cee2ffbc384a662a0cbda36336cf8e659eebf69820deae25797f0
-  data.tar.gz: 46f08dc1d555d518ce8b98760881e94f29871b1a32c49b6d1003a1197a0e7bd354ec09d415e2ccf4f85f343add4ccb742fdd3587dfabd0f764ed4f397cb47a9a
+  metadata.gz: 9cdee47951edf9ac0a804e8f8335aea13625f0cf61f6262f229f1c7e8e569892821a201b80916f0f274ac8ed9c2de677a77e32c5ed113bfc5102d7dca7f0cafa
+  data.tar.gz: 6c6e8309646053ab8039c7eb9bac814d08c9984f8dba4a64ae290ce349ac5e8c739b7a81e1ecf6305d93623f2ca9ce5015e1435757b6aa9a3bf6e74e2c1a6759

data/lib/address-codec/address_codec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AddressCodec
 
   class AddressCodec < XrpCodec
@@ -10,21 +11,31 @@ module AddressCodec
 
     MAX_32_BIT_UNSIGNED_INT = 4294967295
 
+    # Converts a classic address to an X-address.
+    # @param classic_address [String] The classic XRPL address to convert.
+    # @param tag [Integer, false, nil] The destination tag.
+    # @param test [Boolean] Whether the address is for a test network.
+    # @return [String] The encoded X-address.
     def classic_address_to_x_address(classic_address, tag, test)
       account_id = decode_account_id(classic_address)
       encode_x_address(account_id, tag, test)
     end
 
+    # Encodes an account ID and tag into an X-address.
+    # @param account_id [Array<Integer>] 20 bytes for the account ID.
+    # @param tag [Integer, false, nil] The destination tag.
+    # @param test [Boolean] Whether the address is for a test network.
+    # @return [String] The encoded X-address.
     def encode_x_address(account_id, tag, test)
       if account_id.length != 20
         # RIPEMD160 -> 160 Bits = 20 Bytes
         raise 'Account ID must be 20 bytes'
       end
-      if tag != false && tag > MAX_32_BIT_UNSIGNED_INT
+      if tag && tag != false && tag > MAX_32_BIT_UNSIGNED_INT
         raise 'Invalid tag'
       end
       the_tag = tag || 0
-      flag = tag == false || tag.nil? ? 0 : 1
+      flag = (tag == false || tag.nil?) ? 0 : 1
 
       bytes = concat_args(
         test ? PREFIX_BYTES[:test] : PREFIX_BYTES[:main],
@@ -45,6 +56,9 @@ module AddressCodec
       encode_checked(bytes)
     end
 
+    # Converts an X-address to a classic address.
+    # @param x_address [String] The X-address string to convert.
+    # @return [Hash] A hash containing :classic_address, :tag, and :test.
     def x_address_to_classic_address(x_address)
       decoded = decode_x_address(x_address)
       account_id = decoded[:account_id]
@@ -58,6 +72,9 @@ module AddressCodec
       }
     end
 
+    # Decodes an X-address into its underlying account ID, tag, and network type.
+    # @param x_address [String] The X-address string to decode.
+    # @return [Hash] A hash containing :account_id, :tag, and :test.
     def decode_x_address(x_address)
       decoded = decode_checked(x_address)
       test = is_uint8_array_for_test_address(decoded)
@@ -70,6 +87,9 @@ module AddressCodec
       }
     end
 
+    # Checks if a string is a valid X-address.
+    # @param x_address [String] The X-address string to check.
+    # @return [Boolean] True if the X-address is valid, false otherwise.
     def valid_x_address?(x_address)
       begin
         decode_x_address(x_address)
@@ -96,11 +116,9 @@ module AddressCodec
     def tag_from_uint8_array(bytes)
       flag = bytes[22]
       if flag >= 2
-        # Keine Unterstützung für 64-Bit-Tags zu diesem Zeitpunkt
         raise 'Unsupported X-address'
       end
       if flag == 1
-        # Little-endian zu Big-endian
         return bytes[23] + bytes[24] * 0x100 + bytes[25] * 0x10000 + bytes[26] * 0x1000000
       end
       if flag != 0

data/lib/address-codec/codec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
-require 'digest'
 
-require_relative "../core/core"
+require 'digest'
 
 module AddressCodec
   class Codec
@@ -10,11 +9,19 @@ module AddressCodec
       @codec = Core::Base58XRP.new
     end
 
+    # Encodes a byte array into a base58 string with a version prefix and checksum.
+    # @param bytes [Array<Integer>] The byte array to encode.
+    # @param opts [Hash] Options for encoding (e.g., :versions, :expected_length).
+    # @return [String] The encoded base58 string.
     def encode(bytes, opts)
       versions = opts[:versions]
       encode_versioned(bytes, versions, opts[:expected_length])
     end
 
+    # Decodes a base58 string and verifies its version and checksum.
+    # @param base58string [String] The base58 string to decode.
+    # @param opts [Hash] Options for decoding (e.g., :versions, :version_types, :expected_length).
+    # @return [Hash] The decoded data including version, bytes, and type.
     def decode(base58string, opts)
       versions = opts[:versions]
       types = opts[:version_types]
@@ -44,11 +51,17 @@ module AddressCodec
       raise 'version_invalid: version bytes do not match any of the provided version(s)'
     end
 
+    # Encodes a byte array into a base58 string with a checksum.
+    # @param bytes [Array<Integer>] The byte array to encode.
+    # @return [String] The encoded base58 string.
     def encode_checked(bytes)
       check = sha256(sha256(bytes))[0, 4]
       encode_raw(bytes + check)
     end
 
+    # Decodes a base58 string and verifies its checksum.
+    # @param base58string [String] The base58 string to decode.
+    # @return [Array<Integer>] The decoded byte array (without checksum).
     def decode_checked(base58string)
       bytes = decode_raw(base58string)
 

data/lib/address-codec/xrp_codec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../core/core"
-
 module AddressCodec
 
   class XrpCodec < Codec
@@ -13,6 +11,10 @@ module AddressCodec
     NODE_PUBLIC = 0x1c        # 28; Validation public key (33 bytes)
     ED25519_SEED = [0x01, 0xe1, 0x4b].freeze # [1, 225, 75]
 
+    # Encodes entropy into a seed string.
+    # @param entropy [Array<Integer>] 16 bytes of entropy.
+    # @param type [String, nil] The seed type ('ed25519' or 'secp256k1').
+    # @return [String] The encoded seed string.
     def encode_seed(entropy, type = nil)
       unless check_byte_length(entropy, 16)
         raise 'entropy must have length 16'
@@ -27,6 +29,10 @@ module AddressCodec
       encode(entropy, opts)
     end
 
+    # Decodes a seed string into its underlying bytes and type.
+    # @param seed [String] The seed string to decode.
+    # @param opts [Hash] Options for decoding (e.g., :versions, :version_types, :expected_length).
+    # @return [Hash] The decoded data including version, bytes, and type.
     def decode_seed(seed, opts = {
           version_types: ['ed25519', 'secp256k1'],
           versions: [ED25519_SEED, FAMILY_SEED],
@@ -35,36 +41,57 @@ module AddressCodec
       decode(seed, opts)
     end
 
+    # Encodes a byte array into an account ID string.
+    # @param bytes [Array<Integer>] 20 bytes for the account ID.
+    # @return [String] The encoded account ID string.
     def encode_account_id(bytes)
       opts = { versions: [ACCOUNT_ID], expected_length: 20 }
       encode(bytes, opts)
     end
 
+    # Decodes an account ID string into its underlying bytes.
+    # @param account_id [String] The account ID string to decode.
+    # @return [Array<Integer>] The decoded bytes.
     def decode_account_id(account_id)
       opts = { versions: [ACCOUNT_ID], expected_length: 20 }
       decode(account_id, opts)[:bytes]
     end
 
+    # Decodes a node public key string into its underlying bytes.
+    # @param base58string [String] The node public key string to decode.
+    # @return [Array<Integer>] The decoded bytes.
     def decode_node_public(base58string)
       opts = { versions: [NODE_PUBLIC], expected_length: 33 }
       decode(base58string, opts)[:bytes]
     end
 
+    # Encodes a byte array into a node public key string.
+    # @param bytes [Array<Integer>] 33 bytes for the node public key.
+    # @return [String] The encoded node public key string.
     def encode_node_public(bytes)
       opts = { versions: [NODE_PUBLIC], expected_length: 33 }
       encode(bytes, opts)
     end
 
+    # Encodes a byte array into an account public key string.
+    # @param bytes [Array<Integer>] 33 bytes for the account public key.
+    # @return [String] The encoded account public key string.
     def encode_account_public(bytes)
       opts = { versions: [ACCOUNT_PUBLIC_KEY], expected_length: 33 }
       encode(bytes, opts)
     end
 
+    # Decodes an account public key string into its underlying bytes.
+    # @param base58string [String] The account public key string to decode.
+    # @return [Array<Integer>] The decoded bytes.
     def decode_account_public(base58string)
       opts = { versions: [ACCOUNT_PUBLIC_KEY], expected_length: 33 }
       decode(base58string, opts)[:bytes]
     end
 
+    # Checks if a string is a valid classic XRPL address.
+    # @param address [String] The address string to check.
+    # @return [Boolean] True if the address is valid, false otherwise.
     def valid_classic_address?(address)
       begin
         decode_account_id(address)

data/lib/binary-codec/binary_codec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module BinaryCodec
+  # Hash prefixes for serialization.
+  HASH_PREFIX = {
+    transaction_sig: 0x53545800, # 'STX\0'
+    transaction_multi_sig: 0x534D5400, # 'SMT\0'
+    validation: 0x56414C00, # 'VAL\0'
+    proposal: 0x50525000 # 'PRP\0'
+  }.freeze
+
+  # from here: https://github.com/XRPLF/xrpl.js/blob/main/packages/ripple-binary-codec/src/binary.ts
+  class << self
+    # Creates a BinaryParser for the given bytes.
+    # @param bytes [String, Array<Integer>] The bytes to parse (hex string or byte array).
+    # @param definitions [Definitions, nil] Optional definitions.
+    # @return [BinaryParser] The created parser.
+    def make_parser(bytes, definitions = nil)
+      BinaryParser.new(bytes.is_a?(String) ? bytes : bytes_to_hex(bytes))
+    end
+
+    # Converts a hex string to its JSON representation.
+    # @param hex [String] The hex string to convert.
+    # @return [Hash] The decoded JSON object.
+    def binary_to_json(hex)
+      parser = make_parser(hex)
+      st_object = SerializedType.get_type_by_name('STObject')
+      JSON.parse(st_object.from_parser(parser).to_json)
+    end
+
+    # Converts a JSON object to its binary representation.
+    # @param json [Hash] The JSON object to convert.
+    # @return [String] The serialized hex string.
+    def json_to_binary(json)
+      st_object = SerializedType.get_type_by_name('STObject')
+      st_object.from(json).to_hex
+    end
+
+    # Generates signing data for a transaction.
+    # @param transaction [Hash] The transaction to serialize.
+    # @param prefix [Integer] The prefix to add to the serialized data.
+    # @param opts [Hash] Optional settings (e.g., :definitions, :signing_fields_only).
+    # @return [Array<Integer>] The serialized signing data.
+    def signing_data(transaction, prefix = HASH_PREFIX[:transaction_sig], opts = {})
+      # 1. Start with the prefix bytes
+      prefix_bytes = int_to_bytes(prefix, 4)
+
+      # 2. Serialize the object, only including signing fields
+      st_object_class = SerializedType.get_type_by_name('STObject')
+
+      filter = if opts[:signing_fields_only]
+                 lambda { |field_name| Definitions.instance.get_field_instance(field_name).is_signing_field }
+               else
+                 nil
+               end
+
+      serialized_bytes = st_object_class.from(transaction, filter).to_bytes
+
+      prefix_bytes + serialized_bytes
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module BinaryCodec
+  TYPE_WIDTH = 2
+  LEDGER_ENTRY_WIDTH = 2
+  TRANSACTION_TYPE_WIDTH = 2
+  TRANSACTION_RESULT_WIDTH = 1
+end