v2

ryansmith3136 · web-flow · commit a9b53595fca4 · 2025-04-28T22:09:52.000-07:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -15,3 +15,5 @@ jobs:
         with:
           node-version: 22
       - run: npm install && npm run test
+        env:
+          IS_KEY: ${{ secrets.IS_KEY }}
diff --git a/README.md b/README.md
@@ -17,19 +17,19 @@ Make a one-time query to get historical data:
 ```typescript
 import { query } from "@indexsupply/indexsupply.js";
 
-const { blockNumber, result } = await query({
+const { cursor, rows } = await query({
   apiKey: "face",
   chainId: 8453,
   query: 'select "from", "to", value from transfer limit 1',
-  eventSignatures: ['Transfer(address indexed from, address indexed to, uint256 value)'],
+  signatures: ['Transfer(address indexed from, address indexed to, uint256 value)'],
   formatRow: ([from, to, value]) => ({
     from: from as Address,
     to: to as Address,
     value: BigInt(value),
   }),
 })
 
-console.log(`Block ${blockNumber}:`, result)
+console.log(`Block ${cursor}:`, rows)
 ```
 
 ### Live Query
@@ -44,16 +44,16 @@ const q = queryLive({
   chainId: 8453,
   startBlock: async () => 1234567n,
   query: 'select "from", "to", value from transfer limit 1',
-  eventSignatures: ['Transfer(address indexed from, address indexed to, uint256 value)'],
+  signatures: ['Transfer(address indexed from, address indexed to, uint256 value)'],
   formatRow: ([from, to, value]) => ({
     from: from as Address,
     to: to as Address,
     value: BigInt(value),
   }),
 })
 
-for await (const { blockNumber, result } of q) {
-  console.log(`New data at block ${blockNumber}:`, result)
+for await (const { cursor, rows } of q) {
+  console.log(`New data at block ${cursor}:`, rows)
 }
 ```
 
@@ -71,7 +71,7 @@ const liveQuery = queryLive({
   },
   ...
 });
-for await (const { blockNumber, result } of liveQuery) {
+for await (const { cursor, rows } of liveQuery) {
   await pg.query("insert into my_table(block_num, ...) values (blockNumber, ...)");
 }
 ```
@@ -90,12 +90,12 @@ See [this page](https://indexsupply.github.io/indexsupply.js/examples/index.html
     </head>
     <script type="module">
         import { query } from "https://static.indexsupply.net/indexsupply.js";
-        const { blockNumber, result } = await query({
+        const { cursor, rows } = await query({
             chainId: 8453n,
-            eventSignatures: [],
+            signatures: [],
             query: "select block_num from logs limit 1",
         });
-        document.querySelector("body pre").textContent = JSON.stringify({ blockNumber, result });
+        document.querySelector("body pre").textContent = JSON.stringify({ cursor, rows});
     </script>
     <body>
         <pre></pre>
diff --git a/examples/index.html b/examples/index.html
@@ -6,7 +6,7 @@
         import { queryLive } from "https://static.indexsupply.net/indexsupply.js";
         const query = await queryLive({
             chainId: 8453n,
-            eventSignatures: ["Transfer(address indexed from, address indexed to, uint value)"],
+            signatures: ["Transfer(address indexed from, address indexed to, uint value)"],
             query: `select tx_hash, value from transfer limit 1`,
         });
         for await (const res of query) {
diff --git a/examples/live.ts b/examples/live.ts
@@ -20,7 +20,7 @@ const query = queryLive({
   abortSignal: controller.signal,
   startBlock: async () => (latest + 1n),
   chainId: 8453n,
-  eventSignatures: [
+  signatures: [
     "Transfer(address indexed from, address indexed to, uint256 v)",
   ],
   query: "select tx_hash, block_num from transfer limit 1",
@@ -32,8 +32,8 @@ const query = queryLive({
   },
 });
 
-for await (const { result } of query) {
-  result.forEach((row) => {
+for await (const { rows } of query) {
+  rows.forEach((row) => {
     if (row.block > latest) {
       latest = row.block;
     }
diff --git a/examples/ox-seaport/src/index.ts b/examples/ox-seaport/src/index.ts
@@ -6,7 +6,7 @@ setLogLevel(LogLevel.DEBUG);
 const orderFulfilled = AbiEvent.from("event OrderFulfilled(bytes32 orderHash, address indexed offerer, address indexed zone, address recipient, (uint8, address, uint256, uint256)[] offer, (uint8, address, uint256, uint256, address)[] consideration)");
 
 async function main() {
-  const { blockNumber, result } = await query({
+  const { cursor, rows } = await query({
     chainId: 1n,
     query: `
       select topics, data
@@ -24,7 +24,7 @@ async function main() {
     },
   });
 
-  result.forEach((order) => {
+  rows.forEach((order) => {
     console.log({ offer: order.offer, consideration: order.consideration });
   })
 }
diff --git a/examples/save-to-postgres/src/index.ts b/examples/save-to-postgres/src/index.ts
@@ -63,7 +63,7 @@ async function main() {
       return BigInt(res.rows[0].latest);
     },
     chainId: 8453n,
-    eventSignatures: [
+    signatures: [
       "Transfer(address indexed from, address indexed to, uint256 value)",
     ],
     query: `select tx_hash, block_num, "from", "to", value from transfer order by block_num desc limit 1`,
@@ -77,8 +77,8 @@ async function main() {
       };
     },
   });
-  for await (const { result } of query) {
-    await Promise.all(result.map(async (row) => {
+  for await (const { rows } of query) {
+    await Promise.all(rows.map(async (row) => {
       await pg.client!.query(`
         insert into my_transfers(block_num, "from", "to", value)
         values ($1, $2, $3, $4)
diff --git a/examples/single.ts b/examples/single.ts
@@ -1,15 +1,14 @@
-import { query } from "../src/index.ts";
+import { query, setLogLevel, LogLevel } from "../src/index.ts";
+setLogLevel(LogLevel.DEBUG);
 
-type Address = `0x${string}`;
-
-const { blockNumber, result } = await query({
+let { cursor, rows } = await query({
   chainId: 8453n,
-  eventSignatures: [
+  signatures: [
     "Transfer(address indexed from, address indexed to, uint256 value)",
   ],
   query:
     'select block_num, log_idx, "from", "to", "value" from transfer limit 5',
 });
 
-console.log(`current block: ${blockNumber}`);
-result.forEach((r) => console.log(r.block_num));
+console.log({ cursor: cursor });
+rows.forEach((r) => console.log(r.block_num));
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.0.15",
+  "version": "2.0.0",
   "name": "@indexsupply/indexsupply.js",
   "keywords": [
     "ethereum",
diff --git a/scripts/upload-browser-index.js b/scripts/upload-browser-index.js
@@ -1,11 +1,13 @@
 import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3";
 import { readFile } from "node:fs/promises";
+import { execSync } from "node:child_process";
 
+const gitSha = execSync("git rev-parse --short HEAD").toString().trim();
 const s3Client = new S3Client({ region: "us-west-2" });
 await s3Client.send(
   new PutObjectCommand({
     Bucket: "static.indexsupply.net",
-    Key: "indexsupply.js",
+    Key: `indexsupply.js-${gitSha}`,
     Body: await readFile("dist/index.js"),
     ContentType: "text/javascript",
   }),
diff --git a/src/index.ts b/src/index.ts
diff --git a/test/index.test.ts b/test/index.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "version": "0.0.15",`
	`2`	`+ "version": "2.0.0",`
`3`	`3`	`"name": "@indexsupply/indexsupply.js",`
`4`	`4`	`"keywords": [`
`5`	`5`	`"ethereum",`