@sentio/cli 1.0.0

package/templates/evm/abis/evm/x2y2.json

@@ -0,0 +1,296 @@
+[
+  {
+    "inputs": [
+      { "internalType": "address", "name": "_x2y2Token", "type": "address" },
+      {
+        "internalType": "address",
+        "name": "_tokenSplitter",
+        "type": "address"
+      },
+      { "internalType": "uint256", "name": "_startBlock", "type": "uint256" },
+      {
+        "internalType": "uint256[]",
+        "name": "_rewardsPerBlockForStaking",
+        "type": "uint256[]"
+      },
+      {
+        "internalType": "uint256[]",
+        "name": "_rewardsPerBlockForOthers",
+        "type": "uint256[]"
+      },
+      {
+        "internalType": "uint256[]",
+        "name": "_periodLengthesInBlocks",
+        "type": "uint256[]"
+      },
+      { "internalType": "uint256", "name": "_numberPeriods", "type": "uint256" }
+    ],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "user",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "harvestedAmount",
+        "type": "uint256"
+      }
+    ],
+    "name": "Compound",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "user",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "harvestedAmount",
+        "type": "uint256"
+      }
+    ],
+    "name": "Deposit",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "uint256",
+        "name": "currentPhase",
+        "type": "uint256"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "startBlock",
+        "type": "uint256"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "rewardPerBlockForStaking",
+        "type": "uint256"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "rewardPerBlockForOthers",
+        "type": "uint256"
+      }
+    ],
+    "name": "NewRewardsPerBlock",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "user",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "harvestedAmount",
+        "type": "uint256"
+      }
+    ],
+    "name": "Withdraw",
+    "type": "event"
+  },
+  {
+    "inputs": [],
+    "name": "NUMBER_PERIODS",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "PRECISION_FACTOR",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "START_BLOCK",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "accTokenPerShare",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [{ "internalType": "address", "name": "user", "type": "address" }],
+    "name": "calculatePendingRewards",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "currentPhase",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
+    "name": "deposit",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "endBlock",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "harvestAndCompound",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "lastRewardBlock",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "rewardPerBlockForOthers",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "rewardPerBlockForStaking",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "name": "stakingPeriod",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "rewardPerBlockForStaking",
+        "type": "uint256"
+      },
+      {
+        "internalType": "uint256",
+        "name": "rewardPerBlockForOthers",
+        "type": "uint256"
+      },
+      {
+        "internalType": "uint256",
+        "name": "periodLengthInBlock",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "tokenSplitter",
+    "outputs": [{ "internalType": "address", "name": "", "type": "address" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "totalAmountStaked",
+    "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "updatePool",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [{ "internalType": "address", "name": "", "type": "address" }],
+    "name": "userInfo",
+    "outputs": [
+      { "internalType": "uint256", "name": "amount", "type": "uint256" },
+      { "internalType": "uint256", "name": "rewardDebt", "type": "uint256" }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [{ "internalType": "uint256", "name": "amount", "type": "uint256" }],
+    "name": "withdraw",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "withdrawAll",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "x2y2Token",
+    "outputs": [
+      {
+        "internalType": "contract IMintableERC20",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  }
+]

package/templates/evm/jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ["<rootDir>/dist/"]
+};

package/templates/evm/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "template-evm",
+  "private": true,
+  "version": "1.0.0",
+  "scripts": {
+    "test": "jest",
+    "gen": "sentio gen",
+    "build": "sentio build",
+    "upload": "sentio upload"
+  },
+  "dependencies": {
+    "@sentio/sdk": "^1.0.0-development"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.0.0",
+    "jest": "^29.0.0",
+    "ts-jest": "^29.0.0",
+    "typescript": "^4.7.2"
+  }
+}

package/templates/evm/sentio.yaml

@@ -0,0 +1,3 @@
+# Project name could be $org_or_user/$project_name or $project_name
+# If latter, will be treated the owner as api key's owner
+project: default

package/templates/evm/src/processor.test.ts

@@ -0,0 +1,29 @@
+import { TestProcessorServer, firstCounterValue } from '@sentio/sdk/lib/testing'
+import { mockTransferLog } from '@sentio/sdk/lib/builtin/erc20/test-utils'
+import { BigNumber } from 'ethers'
+
+describe('Test Processor', () => {
+  const service = new TestProcessorServer(() => require('./processor'))
+
+  beforeAll(async () => {
+    await service.start()
+  })
+
+  test('has valid config', async () => {
+    const config = await service.getConfig({})
+    expect(config.contractConfigs.length > 0).toBeTruthy()
+  })
+
+  test('check transfer event handling', async () => {
+    const resp = await service.testLog(
+      mockTransferLog('0x1e4ede388cbc9f4b5c79681b7f94d36a11abebc9', {
+        from: '0x0000000000000000000000000000000000000000',
+        to: '0xb329e39ebefd16f40d38f07643652ce17ca5bac1',
+        value: BigNumber.from(10n ** 18n * 10n),
+      })
+    )
+
+    const tokenCounter = firstCounterValue(resp.result, 'token')
+    expect(tokenCounter).toEqual(10n)
+  })
+})

package/templates/evm/src/processor.ts

@@ -0,0 +1,29 @@
+import { Counter, Gauge } from '@sentio/sdk'
+import { token } from '@sentio/sdk/lib/utils'
+import { ERC20Processor } from '@sentio/sdk/lib/builtin/erc20'
+import { X2y2Processor } from './types/x2y2'
+
+const rewardPerBlock = Gauge.register('reward_per_block', {
+  description: 'rewards for each block grouped by phase',
+  unit: 'x2y2',
+})
+const tokenCounter = Counter.register('token')
+
+X2y2Processor.bind({ address: '0xB329e39Ebefd16f40d38f07643652cE17Ca5Bac1' }).onBlockInterval(async (_, ctx) => {
+  const phase = (await ctx.contract.currentPhase()).toString()
+  const reward = token.scaleDown(await ctx.contract.rewardPerBlockForStaking(), 18)
+  rewardPerBlock.record(ctx, reward, { phase })
+})
+
+const filter = ERC20Processor.filters.Transfer(
+  '0x0000000000000000000000000000000000000000',
+  '0xb329e39ebefd16f40d38f07643652ce17ca5bac1'
+)
+
+ERC20Processor.bind({ address: '0x1e4ede388cbc9f4b5c79681b7f94d36a11abebc9' }).onEventTransfer(
+  async (event, ctx) => {
+    const val = token.scaleDown(event.args.value, 18)
+    tokenCounter.add(ctx, val)
+  },
+  filter // filter is an optional parameter
+)

package/templates/evm/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "alwaysStrict": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "esModuleInterop": true,
+    "noImplicitReturns": true,
+    "noImplicitAny": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "strictNullChecks": true,
+    "stripInternal": true,
+    "noFallthroughCasesInSwitch": true,
+    "noEmitOnError": true,
+    "outDir": "dist",
+    "rootDir": "./src",
+    "skipLibCheck": true
+  },
+  "exclude": ["dist"]
+}

package/templates/raw/.gitignore

@@ -0,0 +1,107 @@
+.idea
+src/types
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port

package/templates/raw/jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ["<rootDir>/dist/"]
+};

package/templates/raw/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "template-raw",
+  "private": true,
+  "version": "1.0.0",
+  "scripts": {
+    "test": "jest",
+    "gen": "sentio gen",
+    "build": "sentio build",
+    "upload": "sentio upload"
+  },
+  "dependencies": {
+    "@sentio/sdk": "^1.0.0-development"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.0.0",
+    "jest": "^29.0.0",
+    "ts-jest": "^29.0.0",
+    "typescript": "^4.7.2"
+  }
+}

package/templates/raw/sentio.yaml

@@ -0,0 +1,3 @@
+# Project name could be $org_or_user/$project_name or $project_name
+# If latter, will be treated the owner as api key's owner
+project: default

package/templates/raw/src/processor.test.ts

@@ -0,0 +1,14 @@
+import { TestProcessorServer } from '@sentio/sdk/lib/testing'
+
+describe('Test Processor', () => {
+  const service = new TestProcessorServer(() => require('./processor'))
+
+  beforeAll(async () => {
+    await service.start()
+  })
+
+  test('has valid config', async () => {
+    // const config = await service.getConfig({})
+    // expect(config.contractConfigs.length > 0).toBeTruthy()
+  })
+})

package/templates/raw/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "alwaysStrict": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "esModuleInterop": true,
+    "noImplicitReturns": true,
+    "noImplicitAny": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "strictNullChecks": true,
+    "stripInternal": true,
+    "noFallthroughCasesInSwitch": true,
+    "noEmitOnError": true,
+    "outDir": "dist",
+    "rootDir": "./src",
+    "skipLibCheck": true
+  },
+  "exclude": ["dist"]
+}