@sentio/cli 2.4.0 → 2.5.0-rc.2

package/src/abi.ts

@@ -0,0 +1,150 @@
+import { AptosClient } from 'aptos-sdk'
+import { JsonRpcProvider } from '@mysten/sui.js'
+import { CHAIN_IDS } from './chain.js'
+import chalk from 'chalk'
+import process from 'process'
+import path from 'path'
+import fs from 'fs-extra'
+// @ts-ignore no types
+import { init } from 'etherscan-api'
+
+export async function getABI(
+  chain: string,
+  address: string,
+  name: string | undefined
+): Promise<{ name?: string; abi: object | string }> {
+  let ethApi
+  let aptosClient: AptosClient | undefined
+  let suiClient: JsonRpcProvider | undefined
+
+  switch (chain) {
+    case CHAIN_IDS.APTOS_MAINNET:
+      aptosClient = new AptosClient('https://mainnet.aptoslabs.com/')
+      break
+    case CHAIN_IDS.APTOS_TESTNET:
+      aptosClient = new AptosClient('https://testnet.aptoslabs.com/')
+      break
+    case CHAIN_IDS.SUI_MAINNET:
+      throw Error('SUI mainnet is not support yet, try sui/testnet')
+    // suiClient = new JsonRpcProvider('https://fullnode.mainnet.sui.io/')
+    // break
+    case CHAIN_IDS.SUI_TESTNET:
+      suiClient = new JsonRpcProvider('https://fullnode.testnet.sui.io/')
+      break
+    case CHAIN_IDS.ETHEREUM:
+      ethApi = init()
+      break
+    // case CHAIN_IDS.ROPSTEN:
+    //   ethApi = init(undefined, "ropsten")
+    //   break
+    // case CHAIN_IDS.RINKEBY:
+    //   ethApi = init(undefined, "rinkeby")
+    //   break
+    case CHAIN_IDS.GOERLI:
+      ethApi = init(undefined, 'goerli')
+      break
+    // case CHAIN_IDS.SEPOLIA:
+    //   ethApi = init(undefined, "sepolia")
+    //   break
+
+    case CHAIN_IDS.ARBITRUM:
+      ethApi = init(undefined, 'arbitrum')
+      break
+    case CHAIN_IDS.ARBITRUM_GOERLI:
+      ethApi = init(undefined, 'arbitrum_rinkeby')
+      break
+    case CHAIN_IDS.AVALANCHE:
+      ethApi = init(undefined, 'avalanche')
+      break
+    // case CHAIN_IDS.KOVAN:
+    //   ethApi = init(undefined, "kovan")
+    //   break
+    default:
+      console.error(chalk.red(`chain ${chain} not supported for direct add, please download the ABI manually`))
+      process.exit(1)
+  }
+
+  const baseErrMsg = chalk.red(
+    `Failed to automatic download contract ${address} from ${chain}, please manually download abi and put it into abis/eth directory`
+  )
+
+  if (aptosClient) {
+    try {
+      return {
+        abi: await aptosClient.getAccountModules(address),
+      }
+    } catch (e) {
+      console.error(baseErrMsg, e)
+      process.exit(1)
+    }
+  }
+  if (suiClient) {
+    try {
+      return {
+        abi: await suiClient.getNormalizedMoveModulesByPackage(address),
+      }
+    } catch (e) {
+      console.error(baseErrMsg, e)
+      process.exit(1)
+    }
+  }
+
+  try {
+    let resp = await ethApi.contract.getabi(address)
+    if (resp.status !== '1') {
+      throw Error(resp.message)
+    }
+    const abi = resp.result
+
+    if (!name) {
+      await new Promise((resolve) => setTimeout(resolve, 1000))
+      resp = await ethApi.contract.getsourcecode(address)
+      if (resp.status !== '1') {
+        throw Error(resp.message)
+      }
+      const contractName = resp.result[0].ContractName
+      if (contractName) {
+        name = contractName
+      }
+    }
+    return {
+      name,
+      abi,
+    }
+  } catch (e) {
+    console.error(baseErrMsg, e)
+    process.exit(1)
+  }
+}
+
+export function getABIFilePath(chain: string, name: string): string {
+  let subpath
+  switch (chain) {
+    case CHAIN_IDS.APTOS_MAINNET:
+      subpath = 'aptos'
+      break
+    case CHAIN_IDS.APTOS_TESTNET:
+      subpath = 'aptos/test'
+      break
+    case CHAIN_IDS.SUI_MAINNET:
+      subpath = 'sui'
+      break
+    case CHAIN_IDS.SUI_TESTNET:
+      subpath = 'sui/test'
+      break
+    default:
+      subpath = 'eth'
+  }
+
+  return path.join('abis', subpath, name + '.json')
+}
+
+export function writeABIFile(obj: string | object, output: string) {
+  if (typeof obj === 'string') {
+    obj = JSON.parse(obj)
+  }
+  const data = JSON.stringify(obj, null, 2)
+  fs.mkdirSync(path.dirname(output), { recursive: true })
+  fs.writeFileSync(output, data)
+  console.log(chalk.green('ABI has been downloaded to', output))
+}

package/src/chain.ts

@@ -0,0 +1,195 @@
+// copy from https://github.com/DefiLlama/chainlist/blob/main/constants/chainIds.js
+// and https://besu.hyperledger.org/en/stable/Concepts/NetworkID-And-ChainID/
+
+export const CHAIN_IDS = {
+  KARDIA: '0',
+  ETHEREUM: '1',
+  EXPANSE: '2',
+  ROPSTEN: '3',
+  RINKEBY: '4',
+  GOERLI: '5',
+  KOTTI: '6',
+  UBIQ: '8',
+  OPTIMISM: '10',
+  SONGBIRD: '19',
+  ELASTOS: '20',
+  CRONOS: '25',
+  RSK: '30',
+  TELOS: '40',
+  XDC: '50',
+  CSC: '52',
+  ZYX: '55',
+  BINANCE: '56',
+  SYSCOIN: '57',
+  GOCHAIN: '60',
+  ETHCLASSIC: '61',
+  MORDOR: '63',
+  OKEXCHAIN: '66',
+  HOO: '70',
+  METER: '82',
+  TOMOCHAIN: '88',
+  BINANCE_TEST: '97',
+  XDAI: '100',
+  VELAS: '106',
+  THUNDERCORE: '108',
+  FUSE: '122',
+  HECO: '128',
+  POLYGON: '137',
+  XDAIARB: '200',
+  ASTOR: '212',
+  ENERGYWEB: '246',
+  FANTOM: '250',
+  HPB: '269',
+  BOBA: '288',
+  KUCOIN: '321',
+  ZKSYNC_ERA: '324',
+  SHIDEN: '336',
+  THETA: '361',
+  SX: '416',
+  CANDLE: '534',
+  ASTAR: '592',
+  CALLISTO: '820',
+  WANCHAIN: '888',
+  POLYGON_ZKEVM: '1101',
+  METIS: '1088',
+  OMCHAIN: '1246',
+  MOONBEAM: '1284',
+  MOONRIVER: '1285',
+  MOONBASE: '1287',
+  DEV: '2018',
+  RONIN: '2020',
+  KAVA: '2222',
+  EZCHAIN: '2612',
+  PHI: '4181',
+  IOTEX: '4689',
+  XLC: '5050',
+  NAHMII: '5551',
+  NMACTEST: '7777',
+  KLAYTN: '8217',
+  EVMOS: '9001',
+  BASE_GOERLI: '84531',
+  SMARTBCH: '10000',
+  CRYSTALEUM: '103090',
+  FUSION: '32659',
+  ARBITRUM: '42161',
+  CELO: '42220',
+  OASIS: '42262',
+  AVALANCHE: '43114',
+  GODWOKEN: '71402',
+  AKROMA: '200625',
+  POLIS: '333999',
+  ARBITRUM_GOERLI: '421613',
+  SEPOLIA: '11155111',
+  AURORA: '1313161554',
+  HARMONY: '1666600000',
+  PALM: '11297108109',
+  CURIO: '836542336838601',
+  SOLANA_MAINNET: 'sol_mainnet',
+  SOLANA_DEVNET: 'sol_devnet',
+  SOLANA_TESTNET: 'sol_testnet',
+  SOLANA_PYTH: 'sol_pyth',
+  SUI_MAINNET: 'sui_mainnet',
+  SUI_TESTNET: 'sui_testnet',
+  SUI_DEVNET: 'sui_devnet',
+  APTOS_MAINNET: 'aptos_mainnet',
+  APTOS_TESTNET: 'aptos_testnet',
+  APTOS_DEVNET: 'aptos_devnet',
+}
+
+export const CHAIN_MAP: Record<string, string> = {}
+
+for (const [key, value] of Object.entries(CHAIN_IDS)) {
+  if (value === CHAIN_IDS.POLYGON_ZKEVM) {
+    CHAIN_MAP[value] = 'Polygon zkEVM'
+  } else if (value === CHAIN_IDS.ZKSYNC_ERA) {
+    CHAIN_MAP[value] = 'zkSync Era'
+  } else {
+    const parts = key.split('_')
+    CHAIN_MAP[value] = parts
+      .map((part, index) => {
+        return part[0] + part.slice(1).toLowerCase()
+      })
+      .join(' ')
+  }
+}
+
+export function getChainName(chainId: string | number | null | undefined): string {
+  if (typeof chainId === 'number') {
+    chainId = chainId.toString()
+  }
+  if (chainId) {
+    const name = CHAIN_MAP[chainId]
+    if (name) {
+      return name
+    }
+  }
+  return chainId || ''
+}
+
+export function getChainType(chainId?: string | number): string {
+  const id = String(chainId).toLowerCase()
+  if (id.startsWith('sol')) {
+    return 'solana'
+  }
+  if (id.startsWith('sui')) {
+    return 'sui'
+  }
+  if (id.startsWith('apt')) {
+    return 'aptos'
+  }
+  return 'EVM'
+}
+
+export function getChainScanUrl(
+  chainId?: string | number,
+  hash?: string,
+  subtype?: 'block' | 'address' | 'transaction'
+): string | undefined {
+  const chainName = getChainName(chainId)
+  if (chainName === 'Ethereum') {
+    if (subtype === 'block') {
+      return `https://etherscan.io/block/${hash}`
+    } else if (subtype === 'address') {
+      return `https://etherscan.io/address/${hash}`
+    } else {
+      return `https://etherscan.io/tx/${hash}`
+    }
+  }
+  if (chainName === 'Polygon') {
+    if (subtype === 'block') {
+      return `https://polygonscan.com/block/${hash}`
+    } else if (subtype === 'address') {
+      return `https://polygonscan.com/address/${hash}`
+    } else {
+      return `https://polygonscan.com/tx/${hash}`
+    }
+  }
+  if (chainName.startsWith('Aptos ')) {
+    if (subtype === 'block') {
+      return `https://explorer.aptos.io/block/${hash}`
+    } else if (subtype === 'address') {
+      return `https://explorer.aptos.io/account/${hash}`
+    } else {
+      return `https://explorer.aptos.io/txn/${hash}`
+    }
+  }
+  if (chainName.startsWith('Solana ')) {
+    if (subtype === 'block') {
+      return `https://explorer.solana.com/block/${hash}`
+    } else if (subtype === 'address') {
+      return `https://explorer.solana.com/address/${hash}`
+    } else {
+      return `https://explorer.solana.io/tx/${hash}`
+    }
+  }
+  if (chainName.startsWith('Sui ')) {
+    if (subtype === 'block') {
+      return `https://explorer.sui.io/block/${hash}`
+    } else if (subtype === 'address') {
+      return `https://explorer.sui.io/address/${hash}`
+    } else {
+      return `https://explorer.sui.io/transaction/${hash}`
+    }
+  }
+  return undefined
+}

package/src/cli.ts

@@ -5,10 +5,10 @@ import commandLineUsage from 'command-line-usage'
 import fs from 'fs'
 import path from 'path'
 
-import yaml from 'js-yaml'
-import { SentioProjectConfig } from './config.js'
+import yaml from 'yaml'
+import { YamlProjectConfig } from './config.js'
 import chalk from 'chalk'
-import { buildProcessor, buildProcessorWithArgs } from './commands/build.js'
+import { buildProcessorWithArgs, generate } from './commands/build.js'
 import { runCreate } from './commands/run-create.js'
 import { runVersion } from './commands/run-version.js'
 import { runLogin } from './commands/run-login.js'
@@ -41,7 +41,7 @@ if (mainOptions.command === 'login') {
   // TODO move them to their own modules
 
   // Process configs
-  let processorConfig: SentioProjectConfig = { host: '', project: '', build: true, debug: false }
+  let processorConfig: YamlProjectConfig = { host: '', project: '', build: true, debug: false, contracts: [] }
   // Fist step, read from project yaml file
   try {
     console.log(chalk.blue('Loading Process config'))
@@ -59,7 +59,7 @@ if (mainOptions.command === 'login') {
       process.exit(1)
     }
 
-    processorConfig = yaml.load(fs.readFileSync('sentio.yaml', 'utf8')) as SentioProjectConfig
+    processorConfig = yaml.parse(fs.readFileSync('sentio.yaml', 'utf8')) as YamlProjectConfig
     if (!processorConfig.project === undefined) {
       console.error('Config yaml must have contain a valid project identifier')
       process.exit(1)
@@ -95,7 +95,7 @@ if (mainOptions.command === 'login') {
   } else if (mainOptions.command === 'build') {
     await buildProcessorWithArgs(argv)
   } else if (mainOptions.command === 'gen') {
-    await buildProcessor(true, [])
+    await generate(argv)
   } else {
     usage()
   }

package/src/commands/build.ts

@@ -6,6 +6,9 @@ import * as process from 'process'
 import { getPackageRoot } from '../utils.js'
 import commandLineArgs from 'command-line-args'
 import commandLineUsage from 'command-line-usage'
+import yaml from 'yaml'
+import { YamlProjectConfig } from '../config.js'
+import { getABIFilePath, getABI, writeABIFile } from '../abi.js'
 
 export const buildOptionDefinitions = [
   {
@@ -24,14 +27,27 @@ export const buildOptionDefinitions = [
     type: Boolean,
     description: 'Skip dependency enforce.',
   },
+  {
+    name: 'example',
+    type: Boolean,
+    description: 'Generate example usage of the processor.',
+  },
+]
+
+export const GenOptionDefinitions = [
+  {
+    name: 'example',
+    type: Boolean,
+    description: 'Generate example usage of the processor.',
+  },
 ]
 
 export async function buildProcessorWithArgs(argv: string[]) {
   const options = commandLineArgs(buildOptionDefinitions, { argv })
   const usage = commandLineUsage([
     {
-      header: 'Create a template project',
-      content: 'sentio create <name>',
+      header: 'Build project',
+      content: 'sentio build',
     },
     {
       header: 'Options',
@@ -46,13 +62,33 @@ export async function buildProcessorWithArgs(argv: string[]) {
   await buildProcessor(false, options)
 }
 
+export async function generate(argv: string[]) {
+  const options = commandLineArgs(GenOptionDefinitions, { argv })
+  const usage = commandLineUsage([
+    {
+      header: 'Generate type binding',
+      content: 'sentio gen [--example]',
+    },
+    {
+      header: 'Options',
+      optionList: GenOptionDefinitions,
+    },
+  ])
+
+  if (options.help) {
+    console.log(usage)
+    process.exit(0)
+  }
+  await buildProcessor(true, options)
+}
+
 export async function buildProcessor(onlyGen: boolean, options: commandLineArgs.CommandLineOptions) {
   if (!options['skip-deps'] && !onlyGen) {
     await installDeps()
   }
 
   if (!options['skip-gen']) {
-    await codegen()
+    await codegen(options.example || false)
   }
 
   if (!onlyGen) {
@@ -87,8 +123,21 @@ import 'mine.js'
   }
 }
 
-export async function codegen() {
+export async function codegen(genExample: boolean) {
+  const processorConfig = yaml.parse(fs.readFileSync('sentio.yaml', 'utf8')) as YamlProjectConfig
+
+  for (const contract of processorConfig.contracts || []) {
+    const outputPath = getABIFilePath(contract.chain, contract.name || contract.address)
+    if (fs.existsSync(outputPath)) {
+      continue
+    }
+    console.log('Download Missing ABI specified in sentio.yaml')
+    const res = await getABI(contract.chain, contract.address, contract.name)
+    writeABIFile(res.abi, outputPath)
+  }
+
   const outputBase = path.resolve('src', 'types')
+
   try {
     // @ts-ignore dynamic import
     const codegen = await import('@sentio/sdk/eth/codegen')
@@ -100,7 +149,7 @@ export async function codegen() {
     }
     fs.emptyDirSync(output)
     // @ts-ignore dynamic import
-    await codegen.codegen(input, output)
+    await codegen.codegen(input, output, processorConfig.contracts)
   } catch (e) {
     console.error('code gen error', e)
   }
@@ -113,7 +162,7 @@ export async function codegen() {
     fs.emptyDirSync(output)
 
     // @ts-ignore dynamic import
-    await codegen.codegen(path.resolve('abis', 'solana'), output)
+    await codegen.codegen(path.resolve('abis', 'solana'), output, genExample)
   } catch (e) {
     console.error('code gen error', e)
   }
@@ -126,7 +175,7 @@ export async function codegen() {
     fs.emptyDirSync(output)
 
     // @ts-ignore dynamic import
-    await codegen.codegen(path.resolve('abis', 'aptos'), output)
+    await codegen.codegen(path.resolve('abis', 'aptos'), output, genExample)
   } catch (e) {
     console.error('code gen error', e)
   }
@@ -139,7 +188,7 @@ export async function codegen() {
     fs.emptyDirSync(output)
 
     // @ts-ignore dynamic import
-    await codegen.codegen(path.resolve('abis', 'sui'), output)
+    await codegen.codegen(path.resolve('abis', 'sui'), output, genExample)
   } catch (e) {
     console.error('code gen error', e)
   }

package/src/commands/run-add.ts

@@ -1,15 +1,13 @@
 import commandLineArgs from 'command-line-args'
 import commandLineUsage from 'command-line-usage'
-import path from 'path'
 import fs from 'fs-extra'
 import chalk from 'chalk'
 
 import { codegen } from './build.js'
 
-// @ts-ignore no types
-import { init } from 'etherscan-api'
-import { AptosClient } from 'aptos-sdk'
-import { JsonRpcProvider } from '@mysten/sui.js'
+import * as process from 'process'
+import yaml from 'yaml'
+import { getABIFilePath, getABI, writeABIFile } from '../abi.js'
 
 export async function runAdd(argv: string[]) {
   const optionDefinitions = [
@@ -23,9 +21,9 @@ export async function runAdd(argv: string[]) {
       name: 'chain',
       alias: 'c',
       type: String,
-      defaultValue: 'homestead',
+      defaultValue: '1',
       description:
-        'Chain identifier, can be: homestead/mainnet,goerli,arbitrum,avalanche, apots, aptos/testnet and sui, sui/testnet',
+        'Chain id define from here: https://raw.githubusercontent.com/sentioxyz/sentio-sdk/main/packages/sdk/src/core/chain.ts notice some chain may not support this command',
     },
     {
       name: 'address',
@@ -64,91 +62,38 @@ export async function runAdd(argv: string[]) {
       process.exit(1)
     }
 
-    let ethApi
-    let aptosClient: AptosClient | undefined
-    let suiClient: JsonRpcProvider | undefined
-    switch (chain) {
-      case 'aptos':
-        aptosClient = new AptosClient('https://mainnet.aptoslabs.com/')
-        break
-      case 'aptos/testnet':
-        aptosClient = new AptosClient('https://testnet.aptoslabs.com/')
-        break
-      case 'sui':
-        throw Error('SUI mainnet is not support yet, try sui/testnet')
-      // suiClient = new JsonRpcProvider('https://fullnode.mainnet.sui.io/')
-      // break
-      case 'sui/testnet':
-        suiClient = new JsonRpcProvider('https://fullnode.testnet.sui.io/')
-        break
-      case 'mainnet':
-      case 'homestead':
-        ethApi = init()
-        break
-      default:
-        ethApi = init(undefined, chain)
-    }
-
-    const baseErrMsg = chalk.red(
-      `Failed to automatic download contract ${address} from ${chain}, please manually download abi and put it into abis/eth directory`
-    )
+    const abiRes = await getABI(chain, address, options.name)
+    const filename = abiRes.name || address
 
-    const filename = options.name ? options.name : address
+    writeABIFile(abiRes.abi, getABIFilePath(chain, filename))
 
-    if (aptosClient) {
-      try {
-        const module = await aptosClient.getAccountModules(address)
-        writeToDirectory(module, chain, filename)
-      } catch (e) {
-        console.error(baseErrMsg, e)
-        process.exit(1)
-      }
+    // Write contract info to sentio.yaml
+    const yamlDocument: yaml.Document = yaml.parseDocument(fs.readFileSync('sentio.yaml', 'utf8'))
+    let contracts = yamlDocument.get('contracts') as yaml.YAMLSeq
+    if (!contracts) {
+      contracts = new yaml.YAMLSeq()
+      yamlDocument.set('contracts', contracts)
     }
-    if (suiClient) {
-      try {
-        const module = await suiClient.getNormalizedMoveModulesByPackage(address)
-        writeToDirectory(module, chain, filename)
-      } catch (e) {
-        console.error(baseErrMsg, e)
-        process.exit(1)
+
+    let hasContract = false
+    for (const item of contracts.items as yaml.YAMLMap[]) {
+      if (item.get('chain') === chain && item.get('address') === address) {
+        hasContract = true
       }
     }
 
-    if (ethApi) {
-      try {
-        const resp = await ethApi.contract.getabi(address)
-        if (resp.status !== '1') {
-          throw Error(resp.message)
-        }
-        writeToDirectory(resp.result, chain, filename)
-      } catch (e) {
-        console.error(baseErrMsg, e)
-        process.exit(1)
+    if (!hasContract) {
+      const newContract = new yaml.YAMLMap()
+      newContract.set('chain', chain)
+      newContract.set('address', address)
+      if (address !== filename) {
+        newContract.set('name', filename)
       }
+      contracts.add(newContract)
+      fs.writeFileSync('sentio.yaml', yamlDocument.toString(), 'utf8')
     }
-    // Run gen
-    await codegen()
-  }
-}
 
-function writeToDirectory(obj: object | string, chain: string, name: string) {
-  if (typeof obj === 'string') {
-    obj = JSON.parse(obj)
-  }
-  const data = JSON.stringify(obj, null, 2)
-  let subpath = chain
-  switch (chain) {
-    case 'aptos':
-    case 'aptos/testnet':
-    case 'sui':
-    case 'sui/testnet':
-      break
-    default:
-      subpath = 'eth'
+    // Run gen
+    await codegen(false)
   }
-
-  const output = path.join('abis', subpath, name + '.json')
-  fs.mkdirSync(path.dirname(output), { recursive: true })
-  fs.writeFileSync(output, data)
-  console.log(chalk.green('ABI has been downloaded to', output))
 }