Automatically publish @celo/contracts and @celo/abis with contract releases

.changeset/itchy-tips-repair.md

@@ -0,0 +1,2 @@
+---
+---

.github/workflows/publish-contracts-abi-release.yml

@@ -0,0 +1,78 @@
+name: Publish ABIs and Solidity files to NPM
+on:
+  release:
+    types: [released]
+
+  workflow_dispatch:
+    inputs:
+      npm_version:
+        description: 'NPM version'
+        required: true
+        type: string
+jobs:
+  publish:
+    runs-on: ['self-hosted', 'org', '8-cpu']
+    container:
+      # Update image at https://github.com/celo-org/infrastructure/blob/master/terraform/root-modules/gcp/integration-tests-gke/files/github-arc/Dockerfiles/Dockerfile-monorepo
+      image: us-west1-docker.pkg.dev/devopsre/actions-runner-controller/celo-monorepo:node18
+    permissions:
+      contents: write
+      id-token: write
+      repository-projects: read
+    steps:
+      - uses: actions/checkout@v4
+      - name: Akeyless Get Secrets
+        id: get_auth_token
+        uses: docker://us-west1-docker.pkg.dev/devopsre/akeyless-public/akeyless-action:latest
+        with:
+          api-url: https://api.gateway.akeyless.celo-networks-dev.org
+          access-id: p-kf9vjzruht6l
+          static-secrets: '{"/static-secrets/apps-tooling-circle/npm-publish-token":"NPM_TOKEN"}'
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          registry-url: 'https://registry.npmjs.org'
+          scope: '@celo'
+
+      - name: 'Setup yarn'
+        shell: bash
+        run: |
+          npm install --global yarn
+          source ~/.bashrc
+
+      - name: 'Install packages'
+        run: yarn
+
+      - name: Check if a release should be published
+        run: yarn --silent is_contract_release >> "$GITHUB_ENV"
+        working-directory: packages/protocol
+        env:
+          GITHUB_TAG: ${{ github.ref_name }}
+          INPUT_VERSION: ${{ inputs.npm_version }}
+
+      - if: ${{ env.RELEASE_VERSION != '' }}
+        name: Compile solidity contracts and typescript files
+        run: yarn build && yarn prepare_contracts_and_abis_publishing
+        working-directory: packages/protocol
+        env:
+          RELEASE_TYPE: ${{ env.RELEASE_TYPE }}
+          RELEASE_VERSION: ${{ env.RELEASE_VERSION }}
+
+      - if: ${{ env.RELEASE_VERSION != '' }}
+        name: Publish @celo/contracts
+        run: yarn publish contracts --tag latest --version $RELEASE_VERSION --no-git-tag-version
+        working-directory: packages/protocol
+        env:
+          RELEASE_TYPE: ${{ env.RELEASE_TYPE }}
+          RELEASE_VERSION: ${{ env.RELEASE_VERSION }}
+          NPM_TOKEN: ${{ env.NPM_TOKEN }}
+
+      - if: ${{ env.RELEASE_VERSION != '' }}
+        name: Publish @celo/abis
+        run: yarn publish build/contracts --tag latest --version $RELEASE_VERSION --no-git-tag-version
+        working-directory: packages/protocol
+        env:
+          RELEASE_TYPE: ${{ env.RELEASE_TYPE }}
+          RELEASE_VERSION: ${{ env.RELEASE_VERSION }}
+          NPM_TOKEN: ${{ env.NPM_TOKEN }}

packages/cli/src/commands/transfer/erc20.ts

@@ -1,4 +1,4 @@
-import { Ierc20 } from '@celo/contractkit/lib/generated/IERC20'
+import { IERC20 } from '@celo/contractkit/lib/generated/IERC20'
 import { Erc20Wrapper } from '@celo/contractkit/lib/wrappers/Erc20Wrapper'
 import { flags } from '@oclif/command'
 import BigNumber from 'bignumber.js'
@@ -42,7 +42,7 @@ export default class TransferErc20 extends BaseCommand {
     const value = new BigNumber(res.flags.value)
 
     this.kit.defaultAccount = from
-    let celoToken: Erc20Wrapper<Ierc20>
+    let celoToken: Erc20Wrapper<IERC20>
     try {
       celoToken = await this.kit.contracts.getErc20(res.flags.erc20Address)
       // this call allow us to check if it is a valid erc20

packages/protocol/.gitignore

@@ -39,3 +39,5 @@ deployedGrants.json
 cache/
 out/
 
+wagmi.config.js
+wagmi.config.js.map

packages/protocol/contractPackages.ts

@@ -1,9 +1,9 @@
 export interface ContractPackage {
   path?: string
   folderPath?: string
-  name?: string
-  contracstFolder?: string
+  name: string
   contracts: string[]
+  contracstFolder?: string
   proxyContracts?: string[]
   truffleConfig?: string
   solidityVersion?: string

packages/protocol/contracts/.npmignore

@@ -0,0 +1,3 @@
+test/*
+package.abis.json
+README.abis.md

packages/protocol/contracts/README.abis.md

@@ -0,0 +1,37 @@
+# Celo core contracts ABIS
+
+Smart contracts ABIS for the Celo protocol.
+
+## Usage
+
+### Installation
+
+```bash
+npm install @celo/abis
+```
+
+or
+
+```bash
+yarn add @celo/abis
+```
+
+### In your javascript or ts
+
+```ts
+// json abi
+import Accounts from '@celo/abis/Accounts.json'
+
+// ethers
+import { Accounts } from '@celo/abis/types/ethers'
+
+// web3
+import Accounts from '@celo/abis/types/web3/Accounts'
+
+// truffle
+import { AccountsContract } from '@celo/abis/types/truffle'
+```
+
+## License
+
+All packages are licensed under the terms of the Apache 2.0 License unless otherwise specified in the LICENSE file at package's root.

packages/protocol/contracts/README.md

@@ -0,0 +1,36 @@
+# Celo core contracts
+
+Smart contracts for the Celo protocol.
+
+## Usage
+
+### Installation
+
+```bash
+npm install @celo/contracts
+```
+
+or
+
+```bash
+yarn add @celo/contracts
+```
+
+### In your Solidity contracts
+
+```solidity
+pragma solidity ^0.5.13;
+
+import '@celo/contracts/common/UsingRegistryV2.sol';
+
+contract Example is UsingRegistryV2 {
+  constructor() public {
+    require(getAccounts().createAccount());
+  }
+}
+
+```
+
+## License
+
+The contents of this package are licensed under the terms of the GNU Lesser Public License V3

packages/protocol/contracts/package.abis.json

@@ -0,0 +1,14 @@
+{
+  "name": "@celo/abis",
+  "version": "0.0.0-template.version",
+  "author": "cLabs",
+  "license": "LGPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/celo-org/celo-monorepo.git",
+    "directory": "packages/protocol/contracts"
+  },
+  "scripts": {},
+  "dependencies": {},
+  "types": "./types/ethers/index.d.ts"
+}

packages/protocol/contracts/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@celo/contracts",
+  "version": "0.0.0-template.version",
+  "author": "cLabs",
+  "license": "LGPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/celo-org/celo-monorepo.git",
+    "directory": "packages/protocol/contracts"
+  },
+  "scripts": {},
+  "dependencies": {}
+}

packages/protocol/lib/registry-utils.ts

@@ -6,7 +6,7 @@
  * an environment.
  */
 
-import { ContractPackage, MENTO_PACKAGE } from "../contractPackages"
+import { ContractPackage, MENTO_PACKAGE, SOLIDITY_08_PACKAGE } from "../contractPackages"
 
 export const celoRegistryAddress = '0x000000000000000000000000000000000000ce10'
 
@@ -54,6 +54,7 @@ export const usesRegistry = [
 
 export const hasEntryInRegistry: ContractPackage[]= [
   {
+    name: "default",
     contracts:[
       CeloContractName.Accounts,
       CeloContractName.Attestations,
@@ -72,12 +73,8 @@ export const hasEntryInRegistry: ContractPackage[]= [
       CeloContractName.SortedOracles,
     ]
   },
-  {
-    contracts:[
-      CeloContractName.GasPriceMinimum,
-    ],
-    path: "contracts-0.8"
-  },
+  SOLIDITY_08_PACKAGE
+  ,
   {
     ...MENTO_PACKAGE,
     // not all Mentro contracts are supposed to be in the Registry

packages/protocol/package.json

@@ -19,8 +19,12 @@
     "build:ts": "rm -f migrations/*.js* && ts-node --preferTsExts ./scripts/build.ts --truffleTypes ./types/typechain && tsc -b && mv migrations_ts/*.js* migrations",
     "gas": "yarn run test --gas",
     "pull-submodules": "git submodule update --init --recursive",
+    "delete-submodules": "rm -rf $(git submodule | awk '{ print $2 }')",
     "build:sol": "yarn pull-submodules && mkdir -p migrations && ts-node --preferTsExts ./scripts/build.ts --solidity ${BUILD_DIR:-./build}",
     "build": "yarn build:sol && yarn build:ts",
+    "prebuild": "rm -rf ./build",
+    "is_contract_release": "ts-node ./scripts/is-contract-release.ts",
+    "prepare_contracts_and_abis_publishing": "ts-node ./scripts/prepare-contracts-and-abis-publishing.ts",
     "sourcify-publish": "ts-node ./scripts/sourcify-publish.ts",
     "migrate": "./scripts/bash/migrate.sh",
     "set_block_gas_limit": "./scripts/bash/set_block_gas_limit.sh",
@@ -101,8 +105,9 @@
     "web3-utils": "1.10.0"
   },
   "devDependencies": {
+    "@celo/odis-identifiers": "^1.0.0",
     "@celo/phone-utils": "^5.0.5",
-    "@celo/typechain-target-web3-v1-celo": "0.2.0",
+    "@celo/typechain-target-web3-v1-celo": "^1.0.0",
     "@celo/typescript": "0.0.1",
     "@types/bn.js": "^5.1.0",
     "@types/chai": "^4.1.3",
@@ -113,16 +118,20 @@
     "@types/targz": "^1.0.0",
     "@types/tmp": "^0.1.0",
     "@types/yargs": "^13.0.2",
+    "@wagmi/cli": "^1.0.1",
     "cross-env": "^5.1.6",
     "eth-gas-reporter": "^0.2.16",
     "merkle-patricia-tree": "4.0.0",
+    "rimraf": "^5.0.5",
+    "semver": "^7.5.4",
     "targz": "^1.0.1",
     "tmp": "^0.1.0",
     "truffle-typings": "^1.0.6",
-    "ts-generator": "^0.0.8",
     "ts-node": "^10.9.1",
-    "typechain": "1.0.5",
-    "typechain-target-truffle": "1.0.2",
+    "ts-generator": "^0.0.8",
+    "typechain": "^4.0.3",
+    "typechain-target-truffle": "^1.0.2",
+    "typechain-target-ethers-v5": "^5.0.1",
     "yargs": "^14.0.0"
   }
 }

packages/protocol/scripts/build.ts

@@ -2,12 +2,14 @@
 
 import Web3V1Celo from '@celo/typechain-target-web3-v1-celo'
 import { execSync } from 'child_process'
-import { existsSync, readJSONSync } from 'fs-extra'
+import fsExtraPkg from 'fs-extra'
 import minimist, { ParsedArgs } from 'minimist'
 import path from 'path'
 import { tsGenerator } from 'ts-generator'
 import { MENTO_PACKAGE, SOLIDITY_08_PACKAGE } from '../contractPackages'
 
+const { existsSync, readJSONSync } = fsExtraPkg
+
 const ROOT_DIR = path.normalize(path.join(__dirname, '../'))
 const BUILD_DIR = path.join(ROOT_DIR, process.env.BUILD_DIR ?? './build')
 
@@ -83,7 +85,7 @@ const OtherContracts = [
   'UsingRegistry',
 ]
 
-const contractPackages = [MENTO_PACKAGE, SOLIDITY_08_PACKAGE]
+const contractPackages = [MENTO_PACKAGE, SOLIDITY_08_PACKAGE].filter(Boolean)
 
 const Interfaces = ['ICeloToken', 'IERC20', 'ICeloVersionedContract']
 
@@ -165,6 +167,16 @@ function generateFilesForTruffle(outdir: string) {
   exec(`yarn run --silent typechain --target=truffle --outDir "${outdir}" "${globPattern}"`)
 }
 
+function generateFilesForEthers(outdir: string) {
+  console.log(`protocol: Generating Ethers Types to ${outdir}`)
+  exec(`rm -rf "${outdir}"`)
+
+  const contractKitContracts = CoreContracts.concat('Proxy').concat(Interfaces)
+  const globPattern = `${BUILD_DIR}/contracts/@(${contractKitContracts.join('|')}).json`
+
+  exec(`yarn run --silent typechain --target=ethers-v5 --outDir "${outdir}" "${globPattern}"`)
+}
+
 async function generateFilesForContractKit(outdir: string) {
   console.log(`protocol: Generating Web3 Types to ${outdir}`)
   exec(`rm -rf ${outdir}`)
@@ -206,27 +218,32 @@ async function generateFilesForContractKit(outdir: string) {
 }
 
 const _buildTargets: ParsedArgs = {
-  _: [],
+  _: [] as string[],
   solidity: undefined,
   truffleTypes: undefined,
   web3Types: undefined,
-}
+  ethersTypes: undefined,
+} as const
+type BuildTargets = Record<keyof typeof _buildTargets, string>
 
-async function main(buildTargets: ParsedArgs) {
+async function main(buildTargets: BuildTargets) {
   if (buildTargets.solidity) {
     compile(buildTargets.solidity)
   }
   if (buildTargets.truffleTypes) {
     generateFilesForTruffle(buildTargets.truffleTypes)
   }
+  if (buildTargets.ethersTypes) {
+    generateFilesForEthers(buildTargets.ethersTypes)
+  }
   if (buildTargets.web3Types) {
     await generateFilesForContractKit(buildTargets.web3Types)
   }
 }
 
 const argv = minimist(process.argv.slice(2), {
   string: Object.keys(_buildTargets),
-})
+}) as unknown as BuildTargets
 
 main(argv).catch((err) => {
   console.error(err)