Skip to content

Update README: Add Deployment Info, Contract Review Links, and Deployment Instructions #9

@jdsika

Description

@jdsika

Objective:
Update the repository README.md to include:

  • Where the project is deployed.
  • How to review the deployed contracts and example chain interactions.
  • Clear deployment instructions for the On-Chain SSI architecture (migrating CRSet from Ethereum Blobs to Tezos Etherlink).

Tasks:

  1. Add Deployment Information:

    • Specify the networks where the project is deployed (e.g., Tezos Etherlink testnet/mainnet, Ethereum testnet/mainnet).
    • Provide links to block explorers or dashboards where users can review the deployed contracts (e.g., Etherlink Explorer, Etherscan).
    • Include example transaction hashes or contract addresses for reference.
  2. Document Contract Review and Example Interactions:

    • Add a section titled "Review Deployed Contracts" with:
      • Links to the deployed Issuer/Verifier services and Registry Smart Contracts.
      • Example chain interactions (e.g., DID resolution, credential issuance/verification).
      • Screenshots or links to example transactions (if available).
  3. Add Deployment Instructions:

    • Create a "Deployment Guide" section with step-by-step instructions for:
      • Setting up the environment (e.g., Node.js, Taquito/Tezos SDK, Hardhat/Truffle for Ethereum).
      • Configuring network settings (RPC endpoints, private keys, gas fees).
      • Compiling and deploying contracts to Ethereum Blobs and Tezos Etherlink.
      • Migrating CRSet data between chains (if applicable).
      • Verifying the deployment (e.g., checking contract addresses, testing interactions).
  4. Example Structure for README Updates:

    ## 🌐 Deployment Information
    - **Ethereum Blob Contracts**: [Etherscan Link](#)
      - Example Transaction: [`0x123...`](https://etherscan.io/tx/0x123)
    - **Tezos Etherlink Contracts**: [Etherlink Explorer Link](#)
      - Example Transaction: [`op123...`](https://etherlink.explorer/tx/op123)
    
    ## 🔍 Review Deployed Contracts
    - **Issuer Service**: [`0x456...`](#)
    - **Verifier Service**: [`KT1789...`](#)
    - **Registry Smart Contract**: [`0x789...`](#)
    - **Example Interactions**:
      - [DID Resolution Example](#)
      - [Credential Issuance Example](#)
    
    ## 🛠️ Deployment Instructions
    ### Prerequisites
    - Node.js v18+
    - Taquito/Tezos SDK for Tezos, Hardhat for Ethereum
    - RPC endpoints for Ethereum and Tezos Etherlink
    
    ### Steps
    1. Clone the repository and install dependencies:
       ```bash
       git clone https://github.com/ASCS-eV/on-chain-ssi.git
       cd on-chain-ssi
       npm install
    1. Configure .env with network settings and private keys.
    2. Compile contracts:
      npx hardhat compile  # Ethereum
      npx taquito compile  # Tezos
    3. Deploy contracts:
      npx hardhat run scripts/deploy-ethereum.js --network ethereum
      npx taquito run scripts/deploy-tezos.js --network etherlink
    4. Verify deployment by interacting with the contracts (see Example Interactions).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions