Skip to content

Latest commit

 

History

History
94 lines (68 loc) · 3.46 KB

README.md

File metadata and controls

94 lines (68 loc) · 3.46 KB
Raw

Seraph ID Smart Contract Templates.

Overview

This repository contains two smart contract templates for the SeraphID Self-Sovereign identity framework:

  • Issuer (Dynamic on-chain claim registry)
  • RootOfTrust (Enabling hierarchical trust topologies)

Visit the Seraph ID official web page to learn more about self-sovereign identity!

Smart Contract Interface

Issuer

string Name();
string DID();
ECPoint[] GetPublicKeys(); // Get public keys
string GetSchemaDetails(string schemaName); // Returns all attributes attached to a schema
bool RegisterSchema(string schemaName, string schemaDefinition); // Registers a new schema and defines revokability
bool InjectClaim(string claimID); // Injects a claim to allow for revokability
bool RevokeClaim(string claimID); // Revokes a claim
bool IsValidClaim(string claimID); // Returns a claims revocation status
bool AddAdmin(ECPoint pubKey); // Add an admin
bool RemoveAdmin(ECPoint pubKey); // Remove an admin
ECPoint[] GetAdminList(); // Get all the admins

Root Of Trust

string Name();
Result IsTrusted(string issuerDID, string schemaName); // Checks if a did-schema pair is trusted
Result RegisterIssuer(string issuerDID, string schemaName); // Adds a trusted did-schema pair
Result DeactivateIssuer(string issuerDID, string schemaName); // Removes a did-schema pair

Return Types

All smart contract calls (except for static information like name, DID, PublicKey) will return a Result object with the following structure:

[
    {"type": "integer", "value": "<SUCCESSSTATUS>"},
    {"type": "<variable>", "value": "<variable>"}
]

If <SUCCESSSTATUS> is 0, an error has occured in the smart contract and the error reason will be listed as the value in the second object. The type of <variable> depends on the function being called.

Deploying

Deploying the smart contract is a prerequisite to issue claims using the Seraph ID SDK and can be done using neo-cli or neo-gui. Make sure to note down the resulting scripthash as this will be used in the Seraph ID SDK.

neo-cli

Make sure your wallet is open and contains enough GAS to pay for the smart contract creation.

neo> open wallet path\to\mywallet
neo> deploy Path\to\contract\seraph-id-issuer.nef

Contributing

Compiling

In order to compile the smart contracts into a nef file, the Neon compiler needs to be available in the PATH of your user.

Note: In order to build the smart contract the neon compiler needs to be run with the --compatibility flag. We recommend either building the compiler from source and changing the compatibility flag to always be on or running the neon compiler from the command line

References

License

  • Open-source MIT.