Merge pull request #390 from identity-com/feature/eth-populateTransaction

Ethereum: Expose populateTransaction on eth gatewayTs.

Author: dankelleher

ethereum/gatekeeper-cli/README.md

@@ -78,7 +78,7 @@ $ npm install -g @identity.com/gateway-eth-cli
 $ gateway-eth COMMAND
 running command...
 $ gateway-eth (--version)
-@identity.com/gateway-eth-cli/0.0.10 darwin-arm64 node-v16.17.1
+@identity.com/gateway-eth-cli/0.0.11 darwin-arm64 node-v16.17.1
 $ gateway-eth --help [COMMAND]
 USAGE
   $ gateway-eth COMMAND
@@ -154,7 +154,7 @@ EXAMPLES
   $ gateway-eth add-gatekeeper 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
 ```
 
-_See code: [dist/commands/add-gatekeeper.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/add-gatekeeper.ts)_
+_See code: [dist/commands/add-gatekeeper.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/add-gatekeeper.ts)_
 
 ## `gateway-eth add-network-authority ADDRESS`
 
@@ -207,7 +207,7 @@ EXAMPLES
   $ gateway-eth add-network-authority 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
 ```
 
-_See code: [dist/commands/add-network-authority.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/add-network-authority.ts)_
+_See code: [dist/commands/add-network-authority.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/add-network-authority.ts)_
 
 ## `gateway-eth create-gatekeeper-network ID NAME`
 
@@ -258,7 +258,7 @@ EXAMPLES
   $ gateway-eth create-gatekeeper-network <name> <number>
 ```
 
-_See code: [dist/commands/create-gatekeeper-network.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/create-gatekeeper-network.ts)_
+_See code: [dist/commands/create-gatekeeper-network.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/create-gatekeeper-network.ts)_
 
 ## `gateway-eth freeze ADDRESS`
 
@@ -311,7 +311,7 @@ EXAMPLES
   $ gateway-eth freeze 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
 ```
 
-_See code: [dist/commands/freeze.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/freeze.ts)_
+_See code: [dist/commands/freeze.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/freeze.ts)_
 
 ## `gateway-eth get-gatekeeper-network ID`
 
@@ -348,7 +348,7 @@ EXAMPLES
   $ gateway-eth get-gatekeeper-network <number>
 ```
 
-_See code: [dist/commands/get-gatekeeper-network.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/get-gatekeeper-network.ts)_
+_See code: [dist/commands/get-gatekeeper-network.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/get-gatekeeper-network.ts)_
 
 ## `gateway-eth get-token ADDRESS`
 
@@ -391,7 +391,7 @@ EXAMPLES
   $ gateway-eth get 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
 ```
 
-_See code: [dist/commands/get-token.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/get-token.ts)_
+_See code: [dist/commands/get-token.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/get-token.ts)_
 
 ## `gateway-eth help [COMMAND]`
 
@@ -472,7 +472,7 @@ EXAMPLES
   $ gateway-eth issue 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
 ```
 
-_See code: [dist/commands/issue.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/issue.ts)_
+_See code: [dist/commands/issue.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/issue.ts)_
 
 ## `gateway-eth listen ADDRESS`
 
@@ -512,7 +512,7 @@ EXAMPLES
   $ gateway-eth listen 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
 ```
 
-_See code: [dist/commands/listen.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/listen.ts)_
+_See code: [dist/commands/listen.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/listen.ts)_
 
 ## `gateway-eth refresh ADDRESS [EXPIRY]`
 
@@ -566,7 +566,7 @@ EXAMPLES
   $ gateway-eth refresh 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 60 -n 123
 ```
 
-_See code: [dist/commands/refresh.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/refresh.ts)_
+_See code: [dist/commands/refresh.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/refresh.ts)_
 
 ## `gateway-eth remove-gatekeeper ADDRESS`
 
@@ -619,7 +619,7 @@ EXAMPLES
   $ gateway-eth remove-gatekeeper 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
 ```
 
-_See code: [dist/commands/remove-gatekeeper.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/remove-gatekeeper.ts)_
+_See code: [dist/commands/remove-gatekeeper.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/remove-gatekeeper.ts)_
 
 ## `gateway-eth remove-network-authority ADDRESS`
 
@@ -672,7 +672,7 @@ EXAMPLES
   $ gateway-eth remove-network-authority 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
 ```
 
-_See code: [dist/commands/remove-network-authority.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/remove-network-authority.ts)_
+_See code: [dist/commands/remove-network-authority.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/remove-network-authority.ts)_
 
 ## `gateway-eth revoke ADDRESS`
 
@@ -725,7 +725,7 @@ EXAMPLES
   $ gateway-eth revoke 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
 ```
 
-_See code: [dist/commands/revoke.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/revoke.ts)_
+_See code: [dist/commands/revoke.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/revoke.ts)_
 
 ## `gateway-eth unfreeze ADDRESS`
 
@@ -778,7 +778,7 @@ EXAMPLES
   $ gateway-eth unfreeze 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
 ```
 
-_See code: [dist/commands/unfreeze.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.10/dist/commands/unfreeze.ts)_
+_See code: [dist/commands/unfreeze.ts](https://github.com/identity-com/on-chain-identity-gateway/blob/v0.0.11/dist/commands/unfreeze.ts)_
 
 ## `gateway-eth verify ADDRESS`
 

ethereum/gatekeeper-cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@identity.com/gateway-eth-cli",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "Identity.com Gateway Protocol EVM CLI",
   "author": "dankelleher @dankelleher",
   "bin": {
@@ -25,7 +25,7 @@
     "@ethersproject/units": "^5.7.0",
     "@ethersproject/wallet": "^5.7.0",
     "@ethersproject/web": "^5.7.1",
-    "@identity.com/gateway-eth-ts": "0.5.6",
+    "@identity.com/gateway-eth-ts": "0.5.7",
     "@oclif/core": "^1.23.2",
     "@oclif/dev-cli": "^1.26.10",
     "@oclif/plugin-help": "^5",

ethereum/gatekeeper-cli/src/utils/oclif/gas.ts

@@ -1,4 +1,5 @@
 import {GasPriceOracle, GetTxGasParamsRes, FallbackGasPrices, GasOracleOptions} from 'gas-price-oracle'
+import {JsonRpcProvider, Provider} from '@ethersproject/providers'
 
 export declare type GasPriceKey = 'instant' | 'fast' | 'standard' | 'low';
 
@@ -31,23 +32,37 @@ export const DEFAULT_GAS_PRICES: { [key: number]: FallbackGasPrices } = {
 
 const options: GasOracleOptions = {
   chainId: 1,
-  // defaultRpc: 'https://api.mycryptoapi.com/eth',
+  defaultRpc: 'https://api.mycryptoapi.com/eth',
   timeout: 10_000,
   shouldCache: true,
 }
 
 export const estimateGasPrice = async (
+  provider: Provider,
   priceKey?: GasPriceKey,
   oracleOptions: Partial<GasOracleOptions> = {},
 ): Promise<GetTxGasParamsRes> => {
-  const oracle = new GasPriceOracle({
-    fallbackGasPrices: DEFAULT_GAS_PRICES[oracleOptions.chainId || 1],
+  const chainId = await provider.getNetwork().then(network => network.chainId)
+  const defaultRpc = Object.hasOwn(provider, 'connection') ? (provider as JsonRpcProvider).connection.url : undefined
+  const resolvedOptions = {
     ...options,
+    fallbackGasPrices: DEFAULT_GAS_PRICES[oracleOptions.chainId || 1],
+    chainId,
+    defaultRpc,
+    ...(priceKey ? {legacySpeed: priceKey} : {isLegacy: false}),
+
     ...oracleOptions,
+  }
+  const payload = priceKey ? {legacySpeed: priceKey} : {isLegacy: false}
+
+  console.log('Payload to Gas Price Oracle', {
+    payload,
+    resolvedOptions,
   })
 
-  const payload = priceKey ? {legacySpeed: priceKey} : {isLegacy: false}
-  const txGasParams = await oracle.getTxGasParams(payload)
+  const oracle = new GasPriceOracle(resolvedOptions)
+
+  const txGasParams = await oracle.getTxGasParams()
 
   console.log('Result from Gas Price Oracle', txGasParams)
 

ethereum/gatekeeper-cli/src/utils/oclif/utils.ts

@@ -11,10 +11,7 @@ export const makeGatewayTs = async ({
   gasLimit,
 }: { provider: Provider, privateKey?: string, gatewayTokenAddress: string, fees?: GasPriceKey, gasLimit?: BigNumber }):Promise<GatewayTs> => {
   const signer = privateKey ? getSigner(privateKey, provider) : undefined
-  const chainId = await provider.getNetwork().then(network => network.chainId)
-  const feeAmount = await estimateGasPrice(fees, {
-    chainId,
-  })
+  const feeAmount = await estimateGasPrice(provider, fees)
   return new GatewayTs(signer || provider, gatewayTokenAddress, {...feeAmount, gasLimit})
 }
 

ethereum/gateway-eth-ts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@identity.com/gateway-eth-ts",
-  "version": "0.5.6",
+  "version": "0.5.7",
   "description": "Adapter library for Identity.com gateway token system on Ethereum",
   "main": "dist/index.js",
   "scripts": {
@@ -33,7 +33,8 @@
     "eth-sig-util": "2.1.1",
     "ethers": "^5.7.2",
     "gas-price-oracle": "^0.3.3",
-    "ramda": "^0.28.0"
+    "ramda": "^0.28.0",
+    "tslib": "^2.5.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.0",
@@ -54,7 +55,6 @@
     "prettier": "2.3.2",
     "ts-mocha": "^8.0.0",
     "ts-node": "^10.1.0",
-    "tslib": "^2.3.0",
     "typedoc": "^0.23.24",
     "typescript": "^4.3.5"
   },

ethereum/gateway-eth-ts/src/service/GatewayTs.ts

@@ -15,6 +15,7 @@ import {
   TokenData,
 } from "../utils";
 import { asProvider } from "../utils/provider";
+import { GatewayTsTransaction } from "./GatewayTsTransaction";
 
 export class GatewayTs extends GatewayTsInternal<
   GatewayToken,
@@ -51,6 +52,10 @@ export class GatewayTs extends GatewayTsInternal<
     );
   }
 
+  public transaction(): GatewayTsTransaction {
+    return new GatewayTsTransaction(this.gatewayTokenContract, this.options);
+  }
+
   public onGatewayTokenChange(
     owner: string,
     network: bigint,

ethereum/gateway-eth-ts/src/service/GatewayTsTransaction.test.ts

@@ -0,0 +1,67 @@
+import {
+  BaseProvider,
+  getDefaultProvider,
+  TransactionReceipt,
+} from "@ethersproject/providers";
+import { TokenState } from "../utils";
+import * as assert from "assert";
+import * as dotenv from "dotenv";
+import { GatewayTs } from "./GatewayTs";
+import {
+  deployerWallet,
+  gatekeeperNetwork,
+  gatekeeperWallet,
+  TEST_GATEWAY_TOKEN_ADDRESS,
+} from "./testUtils";
+import { PopulatedTransaction } from "ethers/lib/ethers";
+import { GatewayTsForwarder } from "./GatewayTsForwarder";
+import { Wallet } from "ethers";
+import { BigNumber } from "ethers";
+
+dotenv.config();
+
+describe.only("GatewayTS Transaction", function () {
+  let gateway: GatewayTsForwarder;
+  let provider: BaseProvider;
+
+  let gatekeeper: Wallet;
+
+  const sampleWalletAddress = Wallet.createRandom().address;
+
+  before("Initialize GatewayTS class", function () {
+    this.timeout(20_000);
+
+    provider = getDefaultProvider("http://localhost:8545");
+
+    // use the deployer account here as the relayer, as they are guaranteed to be funded by hardhat on localnet startup
+    gatekeeper = gatekeeperWallet(provider);
+
+    console.log("Gatekeeper:", gatekeeper.address);
+
+    gateway = new GatewayTs(
+      gatekeeper,
+      TEST_GATEWAY_TOKEN_ADDRESS.gatewayToken
+    ).transaction();
+  });
+
+  it("should issue a token", async () => {
+    const transaction = await gateway.issue(
+      sampleWalletAddress,
+      gatekeeperNetwork
+    );
+
+    const txReceipt = await (
+      await gatekeeper.sendTransaction(transaction)
+    ).wait();
+
+    console.log("TX receipt:", txReceipt);
+
+    const token = await gateway.getToken(
+      sampleWalletAddress,
+      gatekeeperNetwork
+    );
+
+    assert.equal(token.owner, sampleWalletAddress);
+    assert.equal(token.state, TokenState.ACTIVE);
+  });
+});

ethereum/gateway-eth-ts/src/service/GatewayTsTransaction.ts

@@ -0,0 +1,38 @@
+import { Wallet, Contract, Overrides, PopulatedTransaction } from "ethers";
+import { Forwarder, GatewayToken } from "../contracts/typechain-types";
+import { GatewayTsInternal } from "./GatewayTsInternal";
+import {
+  mappedOpNames,
+  WriteOps,
+  ReadOnlyOperation,
+  readOnlyOpNames,
+} from "../utils/types";
+import { mapObjIndexed, pick } from "ramda";
+import { signMetaTxRequest } from "../utils/metatx";
+import { Provider } from "@ethersproject/providers";
+
+type MappedGatewayToken = ReadOnlyOperation &
+  Pick<GatewayToken["populateTransaction"], WriteOps>;
+
+// A GatewayToken API that returns an PopulatedTransaction, rather than
+// a transaction directly on the GatewayToken contract. Use this for relaying with relayers that provide their own
+// forwarder, or any other process that wants to separate tx building and signing
+export class GatewayTsTransaction extends GatewayTsInternal<
+  MappedGatewayToken,
+  PopulatedTransaction
+> {
+  constructor(gatewayTokenContract: GatewayToken, options?: Overrides) {
+    // construct a new mappedGatewayToken object comprising write operations that return PopulatedTransactions
+    // and read operations that don't. See the description of MappedGatewayToken above for more details.
+    const raw: ReadOnlyOperation = pick(readOnlyOpNames, gatewayTokenContract);
+    const mapped: Pick<GatewayToken["populateTransaction"], WriteOps> = pick(
+      mappedOpNames,
+      gatewayTokenContract.populateTransaction
+    );
+    const mappedGatewayToken = {
+      ...mapped,
+      ...raw,
+    };
+    super(mappedGatewayToken, options);
+  }
+}

ethereum/yarn.lock

@@ -13627,11 +13627,16 @@ tslib@^1.8.1, tslib@^1.9.0, tslib@^1.9.3:
   resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00"
   integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==
 
-tslib@^2, tslib@^2.0.0, tslib@^2.0.3, tslib@^2.1.0, tslib@^2.3.0, tslib@^2.3.1, tslib@^2.4.1:
+tslib@^2, tslib@^2.0.0, tslib@^2.0.3, tslib@^2.1.0, tslib@^2.3.1, tslib@^2.4.1:
   version "2.4.1"
   resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.4.1.tgz#0d0bfbaac2880b91e22df0768e55be9753a5b17e"
   integrity sha512-tGyy4dAjRIEwI7BzsB0lynWgOpfqjUdq91XXAlIWD2OwKBH7oCl/GZG/HT4BOHrTlPMOASlMQ7veyTqpmRcrNA==
 
+tslib@^2.5.0:
+  version "2.5.0"
+  resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.5.0.tgz#42bfed86f5787aeb41d031866c8f402429e0fddf"
+  integrity sha512-336iVw3rtn2BUK7ORdIAHTyxHGRIHVReokCR3XjbckJMK7ms8FysBfhLR8IXnAgy7T0PTPNBWKiH514FOW/WSg==
+
 [email protected]:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/tsort/-/tsort-0.0.1.tgz#e2280f5e817f8bf4275657fd0f9aebd44f5a2786"