Skip to content

Commit

Permalink
Merge pull request #16 from ProjectOpenSea/sip-7-context-byte
Browse files Browse the repository at this point in the history
SIP-7: Add spec about context substandard ID byte
  • Loading branch information
0age authored Aug 7, 2023
2 parents 747baaa + ef3162a commit 143d7e1
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ jobs:
use-quiet-mode: no
use-verbose-mode: yes
check-modified-files-only: yes
base-branch: main

codespell:
name: CodeSpell
Expand Down
2 changes: 2 additions & 0 deletions SIPS/sip-7.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ If the zone or contract offerer allows for active signers to interact with the z

The `context` argument will be populated based on the "substandards" specified by the zone or contract offerer; these substandards will be encoded in accordance with SIP-6 versioning with the assumption that all necessary data is to be treated as "variable" data arrays. The ordering for each encoded data segment included as part of context, supplied as part of the server API request, and returned as part of the server API response will be dictated by the order that the zone or contract offerer returns the substandard IDs.

If a substandard is being used the context MUST start with a SIP-7 byte identifying the substandard ID below. The byte SHOULD be 1-indexed, but for gas efficiency reasons, 00 MAY also be used as an alias to reference substandard ID 1. If no substandard is used there MUST be no substandard version byte or additional substandard data provided.

Initial substandards include:
| substandard ID | description | decoding scheme | substandard request data supplied to API | substandard response data returned from API |
| -------------- | --------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
Expand Down
15 changes: 15 additions & 0 deletions config/mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"ignorePatterns": [
"[`]*csl-json"
],
"replacementPatterns": [
{
"pattern": "^/",
"replacement": "/github/workspace/"
}
],
"aliveStatusCodes": [
200,
429
]
}

0 comments on commit 143d7e1

Please sign in to comment.