@secure-ci/core v1.0.1

Secure Contract Interaction (SCI)

The Secure Contract Interaction (SCI) Protocol is an open-source initiative aimed at enhancing security within the web3 ecosystem. It introduces a decentralized verification system allowing domain owners to authorize specific smart contracts to interact with their domains, thus minimizing risks associated with malicious contracts.

Features

• Decentralized Verification: Verify contracts authorized to interact with specific domains.
• Flexibility: Easily integrate into wallets, security apps, and on-chain contracts.
• Open-Source: Free to use and contribute to, promoting transparency and collaboration.
• Enhanced Security: Protect users from interacting with malicious smart contracts.

Docs

For more information you can read the Whitepaper

Installation

Prerequisites

• NVM installed
• pnpm package manager installed

Steps

1. Clone the repository:

git clone git@github.com:sci-domains/core.git

2. Navigate to the project directory:

cd core

3. Install and use node with nvm:

nvm install
nvm use

4. Install dependencies using Pnpm:

pnpm install

Scripts

Compile Solidity contracts:

pnpm compile

Run tests:

pnpm test

Deploy:

For the deployments we use hardhat ignition

pnpm deploy:<network>

To add a new chain you need to add a new configuration inside parameters and add a new script in the package.json

You can deploy specific modules using hardhat ignition

After running the deployment, make sure to add the addresses to the deployments.ts file

pnpm save:deployments

Testnet deployment

// Make sure you have the API Key for optimism sepolia etherscan
pnpm deploy:sepolia-optimsim
// Change the superChainTargetRegistrar in ignition/parameters/sepolia.json5
// Make sure you have the API Key for sepolia etherscan
pnpm deploy:sepolia
// Change the ensRegistrarAddress in ignition/paramters/optimism-sepolia.json
pnpm deploy:cleanup:testnet

Production deployment

// Make sure you have the API Key for optimism etherscan
pnpm deploy:optimism
// Change the superChainTargetRegistrar in ignition/parameters/ethereum.json5
// Make sure you have the API Key for etherscan
pnpm deploy:ethereum
// Change the ensRegistrarAddress in ignition/paramters/optimism.json
pnpm deploy:cleanup:production


### Publish:

We use [changesets](https://www.npmjs.com/package/@changesets/cli) to manage the versioning and publishing of the packages

Publishing and versioning is done automatically by the CI/CD pipeline

### Development:

You can execute the following commands to run a local node and deploy
the ENS Registry with the contracts from the protocol

```bash
pnpm node
// In another terminal
pnpm dev

Contributing

Please see our contribution guidelines.

Maintainers

SCI is an open-source community project governed by a core team.

License

This project is licensed under the MIT License.