Plugin-based Celo fee currency PoC

[shazarre]

Aim of this PR is to show how support for fee currencies could be achieved using existing plugin architecture.

To test it I used the following script that existed in a directory adjacent to directory to which ethers has been cloned to. I ran it using bun.

It requires dotenv to work and PRIVATE_KEY specified in .env file although can be modified to work without it.

It works with alfajores network only for now.

It also requires the sender to have sufficient funds to a) transfer CELO b) pay for the fee currency. Both can be acquired using the faucet.

import "dotenv/config";
import { JsonRpcProvider, Wallet } from "../ethers.js/src.ts";
import { CeloCustomData } from "../ethers.js/src.ts/chain/celo.ts";

const provider = new JsonRpcProvider("https://alfajores-forno.celo-testnet.org");
const signer = new Wallet(process.env.PRIVATE_KEY as string, provider);

let tx;

// Try to send a CELO CIP-64 transaction
tx = await signer.sendTransaction({
    to: signer.address,
    value: 1n,
    customData: {
        feeCurrency: "0x874069Fa1Eb16D44d622F2e0Ca25eeA172369bC1"
    } as CeloCustomData
});
  
// should be true
console.log(tx.type === 123);

// Try to send an EIP-1559 transaction
tx = await signer.sendTransaction({
    to: signer.address,
    value: 1n,
});
  
// should be true
console.log(tx.type === 2);

When everything works correctly the script should output:

$ bun goal.ts

true
true

[aaronmgdr]

you could make this a generic like

type TransactionLike<A = string, CD = any> {
customData: CD
...
}

then type CeloTranactionLike = TransactionLike<string, {feeCurrency: string}>

[sirpy]

I suggest to also test it with the Contract object, in ethers5 it wasn't enough to change the signer transaction
ie create a contract with a signer and try to execute a contract method passing feecurrency in the extra options

[shazarre]

@sirpy thanks for the suggestion!

using:

const sendResult = await contract.<method-name>.send({
  ...
  customData: {
    feeCurrency: <fee-currency-address>
  } as CeloCustomData
})

and then veryfing the type with:

console.log((await sendResult.getTransaction())?.type == 123);

outputs:

true

on the branch, so seems like it is covered without any additional changes ✅ I just reused the same signer while instantiating the contract instance.

Is that what your suggestion was about or some other use case?

[sirpy]

Yes. On ethers 5 it didn't work. So I guess no issue on v6