USDC related changes

[arthurgousset]

Description

A few sentences describing the overall effects and goals of the pull request's commits.
What is the current behavior, and what is the updated/expected behavior with this PR?

Other changes

Describe any minor or "drive-by" changes here.

Tested

An explanation of how the changes were tested or an explanation as to why they don't need to be.

Related issues

• CLI and ContractKit support all accepted fee currencies equally, including for transfers and for use as fee currencies #128

Backwards compatibility

Brief explanation of why these changes are/are not backwards compatible.

Documentation

The set of community facing docs that have been added/modified because of this change

[changeset-bot]

🦋 Changeset detected

Latest commit: d72868a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 20 packages

Name	Type
@celo/contractkit	Major
@celo/celocli	Major
@celo/utils	Patch
@celo/connect	Patch
@celo/base	Patch
@celo/explorer	Patch
@celo/governance	Patch
@celo/transactions-uri	Patch
@celo/wallet-rpc	Patch
@celo/cryptographic-utils	Patch
@celo/keystores	Patch
@celo/phone-utils	Patch
@celo/wallet-base	Patch
@celo/wallet-hsm-aws	Patch
@celo/wallet-hsm-azure	Patch
@celo/wallet-hsm-gcp	Patch
@celo/wallet-ledger	Patch
@celo/wallet-local	Patch
@celo/wallet-remote	Patch
@celo/wallet-hsm	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[arthurgousset]

I'm checking which commands are affected by changes to the --gasCurrency flag

1. config

For example:

$ celocli config:set --gasCurrency cUSD 

$ celocli config:get
node: https://forno.celo.org
gasCurrency: cUSD

2. transfer

$ celocli transfer:dollars --from 0x303C22e6ef01CbA9d03259248863836CB91336D5 --to 0x22579CA45eE22E2E16dDF72D955D6cf4c767B0eF --value 1000000000000000 --gasCurrency cUSD --privateKey $PRIVATE_KEY --node alfajores

Running Checks:
   ✔  Account has at least 0.001 cUSD 
   ✔  Account can afford transfer and gas paid in cUSD 
All checks passed
SendTransaction: transfer
txHash: 0x6f69f6ac38c60afc6c66fb5f6d34531a8d59662ceaff1be0b0398c0533874f2b
Sending Transaction: transfer... done

Tip

Use this to convert --value from ether to wei in browser: eth-converter.com

3. releasecelo

👉 Edit: Looks like most commands support the --gasCurrency flag (see comment below)

[arthurgousset]

Out-of-scope for this PR

1. The stated Nodejs version requirement (v18.14.2) seems wrong (it's 18.17.1 according to .nvmrc), which manifests in CLI README, NPM, and docs.celo.org

2. releasecelo docs are available (https://docs.celo.org/cli/releasecelo), but are missing from the left-hand index on docs.celo.org. Logged here:

• releasecelo docs page missing in left-hand index docs#1254

[arthurgousset]

Noticed that --gasCurrency is a "base flag" defined with in BaseCommand class

export abstract class BaseCommand extends Command {
  static flags = {
    // ...
    gasCurrency: Flags.option({
      options: Object.keys(gasOptions),
      description:
        "Use a specific gas currency for transaction fees (defaults to 'auto' which uses whatever feeCurrency is available)",
      hidden: true,
    })(),
    // ...
  }

Source: cli > base.ts

The BaseCommand class is extended in various other classes like TransferStableBase for example.

export abstract class TransferStableBase extends BaseCommand {
  static flags = {
      ...BaseCommand.flags,
      // ...
  }
}

Source: cli > transfer-stable-base.ts

export default class TransferCelo extends BaseCommand {
  static flags = {
    ...BaseCommand.flags,
  // ...
  }
}

Source: cli > transfer > celo.ts

One way to find where --gasCurrency is supported is to do a code search for "...BaseCommand.flags".

[arthurgousset]

I have an approximate hunch what will need to be changed. I'll write some unit tests, before making changes across the CLI.

[arthurgousset]

Nit re: StrongAddress = `$0x{string}` type

I'm not a fan of the variable name StrongAddress defined in @celo/base. I find StrongAddress is an odd name.

developer-tooling/packages/sdk/base/src/address.ts

Lines 3 to 5 in 0769487

	export type Address = string
	export type StrongAddress = `0x${string}`

I'd prefer to use a variable called Address = `$0x{string}`

Probably not in scope to rename StrongAddress to Address in @celo/base at the moment.

[arthurgousset]

I'm looking call the getWhitelist() function in the FeeCurrencyWhitelist.sol contract:

I notice there is no wrapper for this smart contract in ContractKit:

developer-tooling/packages/sdk/contractkit/src/contract-cache.ts

Line 86 in 0769487

// [CeloContract.FeeCurrencyWhitelist]?: FeeCurrencyWhitelistWrapper,

Unlike the code example from the README suggests:

const feeCurrencyWhitelist = await kit._web3Contracts.getFeeCurrencyWhitelist()

It never existed and has been commented out since ContractKit was created in 2019 (see git blame)

I can always create a web3.eth.Contract instance by passing the ABI (available in ContractKit via @celo/abis) and contract address, but that doesn't seem like a good practice.

const contract = new web3.eth.Contract(feeCurrencyWhitelistABI, FEECURRENCYWHITELIST_CONTRACT_ADDRESS);

I have a feeling there must be a better way to do this. The contract is available via Web3ContractCache, but according to the docstring this is not how contracts are supposed to be used, instead I should use a contract wrapper.

developer-tooling/packages/sdk/contractkit/src/web3-contract-cache.ts

Lines 79 to 87 in 0769487

	/**
	* Native Web3 contracts factory and cache.
	*
	* Exposes accessors to all `CeloContract` web3 contracts.
	*
	* Mostly a private cache, kit users would normally use
	* a contract wrapper
	*/
	export class Web3ContractCache {

Edit: Nevermind, my bad, I found a way:

const feeCurrencyWhitelist = await kit._web3Contracts.getContract('FeeCurrencyWhitelist')
...  await feeCurrencyWhitelist.methods.getWhitelist()

[aaronmgdr]

Nit re: StrongAddress = `$0x{string}` type

I'm not a fan of the variable name StrongAddress defined in @celo/base. I find StrongAddress is an odd name.

developer-tooling/packages/sdk/base/src/address.ts

Lines 3 to 5 in 0769487

	export type Address = string
	export type StrongAddress = `0x${string}`

I'd prefer to use a variable called Address = `$0x{string}`

Probably not in scope to rename StrongAddress to Address in @celo/base at the moment.

I believe there is already an type called Address which is just set to string floating around so StrongAddress is to not confuse the two.

Strong as in Strongly Typed

test