Proposal/return all contracts

[Ansonhkg]

Description

LitContracts package only supports ethers5 atm., and we are pretty much locked-in to this version and blockchain client. We should just return all the network contract addresses & abis; then, the developers can use whatever clients they want. However, we need to provide documentation on how to use common smart contract features, such as mintNext for PKP, addPermittedAction to add permitted action to a given PKP & IPFS ID, etc.

Usage

const contracts = await LitContracts.getContracts();

// for cayenne contracts
const cayennePkpNftContractAddress = contracts.cayenne.PKPNFT.address;
const cayennePkpNftContractAbi = contracts.cayenne.PKPNFT.abi;

// for manzano contracts
const manzanoRateLimitNftContractAddress = contracts.manzano.RateLimitNFT.address;
const manzanoRateLimitNftContractAbi = contracts.manzano.RateLimitNFT.abi;

// for habanero contracts
const manzanoPkpHelperContractAddress = contracts.manzano.PKPHelper.address;
const manzanoPkpHelperContractAbi = contracts.manzano.PKPHelper.abi;

Interface

export type LitContract = {
  address?: string;
  abi?: any;
  name?: string;
};

type LitContractContext = {
  [index: string]: string | any;

  Allowlist: LitContract;
  LITToken: LitContract;
  Multisender: LitContract;
  PKPHelper: LitContract;
  PKPNFT: LitContract;
  PKPNFTMetadata: LitContract;
  PKPPermissions: LitContract;
  PubkeyRouter: LitContract;
  RateLimitNFT: LitContract;
  Staking: LitContract;
  StakingBalances: LitContract;
};

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Jessy jesty jest

node 'node_modules/.bin/jest' './packages/contracts-sdk/src/lib/contracts-sdk.spec.ts' -c './packages/contracts-sdk/jest.config.ts' -t 'contractsSdk should get all contracts'

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[MaximusHaximus]

👍 It would be great to allow consumers to find contracts themselves I think 👍

I am curious about why we have a single method that always returns all 3 networks of contracts, though? I think most commonly consumers work within the context of a single network at a time, and everything else in the contracts-sdk is specific to a single network at a time.

Why not make _resolveContractContext a public, static method if we want to expose its behaviour? Then consumers could call it for one or for many networks however they want.

[MaximusHaximus]

Why not import 'cross-fetch/polyfill'; at top of file?

[MaximusHaximus]

This is the equivalent of:

    const val = await LitContracts._resolveContractContext(LitNetwork.Manzano);
    const val2 = await LitContracts._resolveContractContext(LitNetwork.Habanero);
    const val3 = await LitContracts._resolveContractContext(LitNetwork.Cayenne);
    
    const [manzano, habanero, cayenne] = await Promise.all([val, val2, val3]);

    return {
      manzano,
      habanero,
      cayenne
    };

🔪 awaiting each array element here -- promise.all() should receive an array of promises that are running in parallel, but this is awaiting each array element, putting the the un-wrapped values into an array, then passing the array of no-longer-promises into promise.all() instead of passing the promises themselves into `promise.all()...

[Ansonhkg]

Good catch! yea was copy/pasting the original code didn't pay attention to that, but we can discuss if we actually want this. It was a 3am idea that i quickly drafted, so it's not a hard requirement nor tracked in linear.