-
Notifications
You must be signed in to change notification settings - Fork 25
Refactor Protocol Handling and Update Dependencies #136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,4 +1,4 @@ | ||||||
| # Strict extractor for the ERC-721 Ethscriptions collection protocol with canonical JSON validation | ||||||
| # Strict parser for the ERC-721 Ethscriptions collection protocol with canonical JSON validation | ||||||
| class Erc721EthscriptionsCollectionParser | ||||||
| # Default return for invalid input | ||||||
| DEFAULT_PARAMS = [''.b, ''.b, ''.b].freeze | ||||||
|
|
@@ -9,8 +9,7 @@ class Erc721EthscriptionsCollectionParser | |||||
| # Operation schemas defining exact structure and ABI encoding | ||||||
| OPERATION_SCHEMAS = { | ||||||
| 'create_collection' => { | ||||||
| keys: %w[name symbol max_supply description logo_image_uri banner_image_uri background_color website_link twitter_link discord_link], | ||||||
| # Contract expects an extra bytes32 merkleRoot at the end. We append zero when omitted. | ||||||
| keys: %w[name symbol max_supply description logo_image_uri banner_image_uri background_color website_link twitter_link discord_link merkle_root], | ||||||
| abi_type: '(string,string,uint256,string,string,string,string,string,string,string,bytes32)', | ||||||
| validators: { | ||||||
| 'name' => :string, | ||||||
|
|
@@ -22,13 +21,14 @@ class Erc721EthscriptionsCollectionParser | |||||
| 'background_color' => :string, | ||||||
| 'website_link' => :string, | ||||||
| 'twitter_link' => :string, | ||||||
| 'discord_link' => :string | ||||||
| 'discord_link' => :string, | ||||||
| 'merkle_root' => :bytes32 | ||||||
| } | ||||||
| }, | ||||||
| # New combined create op name used by the contract; keep legacy alias below | ||||||
| 'create_collection_and_add_self' => { | ||||||
| keys: %w[metadata item], | ||||||
| # ((CollectionParams),(ItemData)) - ItemData without ethscription_id (item refers to itself) | ||||||
| # ((CollectionParams),(ItemData)) - ItemData mirrors ItemData struct (no ethscriptionId field) | ||||||
| abi_type: '((string,string,uint256,string,string,string,string,string,string,string,bytes32),(uint256,string,string,string,(string,string)[],bytes32[]))', | ||||||
| validators: { | ||||||
| 'metadata' => :collection_metadata, | ||||||
|
|
@@ -62,8 +62,7 @@ class Erc721EthscriptionsCollectionParser | |||||
| } | ||||||
| }, | ||||||
| 'edit_collection' => { | ||||||
| keys: %w[collection_id description logo_image_uri banner_image_uri background_color website_link twitter_link discord_link], | ||||||
| # Contract includes a bytes32 merkleRoot; append zero when omitted | ||||||
| keys: %w[collection_id description logo_image_uri banner_image_uri background_color website_link twitter_link discord_link merkle_root], | ||||||
| abi_type: '(bytes32,string,string,string,string,string,string,string,bytes32)', | ||||||
| validators: { | ||||||
| 'collection_id' => :bytes32, | ||||||
|
|
@@ -73,7 +72,8 @@ class Erc721EthscriptionsCollectionParser | |||||
| 'background_color' => :string, | ||||||
| 'website_link' => :string, | ||||||
| 'twitter_link' => :string, | ||||||
| 'discord_link' => :string | ||||||
| 'discord_link' => :string, | ||||||
| 'merkle_root' => :bytes32 | ||||||
| } | ||||||
| }, | ||||||
| 'edit_collection_item' => { | ||||||
|
|
@@ -97,8 +97,10 @@ class Erc721EthscriptionsCollectionParser | |||||
| } | ||||||
| }.freeze | ||||||
|
|
||||||
| # Item keys for validation (ethscription_id removed - item refers to itself) | ||||||
| # merkle_proof is always required (can be empty array) | ||||||
| ZERO_BYTES32 = ["".ljust(64, '0')].pack('H*').freeze | ||||||
| ZERO_HEX_BYTES32 = '0x' + '0' * 64 | ||||||
|
|
||||||
| # Item keys for validation (merkle_proof always present, can be empty array) | ||||||
| ITEM_KEYS = %w[item_index name background_color description attributes merkle_proof].freeze | ||||||
|
|
||||||
| # Attribute keys for NFT metadata | ||||||
|
|
@@ -114,56 +116,50 @@ def self.extract(content_uri, ethscription_id: nil) | |||||
| end | ||||||
|
|
||||||
| def extract(content_uri, ethscription_id: nil) | ||||||
| # Import-aware path takes precedence if id is provided | ||||||
| if ethscription_id | ||||||
| if (encoded = build_import_encoded_params(ethscription_id.to_hex)) | ||||||
| return encoded | ||||||
| normalized_id = normalize_id(ethscription_id) | ||||||
| if normalized_id && (preplanned = build_import_encoded_params(normalized_id)) | ||||||
| return preplanned | ||||||
| end | ||||||
| end | ||||||
|
|
||||||
| return DEFAULT_PARAMS unless valid_data_uri?(content_uri) | ||||||
|
|
||||||
| begin | ||||||
| # Parse JSON (preserves key order) | ||||||
| # Use DataUri to correctly handle optional parameters like ESIP6 | ||||||
| json_str = if content_uri.start_with?("data:,{") | ||||||
| content_uri.sub(/\Adata:,/, '') | ||||||
| else | ||||||
| DataUri.new(content_uri).decoded_data | ||||||
| end | ||||||
|
|
||||||
| json_str = DataUri.new(content_uri).decoded_data | ||||||
|
|
||||||
| # TODO: make sure this is safe | ||||||
| data = JSON.parse(json_str) | ||||||
|
|
||||||
| # Must be an object | ||||||
| return DEFAULT_PARAMS unless data.is_a?(Hash) | ||||||
|
|
||||||
| # Check protocol | ||||||
| return DEFAULT_PARAMS unless data['p'] == 'erc-721-ethscriptions-collection' | ||||||
|
|
||||||
| # Get operation | ||||||
| operation = data['op'] | ||||||
| return DEFAULT_PARAMS unless OPERATION_SCHEMAS.key?(operation) | ||||||
|
|
||||||
| # Validate exact key order (including p and op at start) | ||||||
| schema = OPERATION_SCHEMAS[operation] | ||||||
| expected_keys = ['p', 'op'] + schema[:keys] | ||||||
| return DEFAULT_PARAMS unless data.keys == expected_keys | ||||||
|
|
||||||
| # Remove protocol fields for encoding | ||||||
| encoding_data = data.reject { |k, _| k == 'p' || k == 'op' } | ||||||
|
|
||||||
| # Validate field types and encode | ||||||
| encoded_data = encode_operation(operation, encoding_data, schema) | ||||||
|
|
||||||
| ['erc-721-ethscriptions-collection'.b, operation.b, encoded_data.b] | ||||||
|
|
||||||
| rescue JSON::ParserError, ValidationError => e | ||||||
| Rails.logger.debug "Collections extraction failed: #{e.message}" if defined?(Rails) | ||||||
| DEFAULT_PARAMS | ||||||
| end | ||||||
| end | ||||||
|
|
||||||
| def normalize_id(value) | ||||||
| case value | ||||||
| when ByteString | ||||||
| value.to_hex.downcase | ||||||
| when String | ||||||
| value.downcase | ||||||
| else | ||||||
| nil | ||||||
| end | ||||||
| end | ||||||
|
|
||||||
| # -------------------- Import fallback -------------------- | ||||||
|
|
||||||
| # Returns [protocol, operation, encoded_data] or nil | ||||||
|
|
@@ -185,13 +181,16 @@ def build_import_encoded_params(id) | |||||
| item_index = data[:zero_index_by_id][id] || 0 | ||||||
|
|
||||||
| if id == leader_id | ||||||
| metadata = data[:collections_by_name][coll_name] | ||||||
| return nil unless metadata | ||||||
| raw_metadata = data[:collections_by_name][coll_name] | ||||||
| return nil unless raw_metadata | ||||||
| metadata = raw_metadata.merge( | ||||||
| 'merkle_root' => raw_metadata['merkle_root'] || ZERO_HEX_BYTES32 | ||||||
| ) | ||||||
| operation = 'create_collection_and_add_self' | ||||||
| schema = OPERATION_SCHEMAS[operation] | ||||||
| encoding_data = { | ||||||
| 'metadata' => build_metadata_object(metadata), | ||||||
| 'item' => build_item_object(item: item, item_id: id, item_index: item_index) | ||||||
| 'item' => build_item_object(item: item, item_index: item_index) | ||||||
| } | ||||||
| encoded_data = encode_operation(operation, encoding_data, schema) | ||||||
| ['erc-721-ethscriptions-collection'.b, operation.b, encoded_data.b] | ||||||
|
|
@@ -200,7 +199,7 @@ def build_import_encoded_params(id) | |||||
| schema = OPERATION_SCHEMAS[operation] | ||||||
| encoding_data = { | ||||||
| 'collection_id' => to_bytes32_hex(leader_id), | ||||||
| 'item' => build_item_object(item: item, item_id: id, item_index: item_index) | ||||||
| 'item' => build_item_object(item: item, item_index: item_index) | ||||||
| } | ||||||
| encoded_data = encode_operation(operation, encoding_data, schema) | ||||||
| ['erc-721-ethscriptions-collection'.b, operation.b, encoded_data.b] | ||||||
|
|
@@ -269,7 +268,7 @@ def build_metadata_object(meta) | |||||
| twitter_link = safe_string(meta['twitter_link']) | ||||||
| discord_link = safe_string(meta['discord_link']) | ||||||
|
|
||||||
| OrderedHash[ | ||||||
| result = OrderedHash[ | ||||||
| 'name', name, | ||||||
| 'symbol', symbol, | ||||||
| 'max_supply', max_supply, | ||||||
|
|
@@ -281,20 +280,25 @@ def build_metadata_object(meta) | |||||
| 'twitter_link', twitter_link, | ||||||
| 'discord_link', discord_link | ||||||
| ] | ||||||
| merkle_root = meta.fetch('merkle_root') | ||||||
|
||||||
| merkle_root = meta.fetch('merkle_root') | |
| merkle_root = meta.fetch('merkle_root', ZERO_HEX_BYTES32) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment on line 31 states "ItemData mirrors ItemData struct (no ethscriptionId field)" which is redundant - it says ItemData mirrors ItemData. This should be clarified to explain what the ItemData struct mirrors or what distinguishes it from other item representations.
Consider revising to something like: "ItemData struct contains item fields without the ethscriptionId (self-referencing)"