From 69a608a8d47e486d517d447bf487674124fd4aaa Mon Sep 17 00:00:00 2001 From: Ryan Ghods Date: Mon, 7 Aug 2023 13:17:20 -0400 Subject: [PATCH 1/5] SIP-7: Add spec about context substandard ID byte --- SIPS/sip-7.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/SIPS/sip-7.md b/SIPS/sip-7.md index 235c442..2813605 100644 --- a/SIPS/sip-7.md +++ b/SIPS/sip-7.md @@ -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 version byte or extra data provided. + Initial substandards include: | substandard ID | description | decoding scheme | substandard request data supplied to API | substandard response data returned from API | | -------------- | --------------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | From 1dea1ce145ca1a3dbb89943d6602a8d0c37efc47 Mon Sep 17 00:00:00 2001 From: Ryan Ghods Date: Mon, 7 Aug 2023 13:30:16 -0400 Subject: [PATCH 2/5] add config/mlc_config.json --- config/mlc_config.json | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 config/mlc_config.json diff --git a/config/mlc_config.json b/config/mlc_config.json new file mode 100644 index 0000000..026f3cb --- /dev/null +++ b/config/mlc_config.json @@ -0,0 +1,15 @@ +{ + "ignorePatterns": [ + "[`]*csl-json" + ], + "replacementPatterns": [ + { + "pattern": "^/", + "replacement": "/github/workspace/" + } + ], + "aliveStatusCodes": [ + 200, + 429 + ] +} \ No newline at end of file From 4c3ac6c479751c6cc0f89ac8fac813d390385934 Mon Sep 17 00:00:00 2001 From: Ryan Ghods Date: Mon, 7 Aug 2023 13:33:26 -0400 Subject: [PATCH 3/5] lint checker: add base-branch `main` --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9ed23f0..29046e5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -76,6 +76,7 @@ jobs: use-quiet-mode: no use-verbose-mode: yes check-modified-files-only: yes + base-branch: main codespell: name: CodeSpell From af62772098418b24a6504c4170527bb088740c1a Mon Sep 17 00:00:00 2001 From: 0age <37939117+0age@users.noreply.github.com> Date: Mon, 7 Aug 2023 15:02:58 -0400 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Ryan Ghods --- SIPS/sip-7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SIPS/sip-7.md b/SIPS/sip-7.md index 2813605..972aa8e 100644 --- a/SIPS/sip-7.md +++ b/SIPS/sip-7.md @@ -103,7 +103,7 @@ 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 version byte or extra data provided. +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 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 | From ef3162aaad7867a3e3442946d4436572d1685a0f Mon Sep 17 00:00:00 2001 From: 0age <37939117+0age@users.noreply.github.com> Date: Mon, 7 Aug 2023 15:04:21 -0400 Subject: [PATCH 5/5] Update SIPS/sip-7.md --- SIPS/sip-7.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SIPS/sip-7.md b/SIPS/sip-7.md index 972aa8e..2223618 100644 --- a/SIPS/sip-7.md +++ b/SIPS/sip-7.md @@ -103,7 +103,7 @@ 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 byte or additional substandard data provided. +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 |