Skip to content

README.md

Latest commit

 

History

History
175 lines (120 loc) · 4.4 KB

README.md

File metadata and controls

175 lines (120 loc) · 4.4 KB
Raw

Automata DCAP Attestation on EVM Guide

Integration

To integrate your contract with Automata DCAP Attestation, you need to first install Foundry.

Add to your dependencies, by running:

# submodules
forge install automata-network/automata-dcap-attestation

# NPM
npm install @automata-network/automata-dcap-attestation

Then, add the following to your remappings.txt

@automata-network/dcap-attestation/=lib/automata-dcap-attestation/contracts/

Example

import "@automata-network/dcap-attestation/AutomataDcapAttestationFee.sol";

contract ExampleDcapContract {

    AutomataDcapAttestationFee attest;

    constructor(address _attest) {
        attest = AutomataDcapAttestationFee(_attest);
    }

    // On-Chain Attestation example
    function attestOnChain(bytes calldata quote) public {
        (bool success, bytes memory output) = attest.verifyAndAttestOnChain(quote);

        if (success) {
            // ... implementation to handle successful attestations
        } else {
            string memory errorMessage = string(output);
            // ... implementation to handle failed attestations
        }
    }

    // SNARK Attestation example
    // ZkCoProcessorType can either be RiscZero or Succinct
    function attestWithSnark(
        bytes calldata output,
        ZkCoProcessorType zkvm,
        bytes calldata proofBytes
    ) public 
    {
        (bool success, bytes memory output) = attest.verifyAndAttestWithZKProof(
            output,
            zkvm,
            proofBytes
        );

        if (success) {
            // ... implementation to handle successful attestations
        } else {
            string memory errorMessage = string(output);
            // ... implementation to handle failed attestations
        }
    }

}

BUIDL 🛠️

Getting Started

Clone this repo, by running the following command:

git clone https://github.com/automata-network/automata-dcap-attestation.git --recurse-submodules

Building With Foundry

Compile the contracts:

forge build

Testing the contracts:

forge test

To view gas report, pass the --gas-report flag.

To provide additional test cases, please include those in the /forge-test directory.

To provide additional scripts, please include those in the /forge-script directory.

Deployment Scripts

Before beginning with contract deployment, it is recommended that you store your wallet key as an encrypted keystore using cast wallet import

cast wallet import -k keystores dcap_prod --interactive

You may also simply pass your wallet key to the PRIVATE_KEY environment variable, but we do not recommend doing this with production keys.

Deploy the PCCS Router:

make deploy-router RPC_URL=<rpc-url>

Deploy Automata DCAP Attestation Entrypoint:

make deploy-attestation RPC_URL=<rpc-url>

Automata DCAP Entrypoint zkVM Configuration

make config-zk RPC_URL=<rpc-url> ZKVM_SELECTOR=<number> ZKVM_VERIFIER_ADDRESS=<address> ZKVM_PROGRAM_IDENTIFIER=<identifier>

Deploy Quote Verifiers For All Supported Versions:

make deploy-all-verifiers RPC_URL=<rpc-url>

Currently, we support V3, V4, and V5 quotes. Supported versions are defined in verifier-versions.json.

Deploy Quote Verifier For A Specific Version

make deploy-verifier RPC_URL=<rpc-url> QUOTE_VERIFIER_VERSION=<ver>

Deploy Across Multiple Chains (MULTICHAIN)

To deploy to multiple chains simultaneously, use MULTICHAIN=true and provide chain-specific RPC URLs:

Tip

When using MULTICHAIN=true, you don't need to set RPC_URL.

# Deploy a specific verifier version across multiple chains
MULTICHAIN=true make deploy-verifier QUOTE_VERIFIER_VERSION=5

# Deploy all supported verifiers across multiple chains
MULTICHAIN=true make deploy-all-verifiers

Add QuoteVerifier(s) to the Entrypoint contract:

Note

This command automatically grants the Quote Verifier read access to the PCCS Router.

make config-verifier RPC_URL=<rpc-url> QUOTE_VERIFIER_VERSION=<ver>

Explicitly Granting or Revoking the access privilege for the specified caller address to the PCCS Router

make config-router RPC_URL=<rpc-url> CALLER_ADDRESS=<address> AUTHORIZED=<true | false>