Merge pull request #20 from RoboVault/fix/logger-examples

add logger, deno tasks, and README to examples

Author: hazelnutcloud

cli/start/mod.ts

@@ -10,6 +10,8 @@ import { ArkiverMetadata } from '../../src/arkiver/arkive-metadata.ts'
 import { createManifestHandlers } from './logger.ts'
 import { colors, mongoose, SchemaComposer } from '../../src/deps.ts'
 import { logger } from '../../src/logger.ts'
+import { collectRpcUrls } from '../utils.ts'
+
 
 export const action = async (
   options: {
@@ -114,11 +116,17 @@ export const action = async (
     },
   })
 
+  // An RPC for our Arkive is going to be assigned at some point.
+  // The order of assignment is as follows:
+  // 1. CLI command line option -r, --rpc-url
+  // 2. Env variables such as {CHAIN}_RPC_URL
+  // 3. RPC url defined in manifest
+  // 4. Default RPC of Viem
   const rpcUrls = options.rpcUrl?.reduce((acc, rpc) => {
     const [name, url] = rpc.split('=')
     acc[name] = url
     return acc
-  }, {} as Record<string, string>) ?? {}
+  }, {} as Record<string, string>) ?? collectRpcUrls() ?? {}
 
   logger('arkiver').debug(`Connecting to database...`)
   const connectionString = options.mongoConnection ??

cli/utils.ts

@@ -2,6 +2,7 @@ import { SUPABASE_ANON_PUBLIC_KEY, SUPABASE_URL } from './constants.ts'
 import { createClient, Input, Secret, z } from './deps.ts'
 import { login } from './login/mod.ts'
 import { spinner } from './spinner.ts'
+import { supportedChains } from '../src/chains.ts'
 
 export const getEmail = async () => {
   const email = await Input.prompt('✉️  Email:')
@@ -127,3 +128,23 @@ export const craftEndpoint = (
     majorVersion ? majorVersion + '/' : ''
   }graphql`
 }
+
+export const getEnv = (key: string, defaultValue?: string): string => {
+  const value = Deno.env.get(key)
+  if (!value && !defaultValue) {
+    throw new Error(`Missing environment variable: ${key}`)
+  }
+  return value || defaultValue || ''
+}
+
+export const collectRpcUrls = () => {
+  const rpcUrls: Record<string, string> = {}
+  for (const chain of Object.keys(supportedChains)) {
+    try {
+      rpcUrls[chain] = getEnv(`${chain.toUpperCase()}_RPC_URL`)
+    } catch (_e) {
+      // ignore
+    }
+  }
+  return rpcUrls
+}

deno.lock

@@ -0,0 +1,38 @@
+# ERC20 Balance History
+This Arkive keeps an accurate historical record of the sharePrice of a given set of YearnV2 Abi Vaults. sharePrice increases as profits are distributed to the vaults, but may also decrease if loss is incurred. It may be valuable to track this information in case of incidents or in order to optimize the vaults for instance. 
+### Dependencies
+* Docker
+* Full Archive RPC (Infura, Ankr, Alchemy, etc)
+
+### Arkive Usage
+
+First make sure .env is configured correctly with your RPC endpoint. In this example we are connecting the `mainnet` with the Ankr public ETH endpoint.
+> MAINNET_RPC_URL=https://rpc.ankr.com/eth
+
+All available tasks can been seen with
+> deno task
+
+To start a new instance of the Arkive you can use `deno task` to run the `new` script with the following command
+> deno task new
+
+To reset the database and resync the Arkive run `reset` task
+> deno task reset
+
+### Using the GraphQL Explorer
+If Arkiver is running there should now be webpage avaiable at http://0.0.0.0:4000/graphql
+
+In the left side you can use the no-code explorer to pick and choose which Entities and what fields of the Entities you would like to look at. Here is an example query for this Arkive. This fetches the latest VaultSnapshot entity.
+```
+query MyQuery {
+  VaultSnapshot(sort: _ID_DESC) {
+    vault
+    name
+    symbol
+    block
+    timestamp
+    sharePrice
+  }
+}
+```
+
+

examples/block-handler-vaults/README.md

@@ -1,4 +1,4 @@
-export const YearnV2Abi = [{
+export const YEARN_V2_ABI = [{
   'name': 'Transfer',
   'inputs': [{ 'name': 'sender', 'type': 'address', 'indexed': true }, {
     'name': 'receiver',

examples/block-handler-vaults/abis/YearnV2.ts

@@ -0,0 +1,13 @@
+{
+    "tasks": {
+      "start": "arkiver start ./ -c mongodb://localhost:27017",
+      "new": "docker run --name mongo -d -p 27017:27017 mongodb/mongodb-community-server:latest && arkiver start ./ -c mongodb://localhost:27017",
+      "resetdb": "docker stop mongo && docker rm mongo && docker run --name mongo -d -p 27017:27017 mongodb/mongodb-community-server:latest",
+      "reset": "docker stop mongo && docker rm mongo && docker run --name mongo -d -p 27017:27017 mongodb/mongodb-community-server:latest && arkiver start ./ -c mongodb://localhost:27017",
+      "newdb": "docker run --name mongo -d -p 27017:27017 mongodb/mongodb-community-server:latest",
+      "stopdb": "docker stop mongo",
+      "rmdb": "docker rm mongo",
+      "startdb": "docker start mongo",
+      "deploy": "arkiver deploy ./"
+    }
+  }

examples/block-handler-vaults/deno.jsonc

@@ -1,7 +1,7 @@
 import { formatUnits, getContract } from 'npm:viem'
 import { type BlockHandler } from 'https://deno.land/x/robo_arkiver@v0.4.19/mod.ts'
 import { VaultSnapshot } from '../entities/vault.ts'
-import { YearnV2Abi } from '../abis/YearnV2.ts'
+import { YEARN_V2_ABI } from '../abis/YearnV2.ts'
 
 const VAULTS = [
   { address: '0xdA816459F1AB5631232FE5e97a05BBBb94970c95', block: 12796965 }, // yvDAI
@@ -12,6 +12,7 @@ export const snapshotVault: BlockHandler = async ({
   block,
   client,
   store,
+  logger,
 }): Promise<void> => {
   // Filter out vaults that haven't been deployed yet
   const liveVaults = VAULTS.filter((e) => e.block < Number(block.number))
@@ -20,12 +21,12 @@ export const snapshotVault: BlockHandler = async ({
   const vaults = await Promise.all(liveVaults.map(async (vault) => {
     const contract = getContract({
       address: vault.address,
-      abi: YearnV2Abi,
+      abi: YEARN_V2_ABI,
       publicClient: client,
     })
     return {
       address: vault.address,
-      vault: { address: vault.address, abi: YearnV2Abi } as const,
+      vault: { address: vault.address, abi: YEARN_V2_ABI } as const,
       contract,
       name: await store.retrieve(
         `${vault.address}:name`,
@@ -46,22 +47,24 @@ export const snapshotVault: BlockHandler = async ({
   const sharePrices = await Promise.all(vaults.map((e) => {
     return client.readContract({
       address: e.address,
-      abi: YearnV2Abi,
+      abi: YEARN_V2_ABI,
       functionName: 'pricePerShare',
       blockNumber: block.number,
     })
   }))
 
   // Save the vault snapshots
   vaults.map((vault, i) => {
+    const sharePrice = parseFloat(
+      formatUnits(sharePrices[i], Number(vault.decimals)),
+    )
+    logger.info(`${vault.name} share price updated to ${sharePrice}`)
     return new VaultSnapshot({
-      id: `${vault.address}-${Number(block.number)}`,
+      // id: `${vault.address}-${Number(block.number)}`,
       block: Number(block.number),
       timestamp: Number(block.timestamp),
       vault: vault.address,
-      sharePrice: parseFloat(
-        formatUnits(sharePrices[i], Number(vault.decimals)),
-      ),
+      sharePrice: sharePrice,
       name: vault.name,
       symbol: vault.symbol,
     })

examples/block-handler-vaults/handlers/vault.ts

@@ -6,12 +6,13 @@ const manifest = new Manifest('yearn-vaults')
 
 manifest
   .addEntity(VaultSnapshot)
-  .addChain('mainnet')
-  .addBlockHandler({
-    blockInterval: 1000,
-    startBlockHeight: 12790000n,
-    handler: snapshotVault,
-  })
+  .addChain('mainnet', (chain) =>
+    chain
+      .addBlockHandler({
+        blockInterval: 1000,
+        startBlockHeight: 12790000n,
+        handler: snapshotVault,
+      }))
 
 export default manifest
   .build()

examples/block-handler-vaults/manifest.ts

@@ -1,4 +1,4 @@
-export default [{
+export const ERC_20_ABI = [{
   'inputs': [],
   'stateMutability': 'nonpayable',
   'type': 'constructor',

examples/erc20-balance-history/erc20.ts examples/erc20-balance-history/Erc20.ts

@@ -0,0 +1,41 @@
+# ERC20 Balance History
+This Arkive keeps an accurate historical record of the balance of an account of a given ERC20 token. It uses the Balance entity as a mutable variable updates as events are handled and is used to keep track of an accounts balance as we sync eventually reflecting true onchain balance. BalanceHistory is an unchanging entity which stores balance over time and is indexed by the `block` field. 
+### Dependencies
+* Docker
+* Full Archive RPC (Infura, Ankr, Alchemy, etc)
+
+### Arkive Usage
+
+First make sure .env is configured correctly with your RPC endpoint. In this example we are connecting the `mainnet` with the Ankr public ETH endpoint.
+> MAINNET_RPC_URL=https://rpc.ankr.com/eth
+
+All available tasks can been seen with
+> deno task
+
+To start a new instance of the Arkive you can use `deno task` to run the `new` script with the following command
+> deno task new
+
+To reset the database and resync the Arkive run `reset` task
+> deno task reset
+
+### Using the GraphQL Explorer
+If Arkiver is running there should now be webpage avaiable at http://0.0.0.0:4000/graphql
+
+In the left side you can use the no-code explorer to pick and chose which Entities and what fields of the Entities you would like to look at. Here is an example query for this Arkive. This fetches the latest Balance and BalanceHistory entities.
+```
+query MyQuery {
+  Balance(sort: _ID_DESC) {
+    token
+    user
+    balance
+  }
+  BalanceHistory(sort: _ID_DESC) {
+    token
+    block
+    user
+    balance
+  }
+}
+```
+
+

examples/erc20-balance-history/README.md

@@ -0,0 +1,13 @@
+{
+    "tasks": {
+      "start": "arkiver start ./ -c mongodb://localhost:27017",
+      "new": "docker run --name mongo -d -p 27017:27017 mongodb/mongodb-community-server:latest && arkiver start ./ -c mongodb://localhost:27017",
+      "resetdb": "docker stop mongo && docker rm mongo && docker run --name mongo -d -p 27017:27017 mongodb/mongodb-community-server:latest",
+      "reset": "docker stop mongo && docker rm mongo && docker run --name mongo -d -p 27017:27017 mongodb/mongodb-community-server:latest && arkiver start ./ -c mongodb://localhost:27017",
+      "newdb": "docker run --name mongo -d -p 27017:27017 mongodb/mongodb-community-server:latest",
+      "stopdb": "docker stop mongo",
+      "rmdb": "docker rm mongo",
+      "startdb": "docker start mongo",
+      "deploy": "arkiver deploy ./"
+    }
+  }

examples/erc20-balance-history/deno.jsonc

@@ -16,15 +16,15 @@ export const Transfer = createEntity('Transfer', {
 export const Balance = createEntity('Balance', {
   token: String,
   user: String,
-  balance: Number,
+  balance: String,
 })
 
 // Contains all balance changes for every user
 export const BalanceHistory = createEntity('BalanceHistory', {
   token: String,
   block: { type: Number, index: true },
   user: String,
-  balance: Number,
+  balance: String,
 })
 
 export const Entities = [Balance, BalanceHistory, Transfer]