Keyring Network Smart Contracts

Smart contracts for Keyring Network, a platform providing institutional-grade compliance automation and permissioning solutions for blockchain protocols powered by zero-knowledge privacy.

Prerequisites

• Foundry

Installation

1. Clone the repository:

git clone git@github.com:Keyring-Network/keyring-smart-contracts.git
cd smart-contracts

2. Install dependencies:

forge soldeer install

Testing

Run all tests:

forge test --force

Generate coverage report:

forge clean && forge build && forge coverage

Deployment

1. Set up environment variables:

Set the required variables listed in the .env.example or copy it as .env

cp .env.example .env

2. Run the deployment script

w/o Etherscan verification:

source .env && forge script script/Deploy.s.sol \
            --force \
            --broadcast \
            --rpc-url $RPC_URL

w/ Etherscan verification:

source .env && forge script script/Deploy.s.sol \
            --force \
            --broadcast \
            --rpc-url $RPC_URL \
            --verify \
            --etherscan-api-key $ETHERSCAN_API_KEY \
            --verifier-url $ETHERSCAN_BASE_API_URL \
            --retries 20