Implement queries for multiple return type eth_calls (#12)

* Implement multiple return type for ConditionalStarRelease eth_call

* Generate ConditionalStarRelease watcher from codegen handling multiple return type

* Generate azimuth watcher from codegen handling multiple return type

* Upgrade watcher-ts package versions

packages/azimuth-watcher/README.md

@@ -1,11 +1,5 @@
 # azimuth-watcher
 
-## Currently unsupported queries
-
-The watcher was generated in `eth_call` mode and does not support the following queries in its current state:
-
-* `getKeys(uint32 _point) returns (bytes32 crypt, bytes32 auth, uint32 suite, uint32 revision)`
-
 ## Setup
 
 * Run the following command to install required packages:

packages/azimuth-watcher/package.json

@@ -39,10 +39,10 @@
   "dependencies": {
     "@apollo/client": "^3.3.19",
     "@ethersproject/providers": "^5.4.4",
-    "@cerc-io/cli": "^0.2.39",
-    "@cerc-io/ipld-eth-client": "^0.2.39",
-    "@cerc-io/solidity-mapper": "^0.2.39",
-    "@cerc-io/util": "^0.2.39",
+    "@cerc-io/cli": "^0.2.40",
+    "@cerc-io/ipld-eth-client": "^0.2.40",
+    "@cerc-io/solidity-mapper": "^0.2.40",
+    "@cerc-io/util": "^0.2.40",
     "apollo-type-bigint": "^0.1.3",
     "debug": "^4.3.1",
     "ethers": "^5.4.4",

packages/azimuth-watcher/src/client.ts

@@ -26,6 +26,15 @@ export class Client {
     return isActive;
   }
 
+  async getGetKeys (blockHash: string, contractAddress: string, _point: bigint): Promise<any> {
+    const { getKeys } = await this._client.query(
+      gql(queries.getKeys),
+      { blockHash, contractAddress, _point }
+    );
+
+    return getKeys;
+  }
+
   async getGetKeyRevisionNumber (blockHash: string, contractAddress: string, _point: bigint): Promise<any> {
     const { getKeyRevisionNumber } = await this._client.query(
       gql(queries.getKeyRevisionNumber),

packages/azimuth-watcher/src/database.ts

@@ -21,6 +21,7 @@ import { StateSyncStatus } from './entity/StateSyncStatus';
 import { BlockProgress } from './entity/BlockProgress';
 import { State } from './entity/State';
 import { IsActive } from './entity/IsActive';
+import { GetKeys } from './entity/GetKeys';
 import { GetKeyRevisionNumber } from './entity/GetKeyRevisionNumber';
 import { HasBeenLinked } from './entity/HasBeenLinked';
 import { IsLive } from './entity/IsLive';
@@ -56,7 +57,7 @@ import { CanTransfer } from './entity/CanTransfer';
 import { GetTransferringForCount } from './entity/GetTransferringForCount';
 import { IsOperator } from './entity/IsOperator';
 
-export const ENTITIES = [IsActive, GetKeyRevisionNumber, HasBeenLinked, IsLive, GetContinuityNumber, GetSpawnCount, HasSponsor, GetSponsor, IsSponsor, GetSponsoringCount, IsEscaping, GetEscapeRequest, IsRequestingEscapeTo, GetEscapeRequestsCount, GetOwner, IsOwner, GetOwnedPointCount, GetOwnedPointAtIndex, GetManagementProxy, IsManagementProxy, CanManage, GetManagerForCount, GetSpawnProxy, IsSpawnProxy, CanSpawnAs, GetSpawningForCount, GetVotingProxy, IsVotingProxy, CanVoteAs, GetVotingForCount, GetTransferProxy, IsTransferProxy, CanTransfer, GetTransferringForCount, IsOperator];
+export const ENTITIES = [IsActive, GetKeys, GetKeyRevisionNumber, HasBeenLinked, IsLive, GetContinuityNumber, GetSpawnCount, HasSponsor, GetSponsor, IsSponsor, GetSponsoringCount, IsEscaping, GetEscapeRequest, IsRequestingEscapeTo, GetEscapeRequestsCount, GetOwner, IsOwner, GetOwnedPointCount, GetOwnedPointAtIndex, GetManagementProxy, IsManagementProxy, CanManage, GetManagerForCount, GetSpawnProxy, IsSpawnProxy, CanSpawnAs, GetSpawningForCount, GetVotingProxy, IsVotingProxy, CanVoteAs, GetVotingForCount, GetTransferProxy, IsTransferProxy, CanTransfer, GetTransferringForCount, IsOperator];
 
 export class Database implements DatabaseInterface {
   _config: ConnectionOptions;
@@ -98,6 +99,15 @@ export class Database implements DatabaseInterface {
       });
   }
 
+  async getGetKeys ({ blockHash, contractAddress, _point }: { blockHash: string, contractAddress: string, _point: bigint }): Promise<GetKeys | undefined> {
+    return this._conn.getRepository(GetKeys)
+      .findOne({
+        blockHash,
+        contractAddress,
+        _point
+      });
+  }
+
   async getGetKeyRevisionNumber ({ blockHash, contractAddress, _point }: { blockHash: string, contractAddress: string, _point: bigint }): Promise<GetKeyRevisionNumber | undefined> {
     return this._conn.getRepository(GetKeyRevisionNumber)
       .findOne({
@@ -423,6 +433,12 @@ export class Database implements DatabaseInterface {
     return repo.save(entity);
   }
 
+  async saveGetKeys ({ blockHash, blockNumber, contractAddress, _point, value, proof }: DeepPartial<GetKeys>): Promise<GetKeys> {
+    const repo = this._conn.getRepository(GetKeys);
+    const entity = repo.create({ blockHash, blockNumber, contractAddress, _point, value, proof });
+    return repo.save(entity);
+  }
+
   async saveGetKeyRevisionNumber ({ blockHash, blockNumber, contractAddress, _point, value, proof }: DeepPartial<GetKeyRevisionNumber>): Promise<GetKeyRevisionNumber> {
     const repo = this._conn.getRepository(GetKeyRevisionNumber);
     const entity = repo.create({ blockHash, blockNumber, contractAddress, _point, value, proof });
@@ -833,6 +849,7 @@ export class Database implements DatabaseInterface {
 
   _setPropColMaps (): void {
     this._propColMaps.IsActive = this._getPropertyColumnMapForEntity('IsActive');
+    this._propColMaps.GetKeys = this._getPropertyColumnMapForEntity('GetKeys');
     this._propColMaps.GetKeyRevisionNumber = this._getPropertyColumnMapForEntity('GetKeyRevisionNumber');
     this._propColMaps.HasBeenLinked = this._getPropertyColumnMapForEntity('HasBeenLinked');
     this._propColMaps.IsLive = this._getPropertyColumnMapForEntity('IsLive');

packages/azimuth-watcher/src/entity/GetKeys.ts

@@ -0,0 +1,31 @@
+//
+// Copyright 2021 Vulcanize, Inc.
+//
+
+import { Entity, PrimaryGeneratedColumn, Column, Index } from 'typeorm';
+import { bigintTransformer } from '@cerc-io/util';
+
+@Entity()
+@Index(['blockHash', 'contractAddress', '_point'], { unique: true })
+export class GetKeys {
+  @PrimaryGeneratedColumn()
+    id!: number;
+
+  @Column('varchar', { length: 66 })
+    blockHash!: string;
+
+  @Column('integer')
+    blockNumber!: number;
+
+  @Column('varchar', { length: 42 })
+    contractAddress!: string;
+
+  @Column('numeric', { transformer: bigintTransformer })
+    _point!: bigint;
+
+  @Column('varchar')
+    value!: string;
+
+  @Column('text', { nullable: true })
+    proof!: string;
+}

packages/azimuth-watcher/src/gql/queries/getKeys.gql

@@ -0,0 +1,13 @@
+query getKeys($blockHash: String!, $contractAddress: String!, $_point: BigInt!){
+    getKeys(blockHash: $blockHash, contractAddress: $contractAddress, _point: $_point){
+        value{
+            value0
+            value1
+            value2
+            value3
+        }
+        proof{
+            data
+        }
+    }
+}

packages/azimuth-watcher/src/gql/queries/index.ts

@@ -4,6 +4,7 @@ import path from 'path';
 export const events = fs.readFileSync(path.join(__dirname, 'events.gql'), 'utf8');
 export const eventsInRange = fs.readFileSync(path.join(__dirname, 'eventsInRange.gql'), 'utf8');
 export const isActive = fs.readFileSync(path.join(__dirname, 'isActive.gql'), 'utf8');
+export const getKeys = fs.readFileSync(path.join(__dirname, 'getKeys.gql'), 'utf8');
 export const getKeyRevisionNumber = fs.readFileSync(path.join(__dirname, 'getKeyRevisionNumber.gql'), 'utf8');
 export const hasBeenLinked = fs.readFileSync(path.join(__dirname, 'hasBeenLinked.gql'), 'utf8');
 export const isLive = fs.readFileSync(path.join(__dirname, 'isLive.gql'), 'utf8');