Class: BinaryCodec::Definitions

Inherits:
Object
  • Object
show all
Defined in:
lib/binary-codec/enums/definitions.rb

Constant Summary collapse

GRANULAR_PERMISSIONS =

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.

{
  '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
@@instance = 
nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Definitions

Returns a new instance of Definitions.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/binary-codec/enums/definitions.rb', line 31

def initialize
 file_path = File.join(__dir__, 'definitions.json') #
 contents = File.read(file_path)
 @definitions = JSON.parse(contents)

 @type_ordinals = @definitions['TYPES']
 @ledger_entry_types = @definitions['LEDGER_ENTRY_TYPES']
 @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 = {}

 @definitions['FIELDS'].each do |field|
   field_name = field[0]
   field_info = FieldInfo.new(
     nth: field[1]['nth'],
     is_vl_encoded: field[1]['isVLEncoded'],
     is_serialized: field[1]['isSerialized'],
     is_signing_field: field[1]['isSigningField'],
     type: field[1]['type']
   )
   type_ordinal = @type_ordinals[field_info.type]
   field_header = FieldHeader.new(type: type_ordinal, nth: field_info.nth)

   @field_info_map[field_name] = field_info
   key = (type_ordinal << 16) | field_info.nth
   @field_id_name_map[key] = field_name
   @field_header_map[field_name] = field_header
 end

    rescue Errno::ENOENT
 raise "Error: The file '#{file_path}' was not found. Please ensure the file exists."
    rescue JSON::ParserError => e
 raise "Error: The file '#{file_path}' contains invalid JSON: #{e.message}"

end

Instance Attribute Details

#definitions ⇒ Hash (readonly) Also known as: raw

The parsed definitions.json, for the sections this class does not index itself - TRANSACTION_FORMATS and TRANSACTION_FLAGS, which the transaction models are built from.

Returns:

  • (Hash) —

    the raw document



84
85
86
 
# File 'lib/binary-codec/enums/definitions.rb', line 84

def definitions
  @definitions
end

#delegatable_permissions ⇒ Hash{String => Integer} (readonly)

Name -> code tables, for the types that render as names in JSON.

Returns:

  • (Hash{String => Integer}) 


89
90
91
 
# File 'lib/binary-codec/enums/definitions.rb', line 89

def delegatable_permissions
  @delegatable_permissions
end

#ledger_entry_types ⇒ Hash{String => Integer} (readonly)

Name -> code tables, for the types that render as names in JSON.

Returns:

  • (Hash{String => Integer}) 


89
90
91
 
# File 'lib/binary-codec/enums/definitions.rb', line 89

def ledger_entry_types
  @ledger_entry_types
end

#transaction_results ⇒ Hash{String => Integer} (readonly)

Name -> code tables, for the types that render as names in JSON.

Returns:

  • (Hash{String => Integer}) 


89
90
91
 
# File 'lib/binary-codec/enums/definitions.rb', line 89

def transaction_results
  @transaction_results
end

#transaction_types ⇒ Hash{String => Integer} (readonly)

Name -> code tables, for the types that render as names in JSON.

Returns:

  • (Hash{String => Integer}) 


89
90
91
 
# File 'lib/binary-codec/enums/definitions.rb', line 89

def transaction_types
  @transaction_types
end

Class Method Details

.instance ⇒ Definitions

Returns the singleton instance of the Definitions class.

Returns:



94
95
96
 
# File 'lib/binary-codec/enums/definitions.rb', line 94

def self.instance
  @@instance ||= new
end

Instance Method Details

#get_field_header_from_name(field_name) ⇒ FieldHeader

Returns the field header for a given field name.

Parameters:

  • field_name (String) —

    The name of the field.

Returns:



101
102
103
 
# File 'lib/binary-codec/enums/definitions.rb', line 101

def get_field_header_from_name(field_name)
  @field_header_map[field_name]
end

#get_field_instance(field_name) ⇒ FieldInstance?

Returns a FieldInstance for a given field name.

Parameters:

  • field_name (String) —

    The name of the field.

Returns:

  • (FieldInstance, nil) —

    The field instance, nil for a name the definitions do not know



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/binary-codec/enums/definitions.rb', line 116

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(
    nth: field_info.nth,
    is_variable_length_encoded: field_info.is_vl_encoded,
    is_serialized: field_info.is_serialized,
    is_signing_field: field_info.is_signing_field,
    type: field_info.type,
    ordinal: (@type_ordinals[field_info.type] << 16) | field_info.nth,
    name: field_name,
    header: field_header,
    associated_type: SerializedType.get_type_by_name(field_info.type)
  )
end

#get_field_name_from_header(field_header) ⇒ String

Returns the field name for a given field header.

Parameters:

Returns:

  • (String) —

    The name of the field.



108
109
110
 
# File 'lib/binary-codec/enums/definitions.rb', line 108

def get_field_name_from_header(field_header)
   @field_id_name_map[(field_header.type << 16) | field_header.nth]
end