[GMS-1103] Add erc20 contract client (#98)

* add erc20 client

* upgrade to yarn

* update index

* udpate workflows

* clean up

* fix lint

* add test publish

---------

Co-authored-by: Allan Almeida <[email protected]>

.eslintignore

@@ -3,3 +3,4 @@ artifacts
 cache
 coverage
 typechain
+dist

.github/workflows/publish.yaml

@@ -48,15 +48,15 @@ jobs:
 
       - name: Install dependencies
         run: |
-          npm ci
+          yarn install --frozen-lockfile
 
       - name: Compile contracts
         run: |
-          npm run compile
+          yarn compile
 
       - name: Build dist files
         run: |
-          rm -rf dist && npm run build
+          rm -rf dist && yarn build
 
       - name: Publish package
         uses: JS-DevTools/npm-publish@v1

.github/workflows/test.yml

@@ -2,9 +2,9 @@ name: test
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   hardhat-test:
@@ -17,10 +17,10 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: lts/*
-      - name: Install NPM Dependencies
-        run: npm ci
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
       - name: Run Tests
-        run: npm run test
+        run: yarn test
   lint:
     name: Run eslint
     runs-on: ubuntu-latest
@@ -31,7 +31,26 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: lts/*
-      - name: Install NPM Dependencies
-        run: npm ci
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
       - name: Run eslint
-        run: npm run lint
+        run: yarn lint
+  publish:
+    name: Publish to NPM (dry run)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          registry-url: https://registry.npmjs.org/
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Compile contracts
+        run: yarn compile
+      - name: Build dist files
+        run: rm -rf dist && yarn build
+      - name: Test publish
+        run: npm pack --dry-run

CONTRIBUTING.md

@@ -61,7 +61,7 @@ git checkout -b <your-branch-name>
 6. Be sure to run the tests and set up the relevant linters to ensure all GitHub checks pass (see GitHub issues: https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues for more information).
 
 ```
-npm test
+yarn test
 ```
 
 7. Add and commit your changes, including a comprehensive commit message summarising your changes, then push changes to your fork. (e.g. Fixed formatting issue with ImmutableERC721MintByID.sol)
@@ -79,4 +79,5 @@ git push origin <your-branch-name>
 9. We will review the pull requests and request any necessary changes. If all the checks (linting, compilation, tests) pass and everything looks good, your code will be merged into the original repository. Congratulations, and thank you for your contribution!
 
 ## Releasing
-To release the package to NPM, simply create a new GitHub release and the "Publish to NPM" GitHub action will release it to NPM.
+
+To release the package to NPM, simply create a new GitHub release and the "Publish to NPM" GitHub action will release it to NPM.

README.md

@@ -19,7 +19,7 @@ These contracts are feature-rich and are the recommended standard on Immutable z
 ### Installation
 
 ```
-$ npm install @imtbl/zkevm-contracts
+$ yarn install @imtbl/zkevm-contracts
 ```
 
 ### Usage

clients/erc20.ts

@@ -0,0 +1,81 @@
+import { Overrides } from "ethers";
+import { Provider } from "@ethersproject/providers";
+import { BigNumberish, BigNumber } from "@ethersproject/bignumber";
+import { CallOverrides, PopulatedTransaction } from "@ethersproject/contracts";
+
+import { ERC20 } from "../typechain-types/@openzeppelin/contracts/token/ERC20";
+import { ERC20__factory } from "../typechain-types/factories/@openzeppelin/contracts/token/ERC20/ERC20__factory";
+import { PromiseOrValue } from "../typechain-types/common";
+
+export class ERC20Client {
+  private readonly contract: ERC20;
+
+  constructor(contractAddress: string) {
+    const factory = new ERC20__factory();
+    this.contract = factory.attach(contractAddress);
+  }
+
+  /**
+   * @returns a promise that resolves with a BigNumber that represents the amount of tokens in existence
+   */
+  public async totalSupply(provider: Provider, overrides: CallOverrides = {}): Promise<BigNumber> {
+    return this.contract.connect(provider).totalSupply(overrides);
+  }
+
+  /**
+   * @returns a promise that resolves with a BigNumber that represents the amount of tokens owned by account
+   */
+  public async balanceOf(
+    provider: Provider,
+    account: PromiseOrValue<string>,
+    overrides: CallOverrides = {}
+  ): Promise<BigNumber> {
+    return this.contract.connect(provider).balanceOf(account, overrides);
+  }
+
+  /**
+   * @returns a promise that resolves with a BigNumber that represents the remaining number of tokens that spender will be allowed to spend on behalf of owner through transferFrom
+   */
+  public async allowance(
+    provider: Provider,
+    owner: PromiseOrValue<string>,
+    spender: PromiseOrValue<string>,
+    overrides: CallOverrides = {}
+  ): Promise<BigNumber> {
+    return this.contract.connect(provider).allowance(owner, spender, overrides);
+  }
+
+  /**
+   * @returns a promise that resolves with a populated transaction
+   */
+  public async populateTransfer(
+    to: PromiseOrValue<string>,
+    amount: PromiseOrValue<BigNumberish>,
+    overrides?: Overrides & { from?: PromiseOrValue<string> }
+  ): Promise<PopulatedTransaction> {
+    return this.contract.populateTransaction.transfer(to, amount, overrides);
+  }
+
+  /**
+   * @returns a promise that resolves with a populated transaction
+   */
+  public async populateApprove(
+    spender: PromiseOrValue<string>,
+    amount: PromiseOrValue<BigNumberish>,
+    overrides: Overrides & { from?: PromiseOrValue<string> } = {}
+  ): Promise<PopulatedTransaction> {
+    return this.contract.populateTransaction.approve(spender, amount, overrides);
+  }
+
+  /**
+   * @returns a promise that resolves with a populated transaction
+   */
+  public async populateTransferFrom(
+    from: PromiseOrValue<string>,
+    to: PromiseOrValue<string>,
+    amount: PromiseOrValue<BigNumberish>,
+    overrides: Overrides & { from?: PromiseOrValue<string> } = {}
+  ): Promise<PopulatedTransaction> {
+    return this.contract.populateTransaction.transferFrom(from, to, amount, overrides);
+  }
+}

clients/erc721-mint-by-id.ts

@@ -14,7 +14,7 @@ export type TransferRequest = ImmutableERC721Base.TransferRequestStruct;
 // Struct for safe burning multiple tokens from a single address.
 export type IDBurn = ImmutableERC721Base.IDBurnStruct;
 
-export class ERC721MintByID {
+export class ERC721MintByIDClient {
   private readonly contract: ImmutableERC721MintByID;
 
   constructor(contractAddress: string) {

clients/erc721.ts

@@ -17,7 +17,7 @@ export type TransferRequest = ERC721Hybrid.TransferRequestStruct;
 // Struct for burning multiple tokens from the same address
 export type IDBurn = ERC721Hybrid.IDBurnStruct;
 
-export class ERC721 {
+export class ERC721Client {
   private readonly contract: ImmutableERC721;
 
   constructor(contractAddress: string) {

clients/index.ts

@@ -1,2 +1,3 @@
-export { ERC721 as ERC721Client } from "./erc721";
-export { ERC721MintByID as ERC721MintByIDClient } from "./erc721-mint-by-id";
+export { ERC20Client } from "./erc20";
+export { ERC721Client } from "./erc721";
+export { ERC721MintByIDClient } from "./erc721-mint-by-id";

contracts/token/erc20/ImmutableERC20.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+
+abstract contract ImmutableERC20 is ERC20 {}