@sentio/cli 2.4.0 → 2.5.0-rc.1

package/src/cli.ts

@@ -5,7 +5,7 @@ import commandLineUsage from 'command-line-usage'
 import fs from 'fs'
 import path from 'path'
 
-import yaml from 'js-yaml'
+import yaml from 'yaml'
 import { SentioProjectConfig } from './config.js'
 import chalk from 'chalk'
 import { buildProcessor, buildProcessorWithArgs } from './commands/build.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: SentioProjectConfig = { 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 SentioProjectConfig
     if (!processorConfig.project === undefined) {
       console.error('Config yaml must have contain a valid project identifier')
       process.exit(1)

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 { SentioProjectConfig } from '../config.js'
+import { getABIFilePath, getABI, writeABIFile } from '../abi.js'
 
 export const buildOptionDefinitions = [
   {
@@ -24,6 +27,11 @@ export const buildOptionDefinitions = [
     type: Boolean,
     description: 'Skip dependency enforce.',
   },
+  {
+    name: 'example',
+    type: Boolean,
+    description: 'Generate example usage of the processor.',
+  },
 ]
 
 export async function buildProcessorWithArgs(argv: string[]) {
@@ -52,7 +60,7 @@ export async function buildProcessor(onlyGen: boolean, options: commandLineArgs.
   }
 
   if (!options['skip-gen']) {
-    await codegen()
+    await codegen(options.example || false)
   }
 
   if (!onlyGen) {
@@ -87,7 +95,8 @@ import 'mine.js'
   }
 }
 
-export async function codegen() {
+export async function codegen(genExample = false) {
+  await prepareABI()
   const outputBase = path.resolve('src', 'types')
   try {
     // @ts-ignore dynamic import
@@ -100,7 +109,7 @@ export async function codegen() {
     }
     fs.emptyDirSync(output)
     // @ts-ignore dynamic import
-    await codegen.codegen(input, output)
+    await codegen.codegen(input, output, genExample)
   } catch (e) {
     console.error('code gen error', e)
   }
@@ -113,7 +122,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 +135,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 +148,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)
   }
@@ -172,3 +181,21 @@ async function execStep(cmd: string, stepName: string) {
   console.log(chalk.blue(stepName + ' success'))
   console.log()
 }
+
+async function prepareABI() {
+  const processorConfig = yaml.parse(fs.readFileSync('sentio.yaml', 'utf8')) as SentioProjectConfig
+
+  if (!processorConfig.contracts) {
+    return
+  }
+
+  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)
+  }
+}

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'
-  }
-
-  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))
-}

package/src/config.ts

@@ -5,12 +5,17 @@ const HostMap: { [host: string]: string } = {
   prod: 'https://app.sentio.xyz',
 }
 
+export interface ContractConfig {
+  address: string
+  chain: string
+  name: string
+}
+
 export interface SentioProjectConfig {
   project: string
   host: string
-  // source: string
   build: boolean
-  // targets: Target[]
+  contracts: ContractConfig[]
   debug: boolean
 }