Skip to content

Solidity implementation of Intuition's on-chain smart contracts (Beta; WIP).

License

Notifications You must be signed in to change notification settings

0xIntuition/intuition-beta-contracts

Repository files navigation

Intuition Protocol

Intuition is an Ethereum-based attestation protocol harnessing the wisdom of the crowds to create an open knowledge and reputation graph. Our infrastructure makes it easy for applications and their users to capture, explore, and curate verifiable data. We’ve prioritized making developer integrations easy and have implemented incentive structures that prioritize ‘useful’ data and discourage spam.

In bringing this new data layer to the decentralized web, we’re opening the flood gates to countless new use cases that we believe will kick off a consumer application boom.

The Intuition Knowledge Graph will be recognized as an organic flywheel, where the more developers that implement it, the more valuable the data it houses becomes.

Getting Started

Documentation

To get a basic understanding of the Intuition protocol, please check out the following:

Rationale

  • This repository contains a sort of frankenstein of the previously audited EthMultiVault and the new Bonding Curve Registry features.
  • All bonding curve related activities have their own methods / routes in the EthMultiVault.
  • This results in duplicative code, but enables us to keep the old EthMultiVault and the new Bonding Curve Registry features separate.
  • The next version of the MultiVault will consolidate and converge these disparate pathways into a far more elegant and organized system.

Building and Running Tests

To build the project and run tests, follow these steps:

Prerequisites

Step by Step Guide

Install Dependencies

$ npm i
$ forge install

Build

$ forge build

Run Tests

$ forge test -vvv

Run Fuzz Tests

  • Make sure you have at least node 16 and python 3.6 installed on your local machine
  • Add your FUZZ_AP_KEY to the .env file locally
  • Run the following command to install the diligence-fuzzing package:
$ pip3 install diligence-fuzzing
  • After the installation is completed, run the fuzzing CLI:
$ fuzz forge test
  • Finally, check your Diligence Fuzzing dashboard to see the results of the fuzzing tests

Run Slither (Static Analysis)

  • Install the slither-analyzer package:
  $ pip3 install slither-analyzer
  • After the installation is completed, run the slither analysis bash script:
  $ npm run slither

Run Manticore (Symbolic Execution)

  • Make sure you have Docker installed on your local machine

  • Build the Docker image:

  $ docker build -t manticore-analysis .
  • Run the Docker container:
  $ docker run --rm -v "$(pwd)":/app manticore-analysis

Deployment Process

To deploy the Beta smart contract system on to a public testnet or mainnet, you’ll need the following:

  • RPC URL of the network that you’re trying to deploy to (as for us, we’re targeting Base Sepolia testnet as our target chain for the testnet deployments)
  • Export PRIVATE_KEY of a deployer account in the terminal, and fund it with some test ETH to be able to cover the gas fees for the smart contract deployments
  • For Base Sepolia, there is a reliable testnet faucet deployed by Alchemy
  • Deploy smart contracts using the following command:
$ forge script script/Deploy.s.sol --broadcast --rpc-url <your_rpc_url> --private-key $PRIVATE_KEY

Deployment Verification

To verify the deployed smart contracts on Etherscan, you’ll need to export your Etherscan API key as ETHERSCAN_API_KEY in the terminal, and then run the following command:

$ forge verify-contract <0x_contract_address> ContractName --watch --chain-id <chain_id>

Notes:

  • When verifying your smart contracts, you can use an optional parameter --constructor-args to pass the constructor arguments of the smart contract in the ABI-encoded format
  • The chain ID for Base Sepolia is 84532, whereas the chain ID for Base Mainnet is 8453

About

Solidity implementation of Intuition's on-chain smart contracts (Beta; WIP).

Resources

License

Stars

Watchers

Forks

Packages

No packages published