Ensure Schema compliance with execution-apis schema (#372)

* Add openrpc integration tests Signed-off-by: Anton Rusev <[email protected]>
hashgraph · Jul 26, 2022 · 5af00f9 · 5af00f9
1 parent 5fd35e3
commit 5af00f9
Show file tree

Hide file tree

Showing 10 changed files with 778 additions and 56 deletions.
diff --git a/docs/openrpc.json b/docs/openrpc.json
@@ -131,7 +131,8 @@
                         "items": {
                             "title": "rewardPercentile",
                             "description": "Floating point value between 0 and 100.",
-                            "type": "number"
+                            "type": "number",
+                            "pattern": "^[0-9][0-9]?$|^100$"
                         }
                     }
                 }
@@ -159,7 +160,9 @@
                             "description": "An array of gas used ratio.",
                             "type": "array",
                             "items": {
-                                "$ref": "#/components/schemas/uint"
+                                "title": "hex encoded unsigned integer",
+                                "type": "string",
+                                "pattern": "^0x([1-9a-f]+[0-9a-f]*|0|0.8)$"
                             }
                         },
                         "baseFeePerGas": {
@@ -358,11 +361,7 @@
             "result": {
                 "name": "Log objects",
                 "schema": {
-                    "title": "Filter results",
-                    "type": "array",
-                    "items": {
-                        "$ref": "#/components/schemas/FilterResults"
-                    }
+                    "$ref": "#/components/schemas/FilterResults"
                 }
             }
         },
@@ -460,10 +459,7 @@
                 "name": "Transaction count",
                 "schema": {
                     "title": "Transaction count",
-                    "type": "array",
-                    "items": {
-                        "$ref": "#/components/schemas/uint"
-                    }
+                    "$ref": "#/components/schemas/uint"
                 }
             }
         },
@@ -683,7 +679,7 @@
                 "name": "The current client version.",
                 "schema": {
                     "type": "string",
-                    "pattern": "relay/<semanticVersion>"
+                    "pattern": "relay\/[0-9]\\.[0-9]\\.[0-9]"
                 }
             }
         }
@@ -1378,6 +1374,11 @@
                             "title": "Error message",
                             "type": "string",
                             "pattern": "Unsupported JSON-RPC method"
+                        },
+                        "name": {
+                            "title": "Error name",
+                            "type": "string",
+                            "pattern": "Method not found"
                         }
                     }
                 }

diff --git a/package.json b/package.json
@@ -35,7 +35,7 @@
         "start": "npx lerna exec --scope @hashgraph/json-rpc-server -- npm run start",
         "start:docker": "docker run --name hedera-relay -d -p 7546:7546 ${npm_package_name}:latest",
         "test": "npx lerna run test",
-        "openrpctest": "ts-mocha packages/server/tests/integration/openrpc.spec.ts",
+        "openrpctest": "ts-mocha packages/relay/tests/lib/openrpc.spec.ts --exit",
         "integration:prerequisite": "ts-node packages/server/tests/helpers/prerequisite.ts"
     },
     "dependencies": {

diff --git a/packages/relay/src/index.ts b/packages/relay/src/index.ts
@@ -61,9 +61,9 @@ export interface Eth {
 
   getBlockByNumber(blockNum: string, showDetails: boolean): Promise<Block | null>;
 
-  getBlockTransactionCountByHash(hash: string): Promise<number | null>;
+  getBlockTransactionCountByHash(hash: string): Promise<string | null>;
 
-  getBlockTransactionCountByNumber(blockNum: string): Promise<number | null>
+  getBlockTransactionCountByNumber(blockNum: string): Promise<string | null>
 
   getCode(address: string, blockNumber: string | null): Promise<string>;
 

diff --git a/packages/relay/src/lib/eth.ts b/packages/relay/src/lib/eth.ts
@@ -530,7 +530,7 @@ export class EthImpl implements Eth {
    *
    * @param hash
    */
-  async getBlockTransactionCountByHash(hash: string): Promise<number | null> {
+  async getBlockTransactionCountByHash(hash: string): Promise<string | null> {
     this.logger.trace('getBlockTransactionCountByHash(hash=%s, showDetails=%o)', hash);
     return this.mirrorNodeClient
       .getBlock(hash)
@@ -545,7 +545,7 @@ export class EthImpl implements Eth {
    * Gets the number of transaction in a block by its block number.
    * @param blockNumOrTag
    */
-  async getBlockTransactionCountByNumber(blockNumOrTag: string): Promise<number | null> {
+  async getBlockTransactionCountByNumber(blockNumOrTag: string): Promise<string | null> {
     this.logger.trace('getBlockTransactionCountByNumber(blockNum=%s, showDetails=%o)', blockNumOrTag);
     const blockNum = await this.translateBlockTag(blockNumOrTag);
     return this.mirrorNodeClient
@@ -751,13 +751,13 @@ export class EthImpl implements Eth {
       input: contractResult.function_parameters,
       maxPriorityFeePerGas: maxPriorityFee,
       maxFeePerGas: maxFee,
-      nonce: contractResult.nonce,
+      nonce: EthImpl.nullableNumberTo0x(contractResult.nonce),
       r: rSig,
       s: sSig,
       to: contractResult.to?.substring(0, 42),
       transactionIndex: EthImpl.numberTo0x(contractResult.transaction_index),
-      type: contractResult.type,
-      v: contractResult.v,
+      type: EthImpl.nullableNumberTo0x(contractResult.type),
+      v: EthImpl.nullableNumberTo0x(contractResult.v),
       value: EthImpl.numberTo0x(contractResult.amount),
     });
   }
@@ -836,6 +836,10 @@ export class EthImpl implements Eth {
     return EthImpl.emptyHex + input.toString(16);
   }
 
+  static nullableNumberTo0x(input: number | BigNumber): string | null {
+    return input === null ? null : EthImpl.numberTo0x(input);
+  }
+
   static toHash32(value: string): string {
     return value.substring(0, 66);
   }
@@ -970,7 +974,7 @@ export class EthImpl implements Eth {
       return null;
     }
 
-    return block.count;
+    return EthImpl.numberTo0x(block.count);
   }
 
   private getTransactionFromContractResults(contractResults: any) {
@@ -1006,13 +1010,13 @@ export class EthImpl implements Eth {
           input: contractResultDetails.function_parameters,
           maxPriorityFeePerGas: EthImpl.toNullIfEmptyHex(contractResultDetails.max_priority_fee_per_gas),
           maxFeePerGas: EthImpl.toNullIfEmptyHex(contractResultDetails.max_fee_per_gas),
-          nonce: contractResultDetails.nonce,
+          nonce: EthImpl.nullableNumberTo0x(contractResultDetails.nonce),
           r: rSig,
           s: sSig,
           to: contractResultDetails.to.substring(0, 42),
           transactionIndex: EthImpl.numberTo0x(contractResultDetails.transaction_index),
-          type: contractResultDetails.type,
-          v: contractResultDetails.v,
+          type: EthImpl.nullableNumberTo0x(contractResultDetails.type),
+          v: EthImpl.nullableNumberTo0x(contractResultDetails.v),
           value: EthImpl.numberTo0x(contractResultDetails.amount),
         });
       })