Support non-standard RPC methods for indexing services

.docker/docker-entrypoint-initdb.d/init.txt

@@ -492,6 +492,67 @@ BEGIN
   RETURN result;
 END;
 $$ LANGUAGE plpgsql VOLATILE PARALLEL UNSAFE;
+DROP FUNCTION IF EXISTS eth_getTransactionReceiptsByBlockNumber(blockno) RESTRICT;
+
+CREATE FUNCTION eth_getTransactionReceiptsByBlockNumber(block_id blockno) RETURNS setof transaction_receipt AS $$
+DECLARE
+  result transaction_receipt;
+BEGIN
+	FOR result IN
+    SELECT
+        b.id AS "blockNumber",
+        b.hash AS "blockHash",
+        t.index AS "transactionIndex",
+        t.hash AS "transactionHash",
+        t.from AS "from",
+        t.to AS "to",
+        t.gas_used AS "gasUsed",
+        0::u256 AS "cumulativeGasUsed", -- TODO: tally?
+        CASE WHEN (t.to IS NULL OR t.to = '\x0000000000000000000000000000000000000000') AND length(t.output) = 20 THEN t.output
+             ELSE NULL
+        END AS "contractAddress",
+        NULL AS "logs",                 -- TODO: fetch event.id[]
+        repeat('\\000', 256)::bytea AS "logsBloom",
+        CASE WHEN t.status THEN 1 ELSE 0 END AS "status"
+      FROM transaction t
+        LEFT JOIN block b ON t.block = b.id
+      WHERE b.id = block_id
+  LOOP 
+	  RETURN NEXT result;
+	END LOOP; 
+END;
+$$ LANGUAGE plpgsql VOLATILE PARALLEL UNSAFE;
+DROP FUNCTION IF EXISTS eth_getTransactionsByBlockNumber(blockno) RESTRICT;
+
+CREATE FUNCTION eth_getTransactionsByBlockNumber(block_id blockno) RETURNS setof transaction_result AS $$
+DECLARE
+  result transaction_result;
+BEGIN
+	FOR result IN
+	  SELECT
+        b.id AS "blockNumber",
+        b.hash AS "blockHash",
+        t.index AS "transactionIndex",
+        t.hash AS "hash",
+        t.from AS "from",
+        t.to AS "to",
+        t.gas_limit AS "gas",
+        t.gas_price AS "gasPrice",
+        t.nonce AS "nonce",
+        t.value AS "value",
+        coalesce(t.input, '\\x'::bytea) AS "input",
+        t.v AS "v",
+        t.r AS "r",
+        t.s AS "s"
+      FROM transaction t
+      LEFT JOIN block b ON t.block = b.id
+      WHERE b.id = block_id
+	LOOP 
+	  RETURN NEXT result;
+	END LOOP;
+END;
+$$ LANGUAGE plpgsql VOLATILE PARALLEL UNSAFE;
+
 DROP FUNCTION IF EXISTS eth_getUncleByBlockHashAndIndex(hash, int) RESTRICT;
 
 CREATE FUNCTION eth_getUncleByBlockHashAndIndex(block_hash hash, uncle_index int) RETURNS block_result AS $$

etc/methods.yaml

@@ -235,6 +235,20 @@ eth_getTransactionReceipt:
   implementations:
     - src/servers/skeleton.ts
 
+eth_getTransactionReceiptsByBlockNumber:
+  status: ok
+  comment: Non Standard Methods
+  link: 
+  implementations:
+    - src/servers/skeleton.ts
+
+eth_getTransactionsByBlockNumber:
+  status: ok
+  comment: Non Standard Methods
+  link: 
+  implementations:
+    - src/servers/skeleton.ts
+
 eth_getUncleByBlockHashAndIndex:
   status: ok
   comment:

etc/schema.sql

@@ -20,6 +20,8 @@
 \i etc/schema/functions/eth_getTransactionByHash.sql
 \i etc/schema/functions/eth_getTransactionCount.sql
 \i etc/schema/functions/eth_getTransactionReceipt.sql
+\i etc/schema/functions/eth_getTransactionReceiptsByBlockNumber.sql
+\i etc/schema/functions/eth_getTransactionsByBlockNumber.sql
 \i etc/schema/functions/eth_getUncleByBlockHashAndIndex.sql
 \i etc/schema/functions/eth_getUncleByBlockNumberAndIndex.sql
 \i etc/schema/functions/eth_getUncleCountByBlockHash.sql
@@ -28,3 +30,4 @@
 \i etc/schema/functions/eth_newFilter.sql
 \i etc/schema/functions/eth_newPendingTransactionFilter.sql
 \i etc/schema/functions/eth_uninstallFilter.sql
+

etc/schema/functions/eth_getTransactionReceiptsByBlockNumber.sql

@@ -0,0 +1,30 @@
+DROP FUNCTION IF EXISTS eth_getTransactionReceiptsByBlockNumber(blockno) RESTRICT;
+
+CREATE FUNCTION eth_getTransactionReceiptsByBlockNumber(block_id blockno) RETURNS setof transaction_receipt AS $$
+DECLARE
+  result transaction_receipt;
+BEGIN
+	FOR result IN
+    SELECT
+        b.id AS "blockNumber",
+        b.hash AS "blockHash",
+        t.index AS "transactionIndex",
+        t.hash AS "transactionHash",
+        t.from AS "from",
+        t.to AS "to",
+        t.gas_used AS "gasUsed",
+        0::u256 AS "cumulativeGasUsed", -- TODO: tally?
+        CASE WHEN (t.to IS NULL OR t.to = '\x0000000000000000000000000000000000000000') AND length(t.output) = 20 THEN t.output
+             ELSE NULL
+        END AS "contractAddress",
+        NULL AS "logs",                 -- TODO: fetch event.id[]
+        repeat('\\000', 256)::bytea AS "logsBloom",
+        CASE WHEN t.status THEN 1 ELSE 0 END AS "status"
+      FROM transaction t
+        LEFT JOIN block b ON t.block = b.id
+      WHERE b.id = block_id
+  LOOP 
+	  RETURN NEXT result;
+	END LOOP; 
+END;
+$$ LANGUAGE plpgsql VOLATILE PARALLEL UNSAFE;

etc/schema/functions/eth_getTransactionsByBlockNumber.sql

@@ -0,0 +1,32 @@
+DROP FUNCTION IF EXISTS eth_getTransactionsByBlockNumber(blockno) RESTRICT;
+
+CREATE FUNCTION eth_getTransactionsByBlockNumber(block_id blockno) RETURNS setof transaction_result AS $$
+DECLARE
+  result transaction_result;
+BEGIN
+	FOR result IN
+	  SELECT
+        b.id AS "blockNumber",
+        b.hash AS "blockHash",
+        t.index AS "transactionIndex",
+        t.hash AS "hash",
+        t.from AS "from",
+        t.to AS "to",
+        t.gas_limit AS "gas",
+        t.gas_price AS "gasPrice",
+        t.nonce AS "nonce",
+        t.value AS "value",
+        coalesce(t.input, '\\x'::bytea) AS "input",
+        t.v AS "v",
+        t.r AS "r",
+        t.s AS "s"
+      FROM transaction t
+      LEFT JOIN block b ON t.block = b.id
+      WHERE b.id = block_id
+	LOOP 
+	  RETURN NEXT result;
+	END LOOP;
+END;
+
+
+$$ LANGUAGE plpgsql VOLATILE PARALLEL UNSAFE;

lib/servers/database.d.ts

@@ -27,6 +27,8 @@ export declare class DatabaseServer extends SkeletonServer {
     eth_getTransactionByHash(_request: Request, transactionHash: web3.Data): Promise<web3.TransactionResult | null>;
     eth_getTransactionCount(_request: Request, address: web3.Data, blockNumber: web3.Quantity | web3.Tag): Promise<web3.Quantity>;
     eth_getTransactionReceipt(_request: Request, transactionHash: string): Promise<web3.TransactionReceipt | null>;
+    eth_getTransactionReceiptsByBlockNumber(_request: any, blockNumber: web3.Quantity | web3.Tag): Promise<web3.TransactionReceipt[] | null>;
+    eth_getTransactionsByBlockNumber(_request: any, blockNumber: web3.Quantity | web3.Tag): Promise<web3.TransactionResult | null>;
     eth_getUncleCountByBlockHash(_request: Request, blockHash: web3.Data): Promise<web3.Quantity | null>;
     eth_getUncleCountByBlockNumber(_request: Request, blockNumber: web3.Quantity | web3.Tag): Promise<web3.Quantity | null>;
     eth_newBlockFilter(_request: Request): Promise<web3.Quantity>;

lib/servers/skeleton.d.ts

@@ -48,6 +48,8 @@ export declare abstract class SkeletonServer implements web3.Service {
     eth_getTransactionByHash(_request: Request, _transactionHash: web3.Data): Promise<web3.TransactionResult | null>;
     eth_getTransactionCount(_request: Request, _address: web3.Data, _blockNumber: web3.Quantity | web3.Tag): Promise<web3.Quantity>;
     eth_getTransactionReceipt(_request: Request, _transactionHash: string): Promise<web3.TransactionReceipt | null>;
+    eth_getTransactionReceiptsByBlockNumber(_request: any, _blockNumber: web3.Quantity | web3.Tag): Promise<web3.TransactionReceipt[] | null>;
+    eth_getTransactionsByBlockNumber(_request: any, _blockNumber: web3.Quantity | web3.Tag): Promise<web3.TransactionResult | null>;
     eth_getUncleByBlockHashAndIndex(_request: Request, _blockHash: web3.Data, _uncleIndex: web3.Quantity): Promise<web3.BlockResult | null>;
     eth_getUncleByBlockNumberAndIndex(_request: Request, _blockNumber: web3.Quantity | web3.Tag, _uncleIndex: web3.Quantity): Promise<web3.BlockResult | null>;
     eth_getUncleCountByBlockHash(_request: Request, _blockHash: web3.Data): Promise<web3.Quantity | null>;

lib/web3.d.ts

@@ -82,6 +82,8 @@ export interface Service {
     eth_getTransactionByHash(_request: Request, transactionHash: Data): Promise<TransactionResult | null>;
     eth_getTransactionCount(_request: Request, address: Data, blockNumber: Quantity | Tag): Promise<Quantity>;
     eth_getTransactionReceipt(_request: Request, transactionHash: string): Promise<TransactionReceipt | null>;
+    eth_getTransactionReceiptsByBlockNumber(_request: any, blockNumber: Quantity | Tag): Promise<TransactionReceipt[] | null>;
+    eth_getTransactionsByBlockNumber(_request: any, blockNumber: Quantity | Tag): Promise<TransactionResult | null>;
     eth_getUncleByBlockHashAndIndex(_request: Request, blockHash: Data, uncleIndex: Quantity): Promise<BlockResult | null>;
     eth_getUncleByBlockNumberAndIndex(_request: Request, blockNumber: Quantity | Tag, uncleIndex: Quantity): Promise<BlockResult | null>;
     eth_getUncleCountByBlockHash(_request: Request, blockHash: Data): Promise<Quantity | null>;

src/servers/database.ts

@@ -557,7 +557,60 @@ export class DatabaseServer extends SkeletonServer {
       return null;
     }
   }
+  async eth_getTransactionReceiptsByBlockNumber(
+    _request: any,
+    blockNumber: web3.Quantity | web3.Tag
+  ): Promise<web3.TransactionReceipt[] | null> {
+    const blockNumber_ =
+      parseBlockSpec(blockNumber) != 0
+        ? parseBlockSpec(blockNumber) || (await this._fetchCurrentBlockID())
+        : parseBlockSpec(blockNumber);
+    try {
+      const {
+        rows,
+      } = await this._query(
+        'SELECT * FROM eth_getTransactionReceiptsByBlockNumber($1)',
+        [blockNumber_]
+      );
+      for (let i = 0; i < rows.length; i++) {
+        rows[i].logs = await this._fetchEvents(
+          hexToBytes(rows[i].transactionHash.toString())
+        );
+      }
+      return exportJSON(rows);
+    } catch (error) {
+      if (this.config.debug) {
+        console.debug('eth_getTransactionReceiptsByBlockNumber', error);
+      }
+      return null;
+    }
+  }
 
+  async eth_getTransactionsByBlockNumber(
+    _request: any,
+    blockNumber: web3.Quantity | web3.Tag
+  ): Promise<web3.TransactionResult | null> {
+    const blockNumber_ =
+      parseBlockSpec(blockNumber) != 0
+        ? parseBlockSpec(blockNumber) || (await this._fetchCurrentBlockID())
+        : parseBlockSpec(blockNumber);
+
+    try {
+      const {
+        rows,
+      } = await this._query(
+        'SELECT * FROM eth_getTransactionsByBlockNumber($1)',
+        [blockNumber_]
+      );
+      return !rows || !rows.length ? null : exportJSON(rows);
+    } catch (error) {
+      if (this.config.debug) {
+        console.debug('eth_getTransactionsByBlockNumber', error);
+      }
+      return null;
+    }
+  }
+
   async eth_getUncleCountByBlockHash(
     _request: Request,
     blockHash: web3.Data

src/servers/skeleton.ts

@@ -315,6 +315,22 @@ export abstract class SkeletonServer implements web3.Service {
     unimplemented('eth_getTransactionReceipt');
     return null;
   }
+
+  async eth_getTransactionReceiptsByBlockNumber(
+    _request: any,
+    _blockNumber: web3.Quantity | web3.Tag
+  ): Promise<web3.TransactionReceipt[] | null> {
+    unimplemented('eth_getTransactionReceiptsByBlockNumber');
+    return null;
+  }
+
+  async eth_getTransactionsByBlockNumber(
+    _request: any,
+    _blockNumber: web3.Quantity | web3.Tag
+  ): Promise<web3.TransactionResult | null> {
+    unimplemented('eth_getTransactionsByBlockNumber');
+    return null;
+  }
 
   async eth_getUncleByBlockHashAndIndex(
     _request: Request,

src/web3.ts

@@ -148,6 +148,7 @@ export interface Service {
     blockHash: Data,
     transactionIndex: Quantity
   ): Promise<TransactionResult | null>;
+
   eth_getTransactionByBlockNumberAndIndex(
     _request: Request,
     blockNumber: Quantity | Tag,
@@ -166,6 +167,14 @@ export interface Service {
     _request: Request,
     transactionHash: string
   ): Promise<TransactionReceipt | null>;
+  eth_getTransactionReceiptsByBlockNumber(
+    _request: any,
+    blockNumber:  Quantity | Tag,
+  ): Promise<TransactionReceipt[] | null>;
+  eth_getTransactionsByBlockNumber(
+    _request: any,
+    blockNumber:  Quantity | Tag,
+  ): Promise<TransactionResult | null>;
   eth_getUncleByBlockHashAndIndex(
     _request: Request,
     blockHash: Data,