@Smooth fixes, add library example

Author: NateBrune

cli/start/mod.ts

@@ -10,7 +10,7 @@ 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 { supportedChains } from '../../src/chains.ts'
+import { collectRpcUrls } from '../utils.ts'
 
 
 export const action = async (
@@ -115,29 +115,13 @@ export const action = async (
       ...loggers,
     },
   })
-  
-  if(options.rpcUrl && !Array.isArray(options.rpcUrl)){
-    options.rpcUrl = [options.rpcUrl]
-  }
-
-   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 || ''
-  }
-
-  const collectRpcUrls = () => {
-    const rpcUrls: Record<string, string> = {}
-    for (const chain of Object.keys(supportedChains)) {
-      try {
-        rpcUrls[chain] = getEnv(`${chain.toUpperCase()}_RPC_URL`)
-      } catch (e) {}
-    }
-    return rpcUrls
-  }
 
+  // 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

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,21 @@ export const craftEndpoint = (
     majorVersion ? majorVersion + '/' : ''
   }graphql`
 }
+
+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 || ''
+}
+
+const collectRpcUrls = () => {
+  const rpcUrls: Record<string, string> = {}
+  for (const chain of Object.keys(supportedChains)) {
+    try {
+      rpcUrls[chain] = getEnv(`${chain.toUpperCase()}_RPC_URL`)
+    } catch (e) {}
+  }
+  return rpcUrls
+}

examples/block-handler-vaults/README.md

@@ -2,11 +2,11 @@
 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
-* Historical RPC (Infura, Ankr, Alchemy, etc)
+* Full Arkive RPC (Infura, Ankr, Alchemy, etc)
 
 ### Arkive Usage
 
-First make sure scripts/.env is configured correctly with your RPC endpoint. In this example we are connecting the `mainnet` with the Ankr public ETH endpoint.
+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.
 > RPC_URL=mainnet=https://rpc.ankr.com/eth
 
 All available tasks can been seen with

examples/block-handler-vaults/deno.jsonc

@@ -3,7 +3,7 @@
       "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": "scripts/resetdb.sh && arkiver start ./ -c mongodb://localhost:27017",
+      "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",

examples/erc20-balance-history/README.md

@@ -2,11 +2,11 @@
 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
-* Historical RPC (Infura, Ankr, Alchemy, etc)
+* Full Arkive RPC (Infura, Ankr, Alchemy, etc)
 
 ### Arkive Usage
 
-First make sure scripts/.env is configured correctly with your RPC endpoint. In this example we are connecting the `mainnet` with the Ankr public ETH endpoint.
+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.
 > RPC_URL=mainnet=https://rpc.ankr.com/eth
 
 All available tasks can been seen with

examples/erc20-balance-history/deno.jsonc

@@ -3,7 +3,7 @@
       "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": "scripts/resetdb.sh && arkiver start ./ -c mongodb://localhost:27017",
+      "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",

examples/erc20-events/README.md

@@ -2,11 +2,11 @@
 This Arkive has two entities, Transfer and Approval. The Arkive also has two corresponding event handlers onTransfer and onApproval which are triggered when the `Transfer` and `Approval` events are emitted by the source contract which is configured to `WETH` in the manifest. When the handlers are triggered they parse the amount and store either an Approval or Transfer entity in the database.
 ### Dependencies
 * Docker
-* Historical RPC (Infura, Ankr, Alchemy, etc)
+* Full Arkive RPC (Infura, Ankr, Alchemy, etc)
 
 ### Arkive Usage
 
-First make sure scripts/.env is configured correctly with your RPC endpoint. In this example we are connecting the `mainnet` with the Ankr public ETH endpoint.
+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.
 > RPC_URL=mainnet=https://rpc.ankr.com/eth
 
 All available tasks can been seen with

examples/erc20-events/deno.jsonc

@@ -3,7 +3,7 @@
       "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": "scripts/resetdb.sh && arkiver start ./ -c mongodb://localhost:27017",
+      "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",

examples/event-wildcard/README.md

@@ -13,11 +13,11 @@ In this example we are attaching to the Transfer event on all contracts. This me
 The event data is parsed into a human readable format and logged to the console.
 ### Dependencies
 * Docker
-* Historical RPC (Infura, Ankr, Alchemy, etc)
+* Full Arkive RPC (Infura, Ankr, Alchemy, etc)
 
 ### Arkive Usage
 
-First make sure scripts/.env is configured correctly with your RPC endpoint. In this example we are connecting the `mainnet` with the Ankr public ETH endpoint.
+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.
 > RPC_URL=mainnet=https://rpc.ankr.com/eth
 
 All available tasks can been seen with

examples/event-wildcard/deno.jsonc

@@ -3,7 +3,7 @@
       "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": "scripts/resetdb.sh && arkiver start ./ -c mongodb://localhost:27017",
+      "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",

examples/library/README.md

@@ -0,0 +1,34 @@
+# Simple Arkive
+This arkive handles `Transfer` events. It keeps track of the `Balance` entity. Balance starts at zero and in increased and decreased according to the `Transfer` event.
+### Dependencies
+* Docker
+* Full Arkive 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.
+> RPC_URL=mainnet=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 to get the latest Balance entity for this Arkive.
+```
+query MyQuery {
+  Balance(sort: _ID_DESC) {
+    account
+    amount
+    token
+    timestamp
+  }
+}
+```

examples/library/deno.jsonc

@@ -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/library/deps.ts

@@ -0,0 +1,10 @@
+export { formatUnits } from 'npm:viem'
+export {
+  createEntity,
+  type EventHandlerFor,
+  Manifest
+} from 'https://deno.land/x/robo_arkiver@v0.4.19/mod.ts'
+export {
+  type Erc721Opts,
+  Erc721Lib
+} from "https://deno.land/x/robo_arkiver@v0.4.19/libs.ts";

examples/library/manifest.ts

@@ -0,0 +1,14 @@
+import { Manifest, Erc721Lib, type Erc721Opts } from './deps.ts'
+
+const manifest = new Manifest('simple')
+
+const opts: Erc721Opts = {
+  contract: {"0xbd3531da5cf5857e7cfaa92426877b022e612cf8", 12876179},
+  async: true
+}
+
+manifest
+  .addChain('mainnet', { blockRange: 100n })
+  .use([Erc721Lib.create(opts)])
+    
+export default manifest.build()

examples/simple/README.md

@@ -6,7 +6,7 @@ This arkive handles `Transfer` events. It keeps track of the `Balance` entity. B
 
 ### Arkive Usage
 
-First make sure scripts/.env is configured correctly with your RPC endpoint. In this example we are connecting the `mainnet` with the Ankr public ETH endpoint.
+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.
 > RPC_URL=mainnet=https://rpc.ankr.com/eth
 
 All available tasks can been seen with

examples/simple/deno.jsonc

@@ -3,7 +3,7 @@
       "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": "scripts/resetdb.sh && arkiver start ./ -c mongodb://localhost:27017",
+      "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",