From 8f3c4e2c69f3d68c13590226b7a90286f554efea Mon Sep 17 00:00:00 2001 From: Joe Polny Date: Wed, 19 Jun 2024 13:41:46 -0400 Subject: [PATCH] update README --- reference_contract/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 reference_contract/README.md diff --git a/reference_contract/README.md b/reference_contract/README.md new file mode 100644 index 0000000..89f9e5b --- /dev/null +++ b/reference_contract/README.md @@ -0,0 +1,15 @@ +# Reference Contract + +This is the reference implementation of the contract that will be used to store the DIDDocuments for `did:algo`. This is the contract that is used by the CLI tool by default when deploying a new contract. + +It should be noted that the `did:algo` spec will work with any contract that implements the ABI interface defined in [the ARC4 JSON description](./contracts/artifacts/AlgoDID.arc4.json) and the `did:algo` [spec](../SPEC.md). + +## Tests + +Tests for the contract can be found at [here](./__test__/algo-did.test.ts). + +## Interacting With Contract + +Golang code for interacting with this contract can be seen [here](../client/internal/main.go). + +TypeScript code for interacting with this contract can be seen [here](./src/index.ts).