Initial commit

Author: hayesgm

.github/workflows/deploy.yml

@@ -0,0 +1,45 @@
+name: Deploy Sleuth [Mainnet]
+
+on:
+  workflow_dispatch:
+    inputs:
+      deployer_address:
+        description: WalletConnect address to deploy from
+        required: true
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Deploy Sleuth [Mainnet]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Start Seacrest
+        uses: hayesgm/seacrest@v1
+        with:
+          ethereum_url: "${{ secrets.ETH_MAINNET_URL }}"
+
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Forge build
+        run: |
+          forge --version
+          forge build --sizes
+
+      - name: Forge Deploy Sleuth [Mainnet]
+        run: script/mainnet/deploy.sh
+        env:
+          ETHERSCAN_API_KEY: "${{ secrets.ETHERSCAN_API_KEY }}"
+          ETH_FROM: "${{ inputs.deployer_address }}"
+          RPC_URL: "http://localhost:8585"

.gitignore

@@ -9,3 +9,6 @@ out/
 
 # Dotenv file
 .env
+dist
+node_modules
+yarn-error.log

README.md

@@ -0,0 +1,73 @@
+# Sleuth
+
+<img src="https://github.com/compound-finance/sleuth/raw/main/logo.png" width="100">
+
+----
+
+Sleuth is an easy way to pull data from an EVM-compatible blockchain, allowing for complex queries, similar to an ethers-multicall. Sleuth works by deploying a smart contract and then invoking it in an `eth_call`. This allows you to use complex logic to pull data from many contracts or other items such as `eth_chainId` or `eth_blockNumber`, which you can use for data analysis or in your Web3 front-end. For example:
+
+**MyQuery.sol** [Note: this is not deployed, and is never deployed]
+```sol
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.16;
+
+contract BlockNumber {
+    function query() external view returns (uint256) {
+        return block.number;
+    }
+}
+```
+
+**MyView.ts**
+```ts
+import { Sleuth } from '@compound-finance/sleuth';
+
+let sleuth = new Sleuth(provider);
+
+let blockNumber = await sleuth.query(fs.readFileSync('./MyQuery.sol', 'utf8'));
+```
+
+## Getting Started
+
+Install Sleuth:
+
+```
+yarn add @compound-finance/sleuth
+
+# npm install --save @compound-finance/sleuth
+```
+
+Next, simply build a Solidity file and build Sleuth, as above, to execute the query. E.g.
+
+```ts
+import { Sleuth } from '@compound-finance/sleuth';
+
+let sleuth = new Sleuth(provider);
+
+let [name, age] = await sleuth.query(`
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.16;
+
+contract SimpleQuery {
+    function query() external pure returns (uint256, string memory) {
+        return (55, "Bob Jones");
+    }
+}
+`);
+```
+
+## Future Considerations
+
+Instead of having users build solidity files, it might be nice to build a proper query language. This could be SQL-like or ORM-style or anything that compiles to say Yul (the intermediate representation used by Solidity). We could then abstract the interface to something interesting, such as:
+
+```ts
+await sleuth.query("SELECT comet.name FROM comet(0xc3...) WHERE comet.id = 5");
+```
+
+There's so much we could do here and it sounds really fun!
+
+## License
+
+MIT
+
+Copyright 2022, Compound Labs, Inc. Geoffrey Hayes.

cli/sleuth.ts

@@ -0,0 +1,80 @@
+const solc = require('solc');
+import { Provider } from '@ethersproject/providers';
+import { Contract } from '@ethersproject/contracts';
+import { AbiCoder } from '@ethersproject/abi';
+import { keccak256 } from '@ethersproject/keccak256';
+import { getContractAddress } from '@ethersproject/address';
+
+interface Opts {
+  network?: string,
+  version?: number
+};
+
+const defaultOpts = {
+  network: 'mainnet',
+  version: 1
+};
+
+const sleuthDeployer = process.env['SLEUTH_ADDRESS'] ?? '0x84C3e20985d9E7aEc46F80d2EB52b731D8CC40F8';
+
+export class Sleuth {
+  provider: Provider;
+  network: string;
+  version: number;
+  sleuthAddr: string;
+
+  constructor(provider: Provider, opts: Opts = {}) {
+    this.provider = provider;
+    this.network = opts.network ?? defaultOpts.network;
+    this.version = opts.version ?? defaultOpts.version;
+    this.sleuthAddr = getContractAddress({ from: sleuthDeployer, nonce: this.version - 1 });
+    console.log('Sleuth address', this.sleuthAddr);
+  }
+
+  async query(q: string) {
+    const input = {
+      language: 'Solidity',
+      sources: {
+        'query.sol': {
+          content: q
+        }
+      },
+      settings: {
+        outputSelection: {
+          '*': {
+            '*': ['*']
+          }
+        }
+      }
+    };
+
+    let result = JSON.parse(solc.compile(JSON.stringify(input)));
+    if (result.errors) {
+      throw new Error("Compilation Error: " + JSON.stringify(result.errors));
+    }
+    let contract = result.contracts['query.sol'];
+    if (!contract) {
+      throw new Error(`Missing query.sol compiled contract in ${JSON.stringify(Object.keys(result.contracts))}`);
+    }
+    let c = Object.values(contract)[0] as any;
+    if (!c) {
+      throw new Error(`Query does not contain any contract definitions`);
+    } else if (Object.keys(contract).length > 1) {
+      console.warn(`Query contains multiple contracts, using ${Object.keys(contract)[0]}`);
+    }
+    let b = c.evm.bytecode.object;
+    let abi = c.abi;
+    let queryAbi = abi.find(({type, name}: any) => type === 'function' && name === 'query');
+    if (!queryAbi) {
+      throw new Error(`Query must include function \`query()\``);
+    }
+    let sleuthCtx = new Contract(this.sleuthAddr, ['function query(bytes) public view returns (bytes)'], this.provider);
+    let queryResult = await sleuthCtx.query('0x' + b);
+    let res = new AbiCoder().decode(queryAbi.outputs, queryResult);
+    if (res.length === 1) {
+      return res[0]
+    } else {
+      return res;
+    }
+  }
+}

cli/test/client.test.ts

@@ -0,0 +1,25 @@
+import { Sleuth } from '../sleuth';
+import { Provider, JsonRpcProvider } from '@ethersproject/providers';
+import * as fs from 'fs/promises';
+import * as path from 'path';
+
+describe('testing sleuthing', () => {
+  let provider: Provider;
+
+  beforeAll(() => {
+    provider = new JsonRpcProvider('http://127.0.0.1:8599');
+  });
+
+  test('should return the block number', async () => {
+    let sleuth = new Sleuth(provider);
+    let res = await sleuth.query(await fs.readFile(path.join(__dirname, '../../src/examples/BlockNumber.sol'), 'utf8'));
+    expect(res.toNumber()).toBe(1);
+  });
+
+  test('should return the pair', async () => {
+    let sleuth = new Sleuth(provider);
+    let res = await sleuth.query(await fs.readFile(path.join(__dirname, '../../src/examples/Pair.sol'), 'utf8'));
+    expect(res[0].toNumber()).toBe(55);
+    expect(res[1]).toEqual("hello");
+  });
+});

foundry.toml

@@ -2,5 +2,6 @@
 src = 'src'
 out = 'out'
 libs = ['lib']
+fs_permissions = [{ access = "read", path = "./out"}]
 
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config

jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  transform: {'^.+\\.ts?$': 'ts-jest'},
+  testEnvironment: 'node',
+  testRegex: 'cli/test/.*\\.(test|spec)?\\.(ts|tsx)$',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node']
+};

logo.png

@@ -0,0 +1,22 @@
+{
+  "name": "sleuth",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "repository": "https://github.com/compound-finance/sleuth",
+  "author": "Geoffrey Hayes <hayesgm@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "test": "jest"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.2.4",
+    "jest": "^29.3.1",
+    "ts-jest": "^29.0.3",
+    "typescript": "^4.9.4"
+  },
+  "dependencies": {
+    "@ethersproject/contracts": "^5.7.0",
+    "@ethersproject/providers": "^5.7.2",
+    "solc": "^0.8.17"
+  }
+}

package.json

@@ -3,7 +3,7 @@ pragma solidity ^0.8.13;
 
 import "forge-std/Script.sol";
 
-contract CounterScript is Script {
+contract SleuthScript is Script {
     function setUp() public {}
 
     function run() public {

script/Counter.s.sol script/Sleuth.s.sol

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+set -exo pipefail
+
+if [ -n "$ETHEREUM_PK" ]; then
+  wallet_args="--private-key $ETHEREUM_PK"
+else
+  wallet_args="--unlocked"
+fi
+
+if [ -n "$RPC_URL" ]; then
+  rpc_args="--rpc-url $RPC_URL"
+else
+  rpc_args=""
+fi
+
+if [ -n "$ETHERSCAN_API_KEY" ]; then
+  etherscan_args="--verify --etherscan-api-key $ETHERSCAN_API_KEY"
+else
+  etherscan_args=""
+fi
+
+forge create \
+  $rpc_args \
+  $etherscan_args \
+  $wallet_args \
+  $@ \
+  src/Sleuth.sol:Sleuth

script/mainnet/deploy.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+set -exo pipefail
+
+anvil --port 8599 &
+anvil_pid="$!"
+sleep 3
+
+if kill -0 "$anvil_pid"; then
+  echo "anvil running"
+else
+  echo "anvil failed"
+  wait "$anvil_pid"
+fi
+
+while ! nc -z localhost 8599; do
+  sleep 3
+done
+
+function cleanup {
+  kill "$anvil_pid"
+}
+
+trap cleanup EXIT
+
+forge build
+forge create --rpc-url http://localhost:8599 --private-key 0x2a871d0798f97d79848a013d4936a73bf4cc922c825d33c1cf7073dff6d409c6 src/Sleuth.sol:Sleuth
+
+SLEUTH_DEPLOYER=0xa0ee7a142d267c1f36714e4a8f75612f20a79720 yarn test

script/test.sh

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.16;
+
+contract Sleuth {
+
+    function query(bytes calldata q) external returns (bytes memory) {
+        return queryInternal(q, abi.encodeWithSignature("query()"));
+    }
+
+    function query(bytes calldata q, bytes memory c) external returns (bytes memory) {
+        return queryInternal(q, c);
+    }
+
+    function queryInternal(bytes memory q, bytes memory c) internal returns (bytes memory) {
+        assembly {
+            let queryLen := mload(q)
+            let queryStart := add(q, 0x20)
+            let deployment := create(0, queryStart, queryLen)
+            let callLen := mload(c)
+            let callStart := add(c, 0x20)
+            pop(call(gas(), deployment, 0, callStart, callLen, 0xc0, 0))
+            returndatacopy(0xc0, 0, returndatasize())
+            mstore(0x80, 0x20)
+            mstore(0xa0, returndatasize())
+            let sz := add(returndatasize(), 0x40)
+            return(0x80, sz)
+        }
+    }
+}

src/Counter.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.16;
+
+contract BlockNumber {
+    function query() external view returns (uint256) {
+        return block.number;
+    }
+}