first steps #1
Merged
first steps #1
Conversation
This file contains 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
- Set up data structures for token metadata - Introduce an abstraction for off-chain storage of a `MerkleMap` This allows us to do dependency injection, so that we can use an in-memory map for testing, and real-world implementations can use the solution that best fits their needs. - Implement the first method of the `SoulboundToken` smart contract: issuing a new token.
Revocation does not yet take the RevocationPolicy into account.
src/RevocationPolicy.ts
Outdated
Comment on lines
6
to
22
| /** When a token is issued, issuer and holder should agree on who can revoke the token */ | ||
| class RevocationPolicy extends Struct ({ | ||
| type: Field, | ||
| }) { | ||
| public static types = { | ||
| // the issuer has the right to revoke tokens | ||
| issuerOnly: Field(0), | ||
| // only the holder of the token can revoke it | ||
| holderOnly: Field(1), | ||
| // a token can only be revoked if issuer and holder agree | ||
| both: Field(2), | ||
| // tokens are indestructible | ||
| neither: Field(3), | ||
| }; | ||
| } | ||
|
|
||
| export { RevocationPolicy }; |
There was a problem hiding this comment.
There's potentially two ways to use the RevocationPolicy
-
Instead of making this a
Structwe can make it anotherMerkleMapwho's root is committed to the contract at deployment time and use aZkProgramto attest to theRevocationPolicyof the SBT. -
Alternatively, the
SmartContractcould have a state that defines theRevociationPolicy(e.g. a hash or field) and a method check if the inputStructargument satisfies those constraints.
| * part of the contract state. | ||
| * | ||
| */ | ||
| class SoulboundToken |
There was a problem hiding this comment.
This is looking great!
This should fix the CI build step.
This makes the tests more succinct, and also allows us to keep the off-chain map in sync.
Also, tried to add a test that demonstrates that verifying a nonexistent token fails. However, the error that's raised within the smart contract does not get caught by the test, and the test fails (although running the test shows that the right thing happens).
kantp
force-pushed
the
kantp/first-steps
branch
from
6d14721 to
8d53f37
Compare
If we use the plain metadata, the same signed message that was used to issue a token will be sufficient to revoke it. We introduce a new type, `SoulboundRequest` that contains the metadata, as well as the request type (issuing or revoking a token).
kantp
force-pushed
the
kantp/first-steps
branch
from
681c146 to
8869f72
Compare
kantp
force-pushed
the
kantp/first-steps
branch
from
39736e5 to
cb3922f
Compare
This allows users to validate that a token has existed at a certain point, without needing to call the contract again.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I've put down a design of how the contract keeps track of the off- and on-chain state, and added a method for issuing tokens. Reocation and attestation will follow soon.