kommitters / soroban-did-contract Goto Github PK

Objective

Bump soroban-sdk to 20.0.0.

Checklist

• Solve breaking changes to work with Soroban stable release.

Objective

Expose a contract function to set DID attributes. See https://www.w3.org/TR/did-core/#did-documents.

Checklist

• Implement the function by receiving Context, Verification Methods, and Services.
• Check if the invoker is the SC admin.
• Enable updating of DID attributes within the function.
• Develop comprehensive tests, covering different scenarios and edge cases.
• Integrate the developed function into the initialize function.

Objective

Implement DID Document struct and update storage.

Checklist

1. Implement DID Document Struct:
   • Create a robust DIDDocument struct to comprehensively represent Decentralized Identifiers (DIDs) along with their associated information.
2. Revise Storage to Save Only a DID Document:
   • Modify the storage mechanism to exclusively store a single DIDDocument for each Decentralized Identifier.
   • Ensure that the storage design aligns with the updated DIDDocument structure.
3. Reflect All Changes in the DID Document:
   • Ensure that any modifications or updates in the contract, particularly related to DIDs, are accurately and consistently reflected in the associated DIDDocument.
4. Return DID Document in All Functions:
   • Modify existing functions to return the updated DIDDocument after any operations.
   • This ensures a cohesive and straightforward approach, providing a complete snapshot of the DID Document post-function execution.

Objective

Define the necessary data structures (structs, enums, etc) for the Soroban smart contract to properly represent the DID-related data. See https://www.w3.org/TR/did-core/#did-documents.

Checklist

• Implement the required data structures for the DID Contract.
• Implement the DID trait with the necessary functions the DID contract will have.
• Create functions to handle storage fields for the Soroban smart contract, ensuring proper data management and retrieval.

Objective

Implement the initialize function in the contract.

Note
This contract should be able to set the DID attributes on initialization. However, the contract will not receive the DID attributes for now. Once the function to set the DID attributes is implemented, the initialize function will need to be updated.

Checklist

• Receive admin and DID method.
• Perform base32 encoding in Rust without relying on external crates.
• Generate a random DID method-specific ID, encode it in base32, and return it within the initialize function.
• Add tests.

Objective

Implement CI for formatting and testing the code, and CD to deploy the contract to the Testnet network.

Checklist

• Set up a CI pipeline to automatically run code formatting and testing.
• Ensure that the CI pipeline is triggered on code changes and provides feedback on the formatting and testing results.
• Set up CD to automatically deploy contract changes to the Testnet network when a GitHub release is created.

Objective

Create the project structure for a new project and set up Soroban using Cargo. This includes adding the necessary Soroban configuration and test setup.

Checklist

• Use Cargo to create a new Rust project.
• Configure Soroban in the project.
• Set up the necessary tests for the project.

Objective

Use persistent storage type for DIDDocument.

Checklist

• Bump soroban-sdk to latest version (20.3.0).
• Use persistent storage type for DIDDocument.

ℹ️ This issue is part of Epic #(epic-issue)

Objective

Allow getting DID attributes.

Checklist

• Return the DID attributes: Context, DID URI, Verification Methods, and Services.
• Add tests.

Objective

Add a project description to the README file of the repository to provide an overview of the project and its purpose.

Checklist

• Write a clear and concise project description that explains the purpose of the project.