Merge pull request #10 from RoboVault/fix/event-types

fix event type

CHANGELOG.md

@@ -1,5 +1,10 @@
 # v0.4.15
 - feat: populate relational entities on graphql endpoint
+- feat: add overload to `manifest.addChain` and `chain.addContract` functions to pass in a callback function that takes in a DataSourceBuilder and ContractBuilder instance respectively
+- feat: remove svn as a dependancy to run `arkiver init` command
+- change: deprecate `manifest.chain` for `manifest.addChain`
+- change: deprecate `manifest.contract` for `manifest.addContract`
+- change: `transactionIndex` and `logIndex` field in event is now number type to align with viem's return types
 - fix: missing event handler types due to updates to `viem` package
 
 # v0.4.14

cli.ts

@@ -97,11 +97,10 @@ command
 // init
 command
   .command('init', 'Initialize a new arkive project')
-  .option('--overwrite', 'Overwrite existing files')
-  .action(async (opts, ...args) => {
+  .action(async () => {
     util.logHeader(version)
     await checkVersion(version)
-    await init.action(opts, ...args)
+    await init.action()
   })
 
 // upgrade

cli/init/mod.ts

@@ -1,20 +1,22 @@
-import { $, Input, join, prompt, Select, Toggle, wait } from '../deps.ts'
+import { $, Input, join, prompt, Select, Toggle } from '../deps.ts'
 
-export const action = async (
-  options: { overwrite?: boolean },
-) => {
-  let spinner = wait('Fetching templates...').start()
+export const action = async () => {
+  let pb = $.progress('Fetching templates...')
 
-  const templatesRes = await fetch(
-    'https://api.github.com/repos/RoboVault/robo-arkiver/contents/examples',
-  )
+  let templatesRes: Response
 
-  if (!templatesRes.ok) {
-    console.log('Error fetching templates')
+  await pb.with(async () => {
+    templatesRes = await fetch(
+      'https://api.github.com/repos/RoboVault/robo-arkiver/contents/examples',
+    )
+  })
+
+  if (!templatesRes!.ok) {
+    console.log('Error fetching templates: ', templatesRes!.statusText)
     return
   }
 
-  const templates = await templatesRes.json() as {
+  const templates = await templatesRes!.json() as {
     name: string
     type: string
   }[]
@@ -28,8 +30,6 @@ export const action = async (
     name: t.name,
   }))
 
-  spinner.stop()
-
   const defaultPath = './cool-new-arkive'
 
   const arkive = await prompt([
@@ -62,31 +62,64 @@ export const action = async (
   const newDir = join(Deno.cwd(), arkive.dir ?? defaultPath)
   const template = arkive.template ?? templateNames[0].value
 
-  spinner = wait('Initializing arkive...').start()
+  pb = $.progress('Initializing arkive...')
 
-  const initRes = await $`svn export ${
-    options.overwrite ? `--force ` : ''
-  }https://github.com/RoboVault/robo-arkiver/trunk/examples/${template} ${newDir}`
-    .captureCombined(true)
+  try {
+    await $`git init ${newDir} && cd ${newDir} && git config core.sparseCheckout true`
+      .quiet('both')
 
-  if (initRes.code !== 0) {
-    spinner.fail(`Error initializing arkive: ${initRes.stderr}`)
-    return
-  }
-
-  if (arkive.vscode) {
-    const dir = arkive.dir ?? defaultPath
-    await Deno.mkdir(join(Deno.cwd(), dir, '.vscode'))
-
-    const vscode = `{
-	"deno.enable": true,
-	"deno.unstable": true
-}`
-    await Deno.writeTextFile(
-      join(Deno.cwd(), dir, '.vscode', 'settings.json'),
-      vscode,
+    await Deno.writeFile(
+      join(newDir, '.git', 'info', 'sparse-checkout'),
+      new TextEncoder().encode(`examples/${template}`),
     )
+
+    await $`git remote add origin https://github.com/RoboVault/robo-arkiver && git pull origin main && rm -rf .git`
+      .cwd(newDir)
+      .quiet('stdout')
+
+    // traverse the template directory and move all files to the root
+    for await (
+      const entry of Deno.readDir(join(newDir, `examples/${template}`))
+    ) {
+      const source = join(newDir, `examples/${template}`, entry.name)
+      const destination = join(newDir, entry.name)
+      await Deno.rename(source, destination)
+    }
+
+    await Deno.remove(join(newDir, 'examples'), { recursive: true })
+
+    if (arkive.vscode) {
+      const dir = arkive.dir ?? defaultPath
+      await Deno.mkdir(join(Deno.cwd(), dir, '.vscode'))
+
+      const vscode = `{
+    "deno.enable": true,
+    "deno.unstable": true
+  }`
+      await Deno.writeTextFile(
+        join(Deno.cwd(), dir, '.vscode', 'settings.json'),
+        vscode,
+      )
+
+      const gitignore = `/.vscode
+  /.vscode/*
+  /.vscode/**/*
+  `
+      await Deno.writeTextFile(
+        join(Deno.cwd(), dir, '.gitignore'),
+        gitignore,
+      )
+    }
+
+    await $`git init && git add . && git commit -m "Initial commit"`
+      .cwd(newDir)
+      .quiet('stdout')
+  } catch (e) {
+    $.logError(`Error initializing arkive: ${e}`)
+    return
   }
 
-  spinner.succeed('Initialized arkive')
+  // spinner.succeed('Initialized arkive')
+  pb.finish()
+  $.logStep('Initialized arkive')
 }

examples/block-handler-vaults/deps.ts

@@ -3,4 +3,4 @@ export {
   createEntity,
   type EventHandlerFor,
   Manifest,
-} from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+} from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'

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

@@ -1,5 +1,5 @@
 import { formatUnits, getContract } from 'npm:viem'
-import { type BlockHandler } from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+import { type BlockHandler } from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'
 import { VaultSnapshot } from '../entities/vault.ts'
 import { YearnV2Abi } from '../abis/YearnV2.ts'
 

examples/block-handler-vaults/manifest.ts

@@ -1,12 +1,12 @@
-import { Manifest } from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+import { Manifest } from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'
 import { VaultSnapshot } from './entities/vault.ts'
 import { snapshotVault } from './handlers/vault.ts'
 
 const manifest = new Manifest('yearn-vaults')
 
 manifest
   .addEntity(VaultSnapshot)
-  .chain('mainnet')
+  .addChain('mainnet')
   .addBlockHandler({
     blockInterval: 1000,
     startBlockHeight: 12790000n,

examples/erc20-balance-history/entities.ts

@@ -1,4 +1,4 @@
-import { createEntity } from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+import { createEntity } from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'
 
 // @note: "Index: true" enhances graphql queries
 

examples/erc20-balance-history/handlers.ts

@@ -1,5 +1,5 @@
 import { formatUnits } from 'npm:viem'
-import { type EventHandlerFor } from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+import { type EventHandlerFor } from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'
 import erc20 from './erc20.ts'
 import { Balance, BalanceHistory, Transfer } from './entities.ts'
 

examples/erc20-balance-history/manifest.ts

@@ -1,4 +1,4 @@
-import { Manifest } from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+import { Manifest } from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'
 import erc20 from './erc20.ts'
 import { Entities } from './entities.ts'
 import { onTransfer } from './handlers.ts'
@@ -7,8 +7,8 @@ const manifest = new Manifest('frax-balances')
 
 manifest
   .addEntities(Entities)
-  .chain('mainnet', { blockRange: 500n })
-  .contract(erc20)
+  .addChain('mainnet', { blockRange: 500n })
+  .addContract(erc20)
   .addSources({ '0x853d955aCEf822Db058eb8505911ED77F175b99e': 11465581n })
   .addEventHandlers({ 'Transfer': onTransfer })
 

examples/erc20-events/entities.ts

@@ -1,4 +1,4 @@
-import { createEntity } from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+import { createEntity } from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'
 
 // @note: "Index: true" enhances graphql queries
 export const Transfer = createEntity('Transfer', {

examples/erc20-events/handlers.ts

@@ -1,5 +1,5 @@
 import { formatUnits } from 'npm:viem'
-import { type EventHandlerFor } from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+import { type EventHandlerFor } from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'
 import erc20 from './erc20.ts'
 import { Approval, Transfer } from './entities.ts'
 

examples/erc20-events/manifest.ts

@@ -1,4 +1,4 @@
-import { Manifest } from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+import { Manifest } from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'
 import erc20 from './erc20.ts'
 import { Approval, Transfer } from './entities.ts'
 import { onApproval, onTransfer } from './handlers.ts'
@@ -7,8 +7,8 @@ const manifest = new Manifest('weth-events')
 
 manifest
   .addEntities([Transfer, Approval])
-  .chain('mainnet', { blockRange: 500n })
-  .contract('ERC20', erc20)
+  .addChain('mainnet', { blockRange: 500n })
+  .addContract('ERC20', erc20)
   .addSources({ '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2': 4729568n })
   .addEventHandlers({ 'Transfer': onTransfer })
   .addEventHandlers({ 'Approval': onApproval })

examples/event-wildcard/deps.ts

@@ -3,4 +3,4 @@ export {
   createEntity,
   type EventHandlerFor,
   Manifest,
-} from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+} from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'

examples/event-wildcard/manifest.ts

@@ -5,8 +5,8 @@ import { transferHandler } from './handlers/transfer.ts'
 const manifest = new Manifest('agnostic-events')
 
 manifest
-  .chain('avalanche', { blockRange: 100n })
-  .contract('ERC20', erc20)
+  .addChain('avalanche', { blockRange: 100n })
+  .addContract('ERC20', erc20)
   .addSources({ '*': 27347402n })
   .addEventHandlers({ 'Transfer': transferHandler })
 

examples/simple/deps.ts

@@ -3,4 +3,4 @@ export {
   createEntity,
   type EventHandlerFor,
   Manifest,
-} from 'https://deno.land/x/robo_arkiver@v0.4.14/mod.ts'
+} from 'https://deno.land/x/robo_arkiver@v0.4.15/mod.ts'

examples/simple/manifest.ts

@@ -7,8 +7,8 @@ const manifest = new Manifest('simple')
 
 manifest
   .addEntity(Balance)
-  .chain('mainnet', { blockRange: 100n })
-  .contract('ERC20', erc20)
+  .addChain('mainnet', { blockRange: 100n })
+  .addContract('ERC20', erc20)
   .addSources({ '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2': 16987011n })
   .addEventHandlers({ 'Transfer': transferHandler })
 

src/arkiver/data-source.ts

@@ -132,7 +132,7 @@ export class DataSource extends EventTarget {
     this.contracts = params.contracts
     this.blockSources = params.blockSources
     this.client = createPublicClient({
-      chain: getChainObjFromChainName(this.chain),
+      chain: getChainObjFromChainName(this.chain) as any,
       transport: http(this.rpcUrl),
     })
     this.arkiveId = params.arkiveId
@@ -587,7 +587,7 @@ export class DataSource extends EventTarget {
                 eventName: event.eventName,
                 client: this.client,
                 store: this.store,
-                event: formatLog(log, event),
+                event: formatLog(log, event as any),
                 contract: getContract({
                   abi: handler.abi,
                   address: log.address,
@@ -682,7 +682,7 @@ export class DataSource extends EventTarget {
                 eventName: event.eventName,
                 client: this.client,
                 store: this.store,
-                event: formatLog(log, event),
+                event: formatLog(log, event as any),
                 contract: getContract({
                   abi: eventHandler.abi,
                   address: log.address,