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

• Intuition Protocol
  • Getting Started
  • Documentation
    • Known Nuances
  • Building and Running Tests
    • Prerequisites
    • Step by Step Guide
      • Install Dependencies
      • Build
      • Run Tests
      • Run Fuzz Tests
      • Run Slither (Static Analysis)
      • Run Manticore (Symbolic Execution)
    • Deployment Process
    • Deployment Verification

Documentation

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

• Official Website
• Official Documentation
• Deep Dive into Our Smart Contracts
• Full Contracts Documentation

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

• Node.js
• Foundry

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

Contract Architecture

This document provides an overview of the core contracts and their relationships. Click on any contract to view its detailed documentation.

graph TB
    Interfaces(("Interfaces"))
    Core(("Core"))
    Libraries(("Libraries"))

    subgraph InterfacesList ["Interfaces"]
        direction LR
        IBaseCurve & IBondingCurveRegistry
        IEthMultiVault & IPermit2
    end
    Interfaces --> InterfacesList

    subgraph CoreList ["Core"]
        direction LR
        AtomWallet & BaseCurve
        BondingCurveRegistry & EthMultiVault
        LinearCurve & OffsetProgressiveCurve
        ProgressiveCurve
    end
    Core --> CoreList

    subgraph LibrariesList ["Libraries"]
        direction LR
        Errors
    end
    Libraries --> LibrariesList

    %% Style definitions
    classDef default fill:#f4f4f4,stroke:#333,stroke-width:2px,font-size:24px,font-family:Arial,rounded:true,color:#000;
    classDef root fill:#6366f1,color:#fff,stroke:#4338ca,stroke-width:4px,font-size:32px,font-weight:bold,font-family:Arial,rx:40px;
    classDef category fill:none,stroke:none,color:#000,font-size:24px,font-weight:bold,font-family:Arial;
    
    %% Apply styles
    class Interfaces,Core,Libraries root;
    class InterfacesList,CoreList,LibrariesList category;

    %% Click actions
    click IPermit2 "http://localhost:3000/src/interfaces/IPermit2.sol/interface.IPermit2.html" "IPermit2 documentation"
    click IEthMultiVault "http://localhost:3000/src/interfaces/IEthMultiVault.sol/interface.IEthMultiVault.html" "IEthMultiVault documentation"
    click IBaseCurve "http://localhost:3000/src/interfaces/IBaseCurve.sol/interface.IBaseCurve.html" "IBaseCurve documentation"
    click IBondingCurveRegistry "http://localhost:3000/src/interfaces/IBondingCurveRegistry.sol/interface.IBondingCurveRegistry.html" "IBondingCurveRegistry documentation"
    click EthMultiVault "EthMultiVault.html" "EthMultiVault documentation"
    click LinearCurve "LinearCurve.html" "LinearCurve documentation"
    click AtomWallet "AtomWallet.html" "AtomWallet documentation"
    click ProgressiveCurve "ProgressiveCurve.html" "ProgressiveCurve documentation"
    click BondingCurveRegistry "BondingCurveRegistry.html" "BondingCurveRegistry documentation"
    click BaseCurve "BaseCurve.html" "BaseCurve documentation"
    click OffsetProgressiveCurve "OffsetProgressiveCurve.html" "OffsetProgressiveCurve documentation"
    click Errors "http://localhost:3000/src/libraries/Errors.sol/library.Errors.html" "Errors documentation"

EthMultiVault

Detailed view of the EthMultiVault contract and its members. Click on any member to view its documentation.

graph TB
    root(("EthMultiVault"))

    %% Style definitions
    classDef default fill:#f4f4f4,stroke:#333,stroke-width:2px,font-size:28px,font-family:Arial,rounded:true;
    classDef root fill:#6366f1,color:#fff,stroke:#4338ca,stroke-width:4px,font-size:32px,font-weight:bold,font-family:Arial,rx:40px;
    classDef stateVar fill:#dbeafe,stroke:#3b82f6,stroke-width:2px,color:#1e40af,font-size:28px,font-family:Arial,rounded:true;
    classDef function fill:#e0e7ff,stroke:#818cf8,stroke-width:2px,color:#4338ca,font-size:28px,font-family:Arial,rounded:true;
    classDef contract fill:#fef3c7,stroke:#f59e0b,stroke-width:2px,color:#b45309,font-size:28px,font-family:Arial,rounded:true;
    classDef category fill:none,stroke:none,color:#333,font-size:28px,font-weight:bold,font-family:Arial;
    
    %% Apply styles
    class root root;
    class StateVars,CoreFunctions,Getters,Setters,PreviewFunctions,ConversionFunctions,Initialization,Uses,Inheritance category;

    %% Click actions
    click root "http://localhost:3000/src/EthMultiVault.sol/contract.EthMultiVault.html" "EthMultiVault documentation"

BondingCurveRegistry

Detailed view of the BondingCurveRegistry contract and its members. Click on any member to view its documentation.

graph TB
    root(("BondingCurveRegistry"))

    %% Style definitions
    classDef default fill:#f4f4f4,stroke:#333,stroke-width:2px,font-size:28px,font-family:Arial,rounded:true;
    classDef root fill:#6366f1,color:#fff,stroke:#4338ca,stroke-width:4px,font-size:32px,font-weight:bold,font-family:Arial,rx:40px;
    classDef stateVar fill:#dbeafe,stroke:#3b82f6,stroke-width:2px,color:#1e40af,font-size:28px,font-family:Arial,rounded:true;
    classDef function fill:#e0e7ff,stroke:#818cf8,stroke-width:2px,color:#4338ca,font-size:28px,font-family:Arial,rounded:true;
    classDef contract fill:#fef3c7,stroke:#f59e0b,stroke-width:2px,color:#b45309,font-size:28px,font-family:Arial,rounded:true;
    classDef category fill:none,stroke:none,color:#333,font-size:28px,font-weight:bold,font-family:Arial;
    
    %% Apply styles
    class root root;
    class StateVars,CoreFunctions,Getters,Setters,PreviewFunctions,ConversionFunctions,Initialization,Uses,Inheritance category;

    %% Click actions
    click root "http://localhost:3000/src/BondingCurveRegistry.sol/contract.BondingCurveRegistry.html" "BondingCurveRegistry documentation"

BaseCurve

Detailed view of the BaseCurve contract and its members. Click on any member to view its documentation.

graph TB
    root(("BaseCurve"))

    %% Style definitions
    classDef default fill:#f4f4f4,stroke:#333,stroke-width:2px,font-size:28px,font-family:Arial,rounded:true;
    classDef root fill:#6366f1,color:#fff,stroke:#4338ca,stroke-width:4px,font-size:32px,font-weight:bold,font-family:Arial,rx:40px;
    classDef stateVar fill:#dbeafe,stroke:#3b82f6,stroke-width:2px,color:#1e40af,font-size:28px,font-family:Arial,rounded:true;
    classDef function fill:#e0e7ff,stroke:#818cf8,stroke-width:2px,color:#4338ca,font-size:28px,font-family:Arial,rounded:true;
    classDef contract fill:#fef3c7,stroke:#f59e0b,stroke-width:2px,color:#b45309,font-size:28px,font-family:Arial,rounded:true;
    classDef category fill:none,stroke:none,color:#333,font-size:28px,font-weight:bold,font-family:Arial;
    
    %% Apply styles
    class root root;
    class StateVars,CoreFunctions,Getters,Setters,PreviewFunctions,ConversionFunctions,Initialization,Uses,Inheritance category;

    %% Click actions
    click root "http://localhost:3000/src/BaseCurve.sol/contract.BaseCurve.html" "BaseCurve documentation"

LinearCurve

Detailed view of the LinearCurve contract and its members. Click on any member to view its documentation.

graph TB
    root(("LinearCurve"))

    %% Style definitions
    classDef default fill:#f4f4f4,stroke:#333,stroke-width:2px,font-size:28px,font-family:Arial,rounded:true;
    classDef root fill:#6366f1,color:#fff,stroke:#4338ca,stroke-width:4px,font-size:32px,font-weight:bold,font-family:Arial,rx:40px;
    classDef stateVar fill:#dbeafe,stroke:#3b82f6,stroke-width:2px,color:#1e40af,font-size:28px,font-family:Arial,rounded:true;
    classDef function fill:#e0e7ff,stroke:#818cf8,stroke-width:2px,color:#4338ca,font-size:28px,font-family:Arial,rounded:true;
    classDef contract fill:#fef3c7,stroke:#f59e0b,stroke-width:2px,color:#b45309,font-size:28px,font-family:Arial,rounded:true;
    classDef category fill:none,stroke:none,color:#333,font-size:28px,font-weight:bold,font-family:Arial;
    
    %% Apply styles
    class root root;
    class StateVars,CoreFunctions,Getters,Setters,PreviewFunctions,ConversionFunctions,Initialization,Uses,Inheritance category;

    %% Click actions
    click root "http://localhost:3000/src/LinearCurve.sol/contract.LinearCurve.html" "LinearCurve documentation"

ProgressiveCurve

Detailed view of the ProgressiveCurve contract and its members. Click on any member to view its documentation.

graph TB
    root(("ProgressiveCurve"))

    %% Style definitions
    classDef default fill:#f4f4f4,stroke:#333,stroke-width:2px,font-size:28px,font-family:Arial,rounded:true;
    classDef root fill:#6366f1,color:#fff,stroke:#4338ca,stroke-width:4px,font-size:32px,font-weight:bold,font-family:Arial,rx:40px;
    classDef stateVar fill:#dbeafe,stroke:#3b82f6,stroke-width:2px,color:#1e40af,font-size:28px,font-family:Arial,rounded:true;
    classDef function fill:#e0e7ff,stroke:#818cf8,stroke-width:2px,color:#4338ca,font-size:28px,font-family:Arial,rounded:true;
    classDef contract fill:#fef3c7,stroke:#f59e0b,stroke-width:2px,color:#b45309,font-size:28px,font-family:Arial,rounded:true;
    classDef category fill:none,stroke:none,color:#333,font-size:28px,font-weight:bold,font-family:Arial;
    
    %% Apply styles
    class root root;
    class StateVars,CoreFunctions,Getters,Setters,PreviewFunctions,ConversionFunctions,Initialization,Uses,Inheritance category;

    %% Click actions
    click root "http://localhost:3000/src/ProgressiveCurve.sol/contract.ProgressiveCurve.html" "ProgressiveCurve documentation"

AtomWallet

Detailed view of the AtomWallet contract and its members. Click on any member to view its documentation.

graph TB
    root(("AtomWallet"))

    %% Style definitions
    classDef default fill:#f4f4f4,stroke:#333,stroke-width:2px,font-size:28px,font-family:Arial,rounded:true;
    classDef root fill:#6366f1,color:#fff,stroke:#4338ca,stroke-width:4px,font-size:32px,font-weight:bold,font-family:Arial,rx:40px;
    classDef stateVar fill:#dbeafe,stroke:#3b82f6,stroke-width:2px,color:#1e40af,font-size:28px,font-family:Arial,rounded:true;
    classDef function fill:#e0e7ff,stroke:#818cf8,stroke-width:2px,color:#4338ca,font-size:28px,font-family:Arial,rounded:true;
    classDef contract fill:#fef3c7,stroke:#f59e0b,stroke-width:2px,color:#b45309,font-size:28px,font-family:Arial,rounded:true;
    classDef category fill:none,stroke:none,color:#333,font-size:28px,font-weight:bold,font-family:Arial;
    
    %% Apply styles
    class root root;
    class StateVars,CoreFunctions,Getters,Setters,PreviewFunctions,ConversionFunctions,Initialization,Uses,Inheritance category;

    %% Click actions
    click root "http://localhost:3000/src/AtomWallet.sol/contract.AtomWallet.html" "AtomWallet documentation"

Attestoor

AttestoorFactory

CustomMulticall3

Contents

• IBaseCurve
• IBondingCurveRegistry
• IEthMultiVault
• IPermit2

IBaseCurve

Git Source

Author: 0xIntuition

Interface for bonding curves in the Intuition protocol. All curves must implement these functions to be compatible with the protocol.

Functions

name

Get the name of the curve

function name() external view returns (string memory);

Returns

maxShares

Get the maximum number of shares the curve can handle

function maxShares() external view returns (uint256);

Returns

maxAssets

Get the maximum number of assets the curve can handle

function maxAssets() external view returns (uint256);

Returns

previewDeposit

Preview how many shares would be minted for a deposit of assets

function previewDeposit(uint256 assets, uint256 totalAssets, uint256 totalShares)
    external
    view
    returns (uint256 shares);

Parameters

Returns

previewRedeem

Preview how many assets would be returned for burning a specific amount of shares

function previewRedeem(uint256 shares, uint256 totalShares, uint256 totalAssets)
    external
    view
    returns (uint256 assets);

Parameters

Returns

previewWithdraw

Preview how many shares would be redeemed for a withdrawal of assets

function previewWithdraw(uint256 assets, uint256 totalAssets, uint256 totalShares)
    external
    view
    returns (uint256 shares);

Parameters

Returns

previewMint

Preview how many assets would be required to mint a specific amount of shares

function previewMint(uint256 shares, uint256 totalShares, uint256 totalAssets) external view returns (uint256 assets);

Parameters

Returns

convertToShares

Convert assets to shares at a specific point on the curve

function convertToShares(uint256 assets, uint256 totalAssets, uint256 totalShares)
    external
    view
    returns (uint256 shares);

Parameters

Returns

convertToAssets

Convert shares to assets at a specific point on the curve

function convertToAssets(uint256 shares, uint256 totalShares, uint256 totalAssets)
    external
    view
    returns (uint256 assets);

Parameters

Returns

currentPrice

Get the current price of a share

function currentPrice(uint256 totalShares) external view returns (uint256 sharePrice);

Parameters

Returns

IBondingCurveRegistry

Git Source

Author: 0xIntuition

Interface for the BondingCurveRegistry contract. Routes access to the curves associated with atoms & triples.

Functions

previewDeposit

Preview how many shares would be minted for a deposit of assets

function previewDeposit(uint256 assets, uint256 totalAssets, uint256 totalShares, uint256 id)
    external
    view
    returns (uint256 shares);

Parameters

Returns

previewRedeem

Preview how many assets would be returned for burning a specific amount of shares

function previewRedeem(uint256 shares, uint256 totalShares, uint256 totalAssets, uint256 id)
    external
    view
    returns (uint256 assets);

Parameters

Returns

previewWithdraw

Preview how many shares would be redeemed for a withdrawal of assets

function previewWithdraw(uint256 assets, uint256 totalAssets, uint256 totalShares, uint256 id)
    external
    view
    returns (uint256 shares);

Parameters

Returns

previewMint

Preview how many assets would be required to mint a specific amount of shares

function previewMint(uint256 shares, uint256 totalShares, uint256 totalAssets, uint256 id)
    external
    view
    returns (uint256 assets);

Parameters

Returns

convertToShares

Convert assets to shares at a specific point on the curve

function convertToShares(uint256 assets, uint256 totalAssets, uint256 totalShares, uint256 id)
    external
    view
    returns (uint256 shares);

Parameters

Returns

convertToAssets

Convert shares to assets at a specific point on the curve

function convertToAssets(uint256 shares, uint256 totalShares, uint256 totalAssets, uint256 id)
    external
    view
    returns (uint256 assets);

Parameters

Returns

currentPrice

Get the current price of a share

function currentPrice(uint256 totalShares, uint256 id) external view returns (uint256 sharePrice);

Parameters

Returns

getCurveName

Get the name of a curve

function getCurveName(uint256 id) external view returns (string memory name);

Parameters

Returns

getCurveMaxShares

Get the maximum number of shares a curve can handle

function getCurveMaxShares(uint256 id) external view returns (uint256 maxShares);

Parameters

Returns

getCurveMaxAssets

Get the maximum number of assets a curve can handle

function getCurveMaxAssets(uint256 id) external view returns (uint256 maxAssets);

Parameters

Returns

count

Get the number of curves registered in the registry

function count() external view returns (uint256);

Returns

curveAddresses

Get the curve address for a given ID

function curveAddresses(uint256 id) external view returns (address);

Parameters

Returns

curveIds

Get the curve ID for a given address

function curveIds(address curve) external view returns (uint256);

Parameters

Returns

IEthMultiVault

Git Source

Author: 0xIntuition

Interface for managing many ERC4626 style vaults in a single contract

Functions

init

Initializes the EthMultiVault contract

function init(
    GeneralConfig memory _generalConfig,
    AtomConfig memory _atomConfig,
    TripleConfig memory _tripleConfig,
    WalletConfig memory _walletConfig,
    VaultFees memory _defaultVaultFees,
    BondingCurveConfig memory _bondingCurveConfig
) external;

Parameters

reinitialize

Reinitialize the contract with new bonding curve configuration

function reinitialize(BondingCurveConfig calldata bondingCurveConfig) external;

Parameters

pause

pauses the pausable contract methods

function pause() external;

unpause

unpauses the pausable contract methods

function unpause() external;

scheduleOperation

schedule an operation to be executed after a delay

function scheduleOperation(bytes32 operationId, bytes calldata data) external;

Parameters

cancelOperation

execute a scheduled operation

function cancelOperation(bytes32 operationId, bytes calldata data) external;

Parameters

setAdmin

Requires new admin to 'confirm' the timelocked operation

set admin

function setAdmin(address admin) external;

Parameters

setProtocolMultisig

set protocol multisig

function setProtocolMultisig(address protocolMultisig) external;

Parameters

setMinDeposit

sets the minimum deposit amount for atoms and triples

function setMinDeposit(uint256 minDeposit) external;

Parameters

setMinShare

sets the minimum share amount for atoms and triples

function setMinShare(uint256 minShare) external;

Parameters

setAtomUriMaxLength

sets the atom URI max length

function setAtomUriMaxLength(uint256 atomUriMaxLength) external;

Parameters

setAtomWalletInitialDepositAmount

sets the atom share lock fee

function setAtomWalletInitialDepositAmount(uint256 atomWalletInitialDepositAmount) external;

Parameters

setAtomCreationProtocolFee

sets the atom creation fee

function setAtomCreationProtocolFee(uint256 atomCreationProtocolFee) external;

Parameters

setTripleCreationProtocolFee

sets fee charged in wei when creating a triple to protocol multisig

function setTripleCreationProtocolFee(uint256 tripleCreationProtocolFee) external;

Parameters

setTotalAtomDepositsOnTripleCreation

sets the atom deposit fraction on triple creation used to increase the amount of assets in the underlying atom vaults on triple creation

function setTotalAtomDepositsOnTripleCreation(uint256 totalAtomDepositsOnTripleCreation) external;

Parameters

setAtomDepositFractionForTriple

sets the atom deposit fraction percentage for atoms used in triples (number to be divided by generalConfig.feeDenominator)

function setAtomDepositFractionForTriple(uint256 atomDepositFractionForTriple) external;

Parameters

setBondingCurveConfig

sets the bonding curve configuration

function setBondingCurveConfig(address registry, uint256 defaultCurveId) external;

Parameters

setEntryFee

sets entry fees for the specified vault (id=0 sets the default fees for all vaults) id = 0 changes the default entry fee, id = n changes fees for vault n specifically

admin cannot set the entry fee to be greater than maxEntryFeePercentage, which is set to be the 10% of generalConfig.feeDenominator (which represents 100%), to avoid being able to prevent users from depositing assets with unreasonable fees

function setEntryFee(uint256 id, uint256 entryFee) external;

Parameters

setExitFee

sets exit fees for the specified vault (id=0 sets the default fees for all vaults) id = 0 changes the default exit fee, id = n changes fees for vault n specifically

admin cannot set the exit fee to be greater than maxExitFeePercentage, which is set to be the 10% of generalConfig.feeDenominator (which represents 100%), to avoid being able to prevent users from withdrawing their assets

function setExitFee(uint256 id, uint256 exitFee) external;

Parameters

setProtocolFee

sets protocol fees for the specified vault (id=0 sets the default fees for all vaults) id = 0 changes the default protocol fee, id = n changes fees for vault n specifically

admin cannot set the protocol fee to be greater than maxProtocolFeePercentage, which is set to be the 10% of generalConfig.feeDenominator (which represents 100%), to avoid being able to prevent users from depositing or withdrawing their assets with unreasonable fees

function setProtocolFee(uint256 id, uint256 protocolFee) external;

Parameters

setAtomWarden

sets the atomWarden address

function setAtomWarden(address atomWarden) external;

Parameters

deployAtomWallet

deploy a given atom wallet

function deployAtomWallet(uint256 atomId) external returns (address);

Parameters

Returns

approve

Set the approval type for a sender to act on behalf of the receiver

function approve(address sender, ApprovalTypes approvalType) external;

Parameters

createAtom

Create an atom and return its vault id

function createAtom(bytes calldata atomUri) external payable returns (uint256);

Parameters

Returns

batchCreateAtom

Batch create atoms and return their vault ids

function batchCreateAtom(bytes[] calldata atomUris) external payable returns (uint256[] memory);

Parameters

Returns

createTriple

create a triple and return its vault id

function createTriple(uint256 subjectId, uint256 predicateId, uint256 objectId) external payable returns (uint256);

Parameters

Returns

batchCreateTriple

batch create triples and return their vault ids

function batchCreateTriple(uint256[] calldata subjectIds, uint256[] calldata predicateIds, uint256[] calldata objectIds)
    external
    payable
    returns (uint256[] memory);

Parameters

depositAtom

deposit eth into an atom vault and grant ownership of 'shares' to 'reciever' *payable msg.value amount of eth to deposit

assets parameter is omitted in favor of msg.value, unlike in ERC4626

function depositAtom(address receiver, uint256 id) external payable returns (uint256);

Parameters

Returns

depositAtomCurve

deposit eth into an atom vault and grant ownership of 'shares' to 'reciever' *payable msg.value amount of eth to deposit

assets parameter is omitted in favor of msg.value, unlike in ERC4626

function depositAtomCurve(address receiver, uint256 atomId, uint256 curveId) external payable returns (uint256);

Parameters

Returns

redeemAtom

redeem assets from an atom vault

function redeemAtom(uint256 shares, address receiver, uint256 id) external returns (uint256);

Parameters

Returns

redeemAtomCurve

redeem shares from a bonding curve atom vault for assets

function redeemAtomCurve(uint256 shares, address receiver, uint256 atomId, uint256 curveId)
    external
    returns (uint256);

Parameters

Returns

depositTriple

deposits assets of underlying tokens into a triple vault and grants ownership of 'shares' to 'receiver' *payable msg.value amount of eth to deposit

assets parameter is omitted in favor of msg.value, unlike in ERC4626

function depositTriple(address receiver, uint256 id) external payable returns (uint256);

Parameters

Returns

depositTripleCurve

deposit eth into a bonding curve triple vault and grant ownership of 'shares' to 'receiver' *payable msg.value amount of eth to deposit

assets parameter is omitted in favor of msg.value, unlike in ERC4626

function depositTripleCurve(address receiver, uint256 tripleId, uint256 curveId) external payable returns (uint256);

Parameters

Returns

redeemTriple

redeems 'shares' number of shares from the triple vault and send 'assets' eth from the contract to 'reciever' factoring in exit fees

function redeemTriple(uint256 shares, address receiver, uint256 id) external returns (uint256);

Parameters

Returns

redeemTripleCurve

redeem shares from a bonding curve triple vault for assets

function redeemTripleCurve(uint256 shares, address receiver, uint256 tripleId, uint256 curveId)
    external
    returns (uint256);

Parameters

Returns

batchDeposit

deposit eth into multiple terms and grant ownership of 'shares' to 'reciever' *payable msg.value amount of eth to deposit works with atoms, triples, and counter-triples

function batchDeposit(address receiver, uint256[] calldata termIds, uint256[] calldata amounts)
    external
    payable
    returns (uint256[] memory);

Parameters

Returns

batchDepositCurve

deposit eth into an atom vault and grant ownership of 'shares' to 'reciever' *payable msg.value amount of eth to deposit

function batchDepositCurve(
    address receiver,
    uint256[] calldata termIds,
    uint256[] calldata curveIds,
    uint256[] calldata amounts
) external payable returns (uint256[] memory);

Parameters

Returns

batchRedeem

redeem shares from an atom vault for assets -- works for atoms, triples and counter-triples

function batchRedeem(uint256 percentage, address receiver, uint256[] calldata ids)
    external
    returns (uint256[] memory);

Parameters

Returns

batchRedeemCurve

redeem shares from bonding curve atom vaults for assets

function batchRedeemCurve(uint256 percentage, address receiver, uint256[] calldata termIds, uint256[] calldata curveIds)
    external
    returns (uint256[] memory);

Parameters

Returns

getAtomCost

returns the cost of creating an atom

function getAtomCost() external view returns (uint256);

Returns

getTripleCost

returns the cost of creating a triple

function getTripleCost() external view returns (uint256);

Returns

getDepositFees

returns the total fees that would be charged for depositing 'assets' into a vault

function getDepositFees(uint256 assets, uint256 id) external view returns (uint256);

Parameters

Returns

getDepositSharesAndFees

returns the shares for recipient and other important values when depositing 'assets' into a vault

function getDepositSharesAndFees(uint256 assets, uint256 id)
    external
    view
    returns (uint256, uint256, uint256, uint256);

Parameters

Returns

getRedeemAssetsAndFees

returns the assets for receiver and other important values when redeeming 'shares' from a vault

function getRedeemAssetsAndFees(uint256 shares, uint256 id)
    external
    view
    returns (uint256, uint256, uint256, uint256);

Parameters

Returns

entryFeeAmount

returns amount of assets that would be charged for the entry fee given an amount of 'assets' provided

function entryFeeAmount(uint256 assets, uint256 id) external view returns (uint256);

Parameters

Returns

exitFeeAmount

returns amount of assets that would be charged for the exit fee given an amount of 'assets' provided

function exitFeeAmount(uint256 assets, uint256 id) external view returns (uint256);

Parameters

Returns

protocolFeeAmount

returns amount of assets that would be charged by a vault on protocol fee given amount of 'assets' provided

function protocolFeeAmount(uint256 assets, uint256 id) external view returns (uint256);

Parameters

Returns

atomDepositsAmount

returns atom deposit given amount of 'assets' provided

function atomDepositsAmount(uint256 assets, uint256 id) external view returns (uint256);

Parameters

Returns

currentSharePrice

returns the current share price for the given vault id

function currentSharePrice(uint256 id) external view returns (uint256);

Parameters

Returns

maxRedeem

returns max amount of shares that can be redeemed from the 'owner' balance through a redeem call

function maxRedeem(address owner, uint256 id) external view returns (uint256);

Parameters

Returns

convertToShares

returns amount of shares that would be exchanged by vault given amount of 'assets' provided

function convertToShares(uint256 assets, uint256 id) external view returns (uint256);

Parameters

Returns

convertToAssets

returns amount of assets that would be exchanged by vault given amount of 'shares' provided

function convertToAssets(uint256 shares, uint256 id) external view returns (uint256);

Parameters

Returns

previewDeposit

simulates the effects of the deposited amount of 'assets' and returns the estimated amount of shares that would be minted from the deposit of assets

function previewDeposit(uint256 assets, uint256 id) external view returns (uint256);

Parameters

Returns

previewRedeem

simulates the effects of the redemption of shares and returns the estimated amount of assets estimated to be returned to the receiver of the redeem

function previewRedeem(uint256 shares, uint256 id) external view returns (uint256);

Parameters

Returns

tripleHash

returns the corresponding hash for the given RDF triple, given the triple vault id

function tripleHash(uint256 id) external view returns (bytes32);

Parameters

Returns

isTripleId

returns whether the supplied vault id is a triple

function isTripleId(uint256 id) external view returns (bool);

Parameters

Returns

getTripleAtoms

returns the atoms that make up a triple/counter-triple

function getTripleAtoms(uint256 id) external view returns (uint256, uint256, uint256);

Parameters

Returns

tripleHashFromAtoms

returns the corresponding hash for the given RDF triple, given the atoms that make up the triple

function tripleHashFromAtoms(uint256 subjectId, uint256 predicateId, uint256 objectId)
    external
    pure
    returns (bytes32);

Parameters

Returns

getCounterIdFromTriple

returns the counter id from the given triple id

function getCounterIdFromTriple(uint256 id) external returns (uint256);

Parameters

Returns

getAtomWarden

returns the address of the atom warden

function getAtomWarden() external view returns (address);

getVaultStateForUser

returns the number of shares and assets (less fees) user has in the vault

function getVaultStateForUser(uint256 vaultId, address receiver) external view returns (uint256, uint256);

Parameters

Returns

getVaultStateForUserCurve

returns the number of shares and assets (less fees) user has in the vault for a specific curve

function getVaultStateForUserCurve(uint256 vaultId, uint256 curveId, address receiver)
    external
    view
    returns (uint256, uint256);

Parameters

Returns

getDepositSharesAndFeesCurve

returns the shares for recipient and other important values when depositing 'assets' into a bonding curve vault

function getDepositSharesAndFeesCurve(uint256 assets, uint256 vaultId, uint256 curveId)
    external
    view
    returns (uint256, uint256, uint256, uint256);

Parameters

Returns

getRedeemAssetsAndFeesCurve

returns the assets for receiver and other important values when redeeming 'shares' from a bonding curve vault

function getRedeemAssetsAndFeesCurve(uint256 shares, uint256 vaultId, uint256 curveId)
    external
    view
    returns (uint256, uint256, uint256, uint256);

Parameters

Returns

currentSharePriceCurve

returns the current share price for the given vault id and curve id

function currentSharePriceCurve(uint256 vaultId, uint256 curveId) external view returns (uint256);

Parameters

Returns

maxDepositCurve

returns max amount of assets that can be deposited into the vault through a deposit call for a specific curve

function maxDepositCurve(uint256 curveId) external view returns (uint256);

Parameters

Returns

maxRedeemCurve

returns max amount of shares that can be redeemed from the 'owner' balance through a redeem call for a specific curve

function maxRedeemCurve(address owner, uint256 vaultId, uint256 curveId) external view returns (uint256);

Parameters

Returns

convertToSharesCurve

returns amount of shares that would be exchanged by vault given amount of 'assets' provided for a specific curve

function convertToSharesCurve(uint256 assets, uint256 vaultId, uint256 curveId) external view returns (uint256);

Parameters

Returns

convertToAssetsCurve

returns amount of assets that would be exchanged by vault given amount of 'shares' provided for a specific curve

function convertToAssetsCurve(uint256 shares, uint256 vaultId, uint256 curveId) external view returns (uint256);

Parameters

Returns

previewDepositCurve

simulates the effects of the deposited amount of 'assets' and returns the estimated amount of shares that would be minted from the deposit of assets for a specific curve

function previewDepositCurve(uint256 assets, uint256 vaultId, uint256 curveId) external view returns (uint256);

Parameters

Returns

previewRedeemCurve

simulates the effects of the redemption of shares and returns the estimated amount of assets estimated to be returned to the receiver of the redeem for a specific curve

function previewRedeemCurve(uint256 shares, uint256 vaultId, uint256 curveId) external view returns (uint256);

Parameters

Returns

computeAtomWalletAddr

returns the Atom Wallet address for the given atom data

function computeAtomWalletAddr(uint256 id) external view returns (address);

Parameters

Returns

isApprovedDeposit

Check if a sender is approved to deposit on behalf of a receiver

function isApprovedDeposit(address sender, address receiver) external view returns (bool);

Parameters

Returns

isApprovedRedeem

Check if a sender is approved to redeem on behalf of a receiver

function isApprovedRedeem(address sender, address receiver) external view returns (bool);

Parameters

Returns

Events

ApprovalTypeUpdated

Emitted when a receiver changes the approval type for a sender

event ApprovalTypeUpdated(address indexed sender, address indexed receiver, ApprovalTypes approvalType);

Parameters

Deposited

Emitted upon the minting of shares in the vault by depositing assets

event Deposited(
    address indexed sender,
    address indexed receiver,
    uint256 receiverTotalSharesInVault,
    uint256 senderAssetsAfterTotalFees,
    uint256 sharesForReceiver,
    uint256 entryFee,
    uint256 vaultId,
    bool isTriple,
    bool isAtomWallet
);

Parameters

DepositedCurve

event DepositedCurve(
    address indexed sender,
    address indexed receiver,
    uint256 receiverTotalSharesInVault,
    uint256 senderAssetsAfterTotalFees,
    uint256 sharesForReceiver,
    uint256 entryFee,
    uint256 vaultId,
    uint256 curveId,
    bool isTriple,
    bool isAtomWallet
);

Redeemed

Emitted upon the withdrawal of assets from the vault by redeeming shares

event Redeemed(
    address indexed sender,
    address indexed receiver,
    uint256 senderTotalSharesInVault,
    uint256 assetsForReceiver,
    uint256 sharesRedeemedBySender,
    uint256 exitFee,
    uint256 vaultId
);

Parameters

RedeemedCurve

event RedeemedCurve(
    address indexed sender,
    address indexed receiver,
    uint256 senderTotalSharesInVault,
    uint256 assetsForReceiver,
    uint256 sharesRedeemedBySender,
    uint256 exitFee,
    uint256 vaultId,
    uint256 curveId
);

AtomCreated

emitted upon creation of an atom

event AtomCreated(address indexed creator, address indexed atomWallet, bytes atomData, uint256 vaultId);

Parameters

TripleCreated

emitted upon creation of a triple

event TripleCreated(address indexed creator, uint256 subjectId, uint256 predicateId, uint256 objectId, uint256 vaultId);

Parameters

FeesTransferred

emitted upon the transfer of fees to the protocol multisig

event FeesTransferred(address indexed sender, address indexed protocolMultisig, uint256 amount);

Parameters

OperationScheduled

emitted upon scheduling an operation

event OperationScheduled(bytes32 indexed operationId, bytes data, uint256 readyTime);

Parameters

OperationExecuted

emitted upon executing an operation

event OperationExecuted(bytes32 indexed operationId, bytes data);

Parameters

OperationCancelled

emitted upon cancelling an operation

event OperationCancelled(bytes32 indexed operationId, bytes data);

Parameters

AdminSet

emitted upon changing the admin

event AdminSet(address indexed newAdmin, address indexed oldAdmin);

Parameters

protocolMultisigSet

emitted upon changing the protocol multisig

event protocolMultisigSet(address indexed newProtocolMultisig, address indexed oldProtocolMultisig);

Parameters

MinDepositSet

emitted upon changing the minimum deposit amount

event MinDepositSet(uint256 newMinDeposit, uint256 oldMinDeposit);

Parameters

MinShareSet

emitted upon changing the minimum share amount

event MinShareSet(uint256 newMinShare, uint256 oldMinShare);

Parameters

AtomUriMaxLengthSet

emitted upon changing the atom URI max length

event AtomUriMaxLengthSet(uint256 newAtomUriMaxLength, uint256 oldAtomUriMaxLength);

Parameters

AtomWalletInitialDepositAmountSet

emitted upon changing the atom share lock fee

event AtomWalletInitialDepositAmountSet(
    uint256 newAtomWalletInitialDepositAmount, uint256 oldAtomWalletInitialDepositAmount
);

Parameters

AtomCreationProtocolFeeSet

emitted upon changing the atom creation fee

event AtomCreationProtocolFeeSet(uint256 newAtomCreationProtocolFee, uint256 oldAtomCreationProtocolFee);

Parameters

TripleCreationProtocolFeeSet

emitted upon changing the triple creation fee

event TripleCreationProtocolFeeSet(uint256 newTripleCreationProtocolFee, uint256 oldTripleCreationProtocolFee);

Parameters

TotalAtomDepositsOnTripleCreationSet

emitted upon changing the atom deposit fraction on triple creation

event TotalAtomDepositsOnTripleCreationSet(
    uint256 newTotalAtomDepositsOnTripleCreation, uint256 oldTotalAtomDepositsOnTripleCreation
);

Parameters

AtomDepositFractionForTripleSet

emitted upon changing the atom deposit fraction for triples

event AtomDepositFractionForTripleSet(uint256 newAtomDepositFractionForTriple, uint256 oldAtomDepositFractionForTriple);

Parameters

BondingCurveConfigSet

emitted upon changing the bonding curve configuration

event BondingCurveConfigSet(
    address indexed newRegistry, uint256 newDefaultCurveId, address indexed oldRegistry, uint256 oldDefaultCurveId
);

Parameters

EntryFeeSet

emitted upon changing the entry fee

event EntryFeeSet(uint256 id, uint256 newEntryFee, uint256 oldEntryFee);

Parameters

ExitFeeSet

emitted upon changing the exit fee

event ExitFeeSet(uint256 id, uint256 newExitFee, uint256 oldExitFee);

Parameters

ProtocolFeeSet

emitted upon changing the protocol fee

event ProtocolFeeSet(uint256 id, uint256 newProtocolFee, uint256 oldProtocolFee);

Parameters

AtomWardenSet

emitted upon changing the atomWarden

event AtomWardenSet(address indexed newAtomWarden, address indexed oldAtomWarden);

Parameters

AtomWalletDeployed

emitted upon deploying an atom wallet

event AtomWalletDeployed(uint256 indexed vaultId, address indexed atomWallet);

Parameters

SharePriceChanged

emitted upon changing the share price of a term base vault

event SharePriceChanged(uint256 indexed termId, uint256 newSharePrice, uint256 totalAssets, uint256 totalShares);

Parameters

SharePriceChangedCurve

emitted upon changing the share price of a curve vault

event SharePriceChangedCurve(
    uint256 indexed termId, uint256 indexed curveId, uint256 newSharePrice, uint256 totalAssets, uint256 totalShares
);

Parameters

Structs

GeneralConfig

General configuration struct

struct GeneralConfig {
    address admin;
    address protocolMultisig;
    uint256 feeDenominator;
    uint256 minDeposit;
    uint256 minShare;
    uint256 atomUriMaxLength;
    uint256 decimalPrecision;
    uint256 minDelay;
}

BondingCurveConfig

struct BondingCurveConfig {
    address registry;
    uint256 defaultCurveId;
}

AtomConfig

Atom configuration struct

struct AtomConfig {
    uint256 atomWalletInitialDepositAmount;
    uint256 atomCreationProtocolFee;
}

TripleConfig

Triple configuration struct

struct TripleConfig {
    uint256 tripleCreationProtocolFee;
    uint256 totalAtomDepositsOnTripleCreation;
    uint256 atomDepositFractionForTriple;
}

WalletConfig

Atom wallet configuration struct

struct WalletConfig {
    IPermit2 permit2;
    address entryPoint;
    address atomWarden;
    address atomWalletBeacon;
}

VaultState

Vault state struct

struct VaultState {
    uint256 totalAssets;
    uint256 totalShares;
    mapping(address account => uint256 balance) balanceOf;
}

VaultFees

Vault fees struct

struct VaultFees {
    uint256 entryFee;
    uint256 exitFee;
    uint256 protocolFee;
}

Timelock

Timelock struct

struct Timelock {
    bytes data;
    uint256 readyTime;
    bool executed;
}

Enums

ApprovalTypes

enum ApprovalTypes {
    NONE,
    DEPOSIT,
    REDEMPTION,
    BOTH
}

IPermit2

Git Source

Functions

permitTransferFrom

Consume a permit2 message and transfer tokens

function permitTransferFrom(
    PermitTransferFrom calldata permit,
    SignatureTransferDetails calldata transferDetails,
    address owner,
    bytes calldata signature
) external;

Parameters

Structs

TokenPermissions

Token and amount in a permit message

struct TokenPermissions {
    IERC20 token;
    uint256 amount;
}

PermitTransferFrom

The permit2 message

struct PermitTransferFrom {
    TokenPermissions permitted;
    uint256 nonce;
    uint256 deadline;
}

SignatureTransferDetails

Transfer details for permitTransferFrom()

struct SignatureTransferDetails {
    address to;
    uint256 requestedAmount;
}

Contents

• Errors

Errors

Git Source

Author: 0xIntuition

Library containing all custom errors detailing cases where the Intuition Protocol may revert.

Errors

EthMultiVault_AdminOnly

error EthMultiVault_AdminOnly();

EthMultiVault_ArraysNotSameLength

error EthMultiVault_ArraysNotSameLength();

EthMultiVault_AtomDoesNotExist

error EthMultiVault_AtomDoesNotExist(uint256 atomId);

EthMultiVault_AtomExists

error EthMultiVault_AtomExists(bytes atomUri, uint256 atomId);

EthMultiVault_AtomUriTooLong

error EthMultiVault_AtomUriTooLong();

EthMultiVault_BurnFromZeroAddress

error EthMultiVault_BurnFromZeroAddress();

EthMultiVault_BurnInsufficientBalance

error EthMultiVault_BurnInsufficientBalance();

EthMultiVault_CannotApproveOrRevokeSelf

error EthMultiVault_CannotApproveOrRevokeSelf();

EthMultiVault_DeployAccountFailed

error EthMultiVault_DeployAccountFailed();

EthMultiVault_DepositOrWithdrawZeroShares

error EthMultiVault_DepositOrWithdrawZeroShares();

EthMultiVault_DepositExceedsMaxAssets

error EthMultiVault_DepositExceedsMaxAssets();

EthMultiVault_HasCounterStake

error EthMultiVault_HasCounterStake();

EthMultiVault_InsufficientBalance

error EthMultiVault_InsufficientBalance();

EthMultiVault_InsufficientDepositAmountToCoverFees

error EthMultiVault_InsufficientDepositAmountToCoverFees();

EthMultiVault_InsufficientRemainingSharesInVault

error EthMultiVault_InsufficientRemainingSharesInVault(uint256 remainingShares);

EthMultiVault_InsufficientSharesInVault

error EthMultiVault_InsufficientSharesInVault();

EthMultiVault_InvalidAtomDepositFractionForTriple

error EthMultiVault_InvalidAtomDepositFractionForTriple();

EthMultiVault_InvalidEntryFee

error EthMultiVault_InvalidEntryFee();

EthMultiVault_InvalidExitFee

error EthMultiVault_InvalidExitFee();

EthMultiVault_InvalidProtocolFee

error EthMultiVault_InvalidProtocolFee();

EthMultiVault_MinimumDeposit

error EthMultiVault_MinimumDeposit();

EthMultiVault_OperationAlreadyExecuted

error EthMultiVault_OperationAlreadyExecuted();

EthMultiVault_OperationAlreadyScheduled

error EthMultiVault_OperationAlreadyScheduled();

EthMultiVault_OperationNotScheduled

error EthMultiVault_OperationNotScheduled();

EthMultiVault_ReceiveNotAllowed

error EthMultiVault_ReceiveNotAllowed();

EthMultiVault_SenderNotApproved

error EthMultiVault_SenderNotApproved();

EthMultiVault_RedeemerNotApproved

error EthMultiVault_RedeemerNotApproved();

EthMultiVault_TimelockNotExpired

error EthMultiVault_TimelockNotExpired();

EthMultiVault_TransferFailed

error EthMultiVault_TransferFailed();

EthMultiVault_TripleExists

error EthMultiVault_TripleExists(uint256 subjectId, uint256 predicateId, uint256 objectId);

EthMultiVault_VaultDoesNotExist

error EthMultiVault_VaultDoesNotExist();

EthMultiVault_VaultIsTriple

error EthMultiVault_VaultIsTriple(uint256 vaultId);

EthMultiVault_VaultNotAtom

error EthMultiVault_VaultNotAtom();

EthMultiVault_VaultNotTriple

error EthMultiVault_VaultNotTriple();

EthMultiVault_InvalidRegistry

error EthMultiVault_InvalidRegistry();

AtomWallet_InvalidCallDataLength

error AtomWallet_InvalidCallDataLength();

AtomWallet_InvalidSignature

error AtomWallet_InvalidSignature();

AtomWallet_InvalidSignatureLength

error AtomWallet_InvalidSignatureLength(uint256 length);

AtomWallet_InvalidSignatureS

error AtomWallet_InvalidSignatureS(bytes32 s);

AtomWallet_OnlyOwner

error AtomWallet_OnlyOwner();

AtomWallet_OnlyOwnerOrEntryPoint

error AtomWallet_OnlyOwnerOrEntryPoint();

AtomWallet_WrongArrayLengths

error AtomWallet_WrongArrayLengths();

CustomMulticall3_InsufficientValue

error CustomMulticall3_InsufficientValue();

CustomMulticall3_InvalidAtomIdsLength

error CustomMulticall3_InvalidAtomIdsLength();

CustomMulticall3_InvalidAtomUrisLength

error CustomMulticall3_InvalidAtomUrisLength();

CustomMulticall3_InvalidEthMultiVaultAddress

error CustomMulticall3_InvalidEthMultiVaultAddress();

CustomMulticall3_InvalidValue

error CustomMulticall3_InvalidValue();

CustomMulticall3_InvalidValuesLength

error CustomMulticall3_InvalidValuesLength();

CustomMulticall3_ZeroLengthArray

error CustomMulticall3_ZeroLengthArray();

Attestoor_DeployAttestoorFailed

error Attestoor_DeployAttestoorFailed();

Attestoor_EmptyAttestorsArray

error Attestoor_EmptyAttestorsArray();

Attestoor_InsufficientValue

error Attestoor_InsufficientValue();

Attestoor_InvalidEthMultiVaultAddress

error Attestoor_InvalidEthMultiVaultAddress();

Attestoor_NotAWhitelistedAttestor

error Attestoor_NotAWhitelistedAttestor();

Attestoor_SharesCannotBeRedeeemed

error Attestoor_SharesCannotBeRedeeemed();

Attestoor_WrongArrayLengths

error Attestoor_WrongArrayLengths();

BondingCurveRegistry_CurveAlreadyExists

error BondingCurveRegistry_CurveAlreadyExists();

BondingCurveRegistry_CurveNameNotUnique

error BondingCurveRegistry_CurveNameNotUnique();

BondingCurveRegistry_OnlyOwner

error BondingCurveRegistry_OnlyOwner();

BondingCurveRegistry_RequiresOwner

error BondingCurveRegistry_RequiresOwner();

BaseCurve_EmptyStringNotAllowed

error BaseCurve_EmptyStringNotAllowed();

AtomWallet

Git Source

Inherits: Initializable, BaseAccount, Ownable2StepUpgradeable, ReentrancyGuardUpgradeable

Author: 0xIntuition

Core contract of the Intuition protocol. This contract is an abstract account associated with a corresponding atom.

State Variables

ethMultiVault

The EthMultiVault contract address

IEthMultiVault public ethMultiVault;

isClaimed

The flag to indicate if the wallet's ownership has been claimed by the user

bool public isClaimed;

AtomWalletOwnerStorageLocation

The storage slot for the AtomWallet owner

bytes32 private constant AtomWalletOwnerStorageLocation =
    0x9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300;

AtomWalletPendingOwnerStorageLocation

The storage slot for the AtomWallet pending owner

bytes32 private constant AtomWalletPendingOwnerStorageLocation =
    0x237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c00;

_entryPoint

The entry point contract address

IEntryPoint private _entryPoint;

__gap

Gap for upgrade safety

uint256[50] private __gap;

Functions

onlyOwnerOrEntryPoint

Modifier to allow only the owner or entry point to call a function

modifier onlyOwnerOrEntryPoint();

init

Initialize the AtomWallet contract

function init(IEntryPoint anEntryPoint, IEthMultiVault _ethMultiVault) external initializer;

Parameters

receive

receive() external payable;

execute

function execute(address dest, uint256 value, bytes calldata func)
    external
    payable
    onlyOwnerOrEntryPoint
    nonReentrant;

Parameters

executeBatch

Execute a sequence (batch) of transactions

function executeBatch(address[] calldata dest, uint256[] calldata values, bytes[] calldata func)
    external
    payable
    onlyOwnerOrEntryPoint
    nonReentrant;

Parameters

addDeposit

Add deposit to the account in the entry point contract

function addDeposit() public payable;

withdrawDepositTo

Withdraws value from the account's deposit

function withdrawDepositTo(address payable withdrawAddress, uint256 amount) public;

Parameters

transferOwnership

Initiates the ownership transfer over the wallet to a new owner.

function transferOwnership(address newOwner) public override onlyOwner;

Parameters

acceptOwnership

The new owner accepts the ownership over the wallet. If the wallet's ownership is being accepted by the user, the wallet is considered claimed. Once claimed, wallet is considered owned by the user and this action cannot be undone. NOTE: Overrides the acceptOwnership function of Ownable2StepUpgradeable

function acceptOwnership() public override;

getDeposit

Returns the deposit of the account in the entry point contract

function getDeposit() public view returns (uint256);

entryPoint

Get the entry point contract address

function entryPoint() public view virtual override returns (IEntryPoint);

Returns

owner

Returns the owner of the wallet. If the wallet has been claimed, the owner is the user. Otherwise, the owner is the atomWarden.

function owner() public view override returns (address);

Returns

_validateSignature

Validate the signature of the user operation

function _validateSignature(UserOperation calldata userOp, bytes32 userOpHash)
    internal
    virtual
    override
    returns (uint256 validationData);

Parameters

Returns

_call

An internal method that calls a target address with value and data

function _call(address target, uint256 value, bytes memory data) internal;

Parameters

extractValidUntilAndValidAfter

Extract the validUntil and validAfter from the call data

function extractValidUntilAndValidAfter(bytes calldata callData)
    internal
    pure
    returns (uint256 validUntil, uint256 validAfter, bytes memory actualCallData);

Parameters

Returns

_getAtomWalletOwnerStorage

Get the storage slot for the AtomWallet contract owner

function _getAtomWalletOwnerStorage() private pure returns (OwnableStorage storage $);

Returns

_getAtomWalletPendingOwnerStorage

Get the storage slot for the AtomWallet contract pending owner

function _getAtomWalletPendingOwnerStorage() private pure returns (Ownable2StepStorage storage $);

Returns

BaseCurve

Git Source

Inherits: IBaseCurve

Author: 0xIntuition

Abstract contract for a bonding curve. Defines the interface for converting assets to shares and vice versa.

This contract is designed to be inherited by other bonding curve contracts, providing a common interface for converting between assets and shares.

These curves handle the pure mathematical relationship for share price. Pool ratio adjustments (such as accomodating for the effect of fees, supply burn, airdrops, etc) are handled by the EthMultiVault instead of the curves themselves.

State Variables

name

The name of the curve

string public name;

Functions

constructor

Construct the curve with a unique name

constructor(string memory _name);

Parameters

maxShares

The maximum number of shares that this curve can handle without overflowing.

Checked by the EthMultiVault before transacting

function maxShares() external view virtual returns (uint256);

maxAssets

The maximum number of assets that this curve can handle without overflowing.

Checked by the EthMultiVault before transacting

function maxAssets() external view virtual returns (uint256);

previewDeposit

Preview how many shares would be minted for a deposit of assets

function previewDeposit(uint256 assets, uint256 totalAssets, uint256 totalShares)
    external
    view
    virtual
    returns (uint256 shares);

Parameters

Returns

previewMint

Preview how many assets would be required to mint a specific amount of shares

function previewMint(uint256 shares, uint256 totalShares, uint256 totalAssets)
    external
    view
    virtual
    returns (uint256 assets);

Parameters

Returns

previewWithdraw

Preview how many shares would be redeemed for a withdrawal of assets

function previewWithdraw(uint256 assets, uint256 totalAssets, uint256 totalShares)
    external
    view
    virtual
    returns (uint256 shares);

Parameters

Returns

previewRedeem

Preview how many assets would be returned for burning a specific amount of shares

function previewRedeem(uint256 shares, uint256 totalShares, uint256 totalAssets)
    external
    view
    virtual
    returns (uint256 assets);

Parameters

Returns

convertToShares

Convert assets to shares at a specific point on the curve

function convertToShares(uint256 assets, uint256 totalAssets, uint256 totalShares)
    external
    view
    virtual
    returns (uint256 shares);

Parameters

Returns

convertToAssets

Convert shares to assets at a specific point on the curve

function convertToAssets(uint256 shares, uint256 totalShares, uint256 totalAssets)
    external
    view
    virtual
    returns (uint256 assets);

Parameters

Returns

currentPrice

Get the current price of a share

function currentPrice(uint256 totalShares) public view virtual returns (uint256 sharePrice);

Parameters

Returns

BondingCurveRegistry

Git Source

Inherits: IBondingCurveRegistry

Author: 0xIntuition

Registry contract for the Intuition protocol Bonding Curves. Routes access to the curves associated with atoms & triples. Does not maintain any economic state -- this merely performs computations based on the provided economic state.

An administrator may add new bonding curves to this registry, including those submitted by community members, once they are verified to be safe, and conform to the BaseCurve interface. The EthMultiVault supports a growing registry of curves, with each curve supplying a new "vault" for each term (atom or triple).

The registry is responsible for interacting with the curves, to fetch the mathematical computations given the provided economic state and the desired curve implementation. You can think of the registry as a concierge the EthMultiVault uses to access various economic incentive patterns.

State Variables

count

uint256 public count;

curveAddresses

mapping(uint256 => address) public curveAddresses;

curveIds

mapping(address => uint256) public curveIds;

registeredCurveNames

mapping(string => bool) public registeredCurveNames;

admin

address public admin;

Functions

constructor

Constructor for the BondingCurveRegistry contract

constructor(address _admin);

Parameters

addBondingCurve

Add a new bonding curve to the registry

function addBondingCurve(address bondingCurve) external;

Parameters

transferOwnership

Transfer the admin role to a new address

function transferOwnership(address newOwner) external;

Parameters

previewDeposit

Preview how many shares would be minted for a deposit of assets

function previewDeposit(uint256 assets, uint256 totalAssets, uint256 totalShares, uint256 id)
    external
    view
    returns (uint256 shares);

Parameters

Returns

previewRedeem

Preview how many assets would be returned for burning a specific amount of shares

function previewRedeem(uint256 shares, uint256 totalShares, uint256 totalAssets, uint256 id)
    external
    view
    returns (uint256 assets);

Parameters

Returns

previewWithdraw

Preview how many shares would be redeemed for a withdrawal of assets

function previewWithdraw(uint256 assets, uint256 totalAssets, uint256 totalShares, uint256 id)
    external
    view
    returns (uint256 shares);

Parameters

Returns

previewMint

Preview how many assets would be required to mint a specific amount of shares

function previewMint(uint256 shares, uint256 totalShares, uint256 totalAssets, uint256 id)
    external
    view
    returns (uint256 assets);

Parameters

Returns

convertToShares

Convert assets to shares at a specific point on the curve

function convertToShares(uint256 assets, uint256 totalAssets, uint256 totalShares, uint256 id)
    external
    view
    returns (uint256 shares);

Parameters

Returns

convertToAssets

Convert shares to assets at a specific point on the curve

function convertToAssets(uint256 shares, uint256 totalShares, uint256 totalAssets, uint256 id)
    external
    view
    returns (uint256 assets);

Parameters

Returns

currentPrice

Get the current price of a share

function currentPrice(uint256 totalShares, uint256 id) external view returns (uint256 sharePrice);

Parameters

Returns

getCurveName

Get the name of a curve

function getCurveName(uint256 id) external view returns (string memory name);

Parameters

Returns

getCurveMaxShares

Get the maximum number of shares a curve can handle. Curves compute this ceiling based on their constructor arguments, to avoid overflow.

function getCurveMaxShares(uint256 id) external view returns (uint256 maxShares);

Parameters

Returns

getCurveMaxAssets

Get the maximum number of assets a curve can handle. Curves compute this ceiling based on their constructor arguments, to avoid overflow.

function getCurveMaxAssets(uint256 id) external view returns (uint256 maxAssets);

Parameters

Returns

Events

BondingCurveAdded

Emitted when a new curve is added to the registry

event BondingCurveAdded(uint256 indexed curveId, address indexed curveAddress, string indexed curveName);

Parameters

OwnershipTransferred

Emitted when the admin role is transferred

event OwnershipTransferred(address indexed oldAdmin, address indexed newAdmin);

Parameters

EthMultiVault

Git Source

Inherits: IEthMultiVault, Initializable, ReentrancyGuardUpgradeable, PausableUpgradeable

Author: 0xIntuition

Core contract of the Intuition protocol. Manages the creation and management of vaults associated with atoms & triples.

A sophisticated vault management system that implements a dual-layer semantic data structure through "atoms" and "triples", reminiscent of RDF (Resource Description Framework) concepts.

Core protocol component managing the relationship between semantic data structures and their economic representations through vault mechanics. Implements ERC4626-style accounting with progressive bonding curves.

Key Components:

1. Vault Management

• ETH deposits/withdrawals through ERC4626-style vault accounting
• Progressive bonding curves for price discovery
• Supports both standard pro-rata vaults and curve-specific vaults, for backwards compatibility.

2. Semantic Structure

• Atoms: Base-level vaults representing individual semantic units
• Triples: Composite vaults linking three atoms in subject-predicate-object relationships
• Each vault type maintains independent state and fee structures

3. Security Features

• Timelocked admin operations
• Reentrancy protection
• Pausable functionality
• Granular fee controls with maximum caps
• Approval system for delegated deposits

4. Smart Account Integration

• Deploys ERC4337-compatible atom wallets
• BeaconProxy pattern for upgradeable wallet implementations
• Maintains initialization deposits for wallet operations

5. Fee Structure

• Entry, exit, and protocol fees
• Configurable per vault
• Separate fee structures for atom/triple creation
• Proportional deposit distribution for triple-related operations

## Please note: This implementation of the EthMultiVault is messy for a reason. We wanted to keep all of the audited code in place, while also enabling users to interact with Bonding Curve vaults. For this reason, there are separate functions for all Bonding Curve related activity. While this bloats the code size, it ensures that users can still use the audited pathways in the code if they wish, while also enabling them to engage in more economically exciting activities like the Progressive Curve or Offset Curve.

The V2 of this contract will merge these pathways into one, providing a cleaner and more straightforward interface for depositing and redeeming.

State Variables

SET_ADMIN

bytes32 public constant SET_ADMIN = keccak256("setAdmin");

SET_EXIT_FEE

bytes32 public constant SET_EXIT_FEE = keccak256("setExitFee");

generalConfig

Configuration structs

GeneralConfig public generalConfig;

atomConfig

AtomConfig public atomConfig;

tripleConfig

TripleConfig public tripleConfig;

walletConfig

WalletConfig public walletConfig;

count

ID of the last vault to be created

uint256 public count;

vaults

Mapping of vault ID to vault state

mapping(uint256 vaultId => VaultState vaultState) public vaults;

vaultFees

Mapping of vault ID to vault fees

mapping(uint256 vaultId => VaultFees vaultFees) public vaultFees;

approvals

Mapping of receiver to sender to determine if a sender is allowed to deposit assets on behalf of a receiver

mapping(address receiver => mapping(address sender => uint8 approvalType)) public approvals;

atoms

RDF (Resource Description Framework)

mapping(uint256 atomId => bytes atomData) public atoms;

atomsByHash

mapping(bytes32 atomHash => uint256 atomId) public atomsByHash;

triples

mapping(uint256 tripleId => uint256[3] tripleAtomIds) public triples;

triplesByHash

mapping(bytes32 tripleHash => uint256 tripleId) public triplesByHash;

isTriple

mapping(uint256 vaultId => bool isTriple) public isTriple;

timelocks

Timelock mapping (operation hash -> timelock struct)

mapping(bytes32 operationHash => Timelock timelock) public timelocks;

bondingCurveVaults

Bonding Curve Vaults (termId -> curveId -> vaultState)

mapping(uint256 vaultId => mapping(uint256 curveId => VaultState vaultState)) public bondingCurveVaults;

bondingCurveConfig

Bonding Curve Configurations

BondingCurveConfig public bondingCurveConfig;

__gap

Gap for upgrade safety

uint256[47] private __gap;

Functions

onlyAdmin

Modifier to restrict a function to the admin

modifier onlyAdmin();

init

Initializes the EthMultiVault contract

This function is called only once (during contract deployment)

function init(
    GeneralConfig memory _generalConfig,
    AtomConfig memory _atomConfig,
    TripleConfig memory _tripleConfig,
    WalletConfig memory _walletConfig,
    VaultFees memory _defaultVaultFees,
    BondingCurveConfig memory _bondingCurveConfig
) external initializer;

Parameters

reinitialize

Reinitializes the EthMultiVault contract during an upgrade

This function can only be called once during a version upgrade

function reinitialize(BondingCurveConfig memory _bondingCurveConfig) external reinitializer(2);

Parameters

constructor

Security measure for upgradeable contracts

Disables initializers on implementation contract to prevent direct initialization

(Security) Prevents attackers from initializing the implementation contract directly

constructor();

receive

contract does not accept ETH donations

receive() external payable;

fallback

fallback function to decompress the calldata and call the appropriate function

fallback() external payable;

pause

pauses the pausable contract methods

function pause() external onlyAdmin;

unpause

unpauses the pausable contract methods

function unpause() external onlyAdmin;

scheduleOperation

schedule an operation to be executed after a delay

function scheduleOperation(bytes32 operationId, bytes calldata data) external onlyAdmin;

Parameters

cancelOperation

cancel a scheduled operation

function cancelOperation(bytes32 operationId, bytes calldata data) external onlyAdmin;

Parameters

setAdmin

Requires new admin to 'confirm' the timelocked operation

set admin

function setAdmin(address admin) external;

Parameters

setProtocolMultisig

set protocol multisig

function setProtocolMultisig(address protocolMultisig) external onlyAdmin;

Parameters

setMinDeposit

sets the minimum deposit amount for atoms and triples

function setMinDeposit(uint256 minDeposit) external onlyAdmin;

Parameters

setMinShare

sets the minimum share amount for atoms and triples

function setMinShare(uint256 minShare) external onlyAdmin;

Parameters

setAtomUriMaxLength

sets the atom URI max length

function setAtomUriMaxLength(uint256 atomUriMaxLength) external onlyAdmin;

Parameters

setAtomWalletInitialDepositAmount

sets the atom share lock fee

function setAtomWalletInitialDepositAmount(uint256 atomWalletInitialDepositAmount) external onlyAdmin;

Parameters

setAtomCreationProtocolFee

sets the atom creation fee

function setAtomCreationProtocolFee(uint256 atomCreationProtocolFee) external onlyAdmin;

Parameters

setTripleCreationProtocolFee

sets fee charged in wei when creating a triple to protocol multisig

function setTripleCreationProtocolFee(uint256 tripleCreationProtocolFee) external onlyAdmin;

Parameters

setTotalAtomDepositsOnTripleCreation

sets the atom deposit on triple creation used to increase the amount of assets in the underlying atom vaults on triple creation

function setTotalAtomDepositsOnTripleCreation(uint256 totalAtomDepositsOnTripleCreation) external onlyAdmin;

Parameters

setAtomDepositFractionForTriple

sets the atom deposit percentage for atoms used in triples (number to be divided by generalConfig.feeDenominator)

function setAtomDepositFractionForTriple(uint256 atomDepositFractionForTriple) external onlyAdmin;

Parameters

setEntryFee

sets entry fees for the specified vault (id=0 sets the default fees for all vaults) id = 0 changes the default entry fee, id = n changes fees for vault n specifically

admin cannot set the entry fee to be greater than maxEntryFeePercentage, which is set to be the 10% of generalConfig.feeDenominator (which represents 100%), to avoid being able to prevent users from depositing assets with unreasonable fees

function setEntryFee(uint256 id, uint256 entryFee) external onlyAdmin;

Parameters

setExitFee

sets exit fees for the specified vault (id=0 sets the default fees for all vaults) id = 0 changes the default exit fee, id = n changes fees for vault n specifically

admin cannot set the exit fee to be greater than maxExitFeePercentage, which is set to be the 10% of generalConfig.feeDenominator (which represents 100%), to avoid being able to prevent users from withdrawing their assets

function setExitFee(uint256 id, uint256 exitFee) external onlyAdmin;

Parameters

setProtocolFee

sets protocol fees for the specified vault (id=0 sets the default fees for all vaults) id = 0 changes the default protocol fee, id = n changes fees for vault n specifically

admin cannot set the protocol fee to be greater than maxProtocolFeePercentage, which is set to be the 10% of generalConfig.feeDenominator (which represents 100%), to avoid being able to prevent users from depositing or withdrawing their assets with unreasonable fees

function setProtocolFee(uint256 id, uint256 protocolFee) external onlyAdmin;

Parameters

setAtomWarden

sets the atomWarden address

function setAtomWarden(address atomWarden) external onlyAdmin;

Parameters

setBondingCurveConfig

Sets the bonding curve configuration

function setBondingCurveConfig(address newRegistry, uint256 _defaultCurveId) external onlyAdmin;

Parameters

deployAtomWallet

deploy a given atom wallet

deploys an ERC4337 account (atom wallet) through a BeaconProxy. Reverts if the atom vault does not exist

function deployAtomWallet(uint256 atomId) external whenNotPaused returns (address);

Parameters

Returns

approve

Set the approval type for a sender to act on behalf of the receiver

function approve(address sender, ApprovalTypes approvalType) external;

Parameters

createAtom

Create an atom and return its vault id

This function will revert if called with less than getAtomCost() in msg.value

function createAtom(bytes calldata atomUri) external payable nonReentrant whenNotPaused returns (uint256);

Parameters

Returns

batchCreateAtom

Batch create atoms and return their vault ids

This function will revert if called with less than getAtomCost() * atomUris.length in msg.value

function batchCreateAtom(bytes[] calldata atomUris)
    external
    payable
    nonReentrant
    whenNotPaused
    returns (uint256[] memory);

Parameters

Returns

_createAtom

Internal utility function to create an atom and handle vault creation

function _createAtom(bytes calldata atomUri, uint256 value) internal returns (uint256, uint256);

Parameters

Returns

createTriple

create a triple and return its vault id

This function will revert if called with less than getTripleCost() in msg.value. This function will revert if any of the atoms do not exist or if any ids are triple vaults.

function createTriple(uint256 subjectId, uint256 predicateId, uint256 objectId)
    external
    payable
    nonReentrant
    whenNotPaused
    returns (uint256);

Parameters

Returns

batchCreateTriple

batch create triples and return their vault ids

This function will revert if called with less than getTripleCost() * array.length in msg.value. This function will revert if any of the atoms do not exist or if any ids are triple vaults.

function batchCreateTriple(uint256[] calldata subjectIds, uint256[] calldata predicateIds, uint256[] calldata objectIds)
    external
    payable
    nonReentrant
    whenNotPaused
    returns (uint256[] memory);

Parameters

_createTriple

Internal utility function to create a triple

function _createTriple(uint256 subjectId, uint256 predicateId, uint256 objectId, uint256 value)
    internal
    returns (uint256, uint256);

Parameters

Returns

depositAtom

deposit eth into an atom vault and grant ownership of 'shares' to 'reciever' *payable msg.value amount of eth to deposit

assets parameter is omitted in favor of msg.value, unlike in ERC4626

this function will revert if the minimum deposit amount of eth is not met and if the vault ID does not exist/is not an atom.

function depositAtom(address receiver, uint256 id) external payable nonReentrant whenNotPaused returns (uint256);

Parameters

Returns

depositAtomCurve

deposit eth into an atom vault and grant ownership of 'shares' to 'reciever' *payable msg.value amount of eth to deposit

assets parameter is omitted in favor of msg.value, unlike in ERC4626

this function will revert if the minimum deposit amount of eth is not met and if the vault ID does not exist/is not an atom.

This method is entirely separate from depositAtom, because we wanted to leave the audited pathways intact. This serves as an intermediary solution to enable users to interact with bonding curve vaults before performing an audit of the full refactor (V2).

function depositAtomCurve(address receiver, uint256 atomId, uint256 curveId)
    external
    payable
    nonReentrant
    whenNotPaused
    returns (uint256);

Parameters

Returns

redeemAtom

redeem shares from an atom vault for assets

Emergency redemptions without any fees being charged are always possible, even if the contract is paused See getRedeemAssetsAndFees for more details on the fees charged

function redeemAtom(uint256 shares, address receiver, uint256 id) external nonReentrant returns (uint256);

Parameters