Use `@nucypher/nucypher-contracts` contract registry #314

piotr-roslaniec · 2023-10-06T14:26:03Z

Type of PR:

Feature

Required reviews:

2

What this does:

Replaces contract addresses, ABIs, etc. stored in the repository with artifacts from @nucyper/nucypher-contracts
Exposes domain: Domain from user-facing API
Updates typechain usage for contract typings generation

Issues fixed/closed:

Fixes Use @nucypher/nucypher-contracts NPM package instead of custom registry #310

codecov-commenter · 2023-10-06T14:32:10Z

Codecov Report

Merging #314 (ed55e6b) into monorepo (9c172be) will decrease coverage by 0.91%.
The diff coverage is 53.94%.

@@             Coverage Diff              @@
##           monorepo     #314      +/-   ##
============================================
- Coverage     88.25%   87.34%   -0.91%     
============================================
  Files            33       33              
  Lines          2409     2465      +56     
  Branches        205      206       +1     
============================================
+ Hits           2126     2153      +27     
- Misses          254      282      +28     
- Partials         29       30       +1

Files	Coverage Δ
packages/pre/src/characters/alice.ts	`87.74% <100.00%> (+0.07%)`	⬆️
packages/pre/src/characters/bob.ts	`85.61% <100.00%> (ø)`
packages/pre/src/cohort.ts	`89.28% <100.00%> (ø)`
packages/taco/src/conditions/const.ts	`100.00% <100.00%> (ø)`
packages/taco/src/index.ts	`100.00% <100.00%> (ø)`
packages/taco/src/tdec.ts	`93.71% <100.00%> (+0.16%)`	⬆️
packages/pre/src/kits/retrieval.ts	`77.27% <0.00%> (ø)`
packages/pre/src/policy.ts	`82.02% <60.00%> (-1.02%)`	⬇️
packages/taco/src/dkg.ts	`35.16% <8.33%> (-1.26%)`	⬇️
packages/taco/src/taco.ts	`83.82% <50.00%> (-12.30%)`	⬇️

packages/shared/package.json

KPrasch

-35k lines 😆

demos/taco-demo/src/App.tsx

examples/pre/nextjs/src/app/page.tsx

KPrasch · 2023-10-17T14:03:27Z

packages/shared/scripts/typechain.ts

+const parseContractRegistry = (registry: ContractRegistry): Contract[] =>
+  Object.keys(registry)
+    .map((chainId) => {
+      const networkRegistry = registry[chainId];
+      return Object.keys(networkRegistry).map((contractName): Contract => {
+        const contract = networkRegistry[contractName];
+        return { name: contractName as ContractName, abi: contract.abi };
+      });
+    })
+    .flat();


Nice to see this data model from nucypher-contracts adopted here.

derekpierre · 2023-10-17T14:06:57Z

packages/shared/abis/Coordinator.json

👍 Happy to see these files go away.

derekpierre · 2023-10-17T14:10:58Z

packages/shared/src/contracts/agents/global-allow-list.ts

+import { DEFAULT_WAIT_N_CONFIRMATIONS, getContract } from '../registry';
+
+export class GlobalAllowListAgent {
+  public static async registerEncrypters(


Doesn't have to be this PR, but you may want to add a follow-up issue to add the ability to check if an encrypter is already registered i.e. isAddressAuthorized(ritualid, address) I think the contract method is called.

You could also use it to check if the encrypter is already authorized before performing the authorization below.

These two methods are exposed by taco. I think the latter (registering encrypters) could use the former under the hood.

isEncryptionAuthorized on the Coordinator contract is different to isAddressAuthorized on the GlobalAllowList contract. The former is done during decryption because it needs the ciphertext digest etc.

The latter is a check for determining if a specific encryptor address is already authorized and doesn't need any ciphertext. See example here - https://github.com/nucypher/nucypher/blob/development/scripts/hooks/nucypher_dkg.py#L336.

derekpierre · 2023-10-17T14:18:15Z

packages/taco/src/taco.ts

-) => DkgCoordinatorAgent.isEncryptionAuthorized(provider, ritualId, messageKit);
+) => DkgCoordinatorAgent.isEncryptionAuthorized(provider, domain, ritualId, messageKit);
+
+export const registerEncrypters = async (


This is very specific to the GlobalAllowList. I think we need to be careful here. Rituals may use the GlobalAllowList but I don't believe they have to. We'd need to first check here whether the accessController for the associated ritual is the global allow list contract before registering the encrypter. It doesn't have to be, although more often than not, it may be.

cc @KPrasch , @cygnusv

Yes, the encryptor onboarding is a bit more complicated and it depends on #306

We could hide this method from the taco API until we sort it out.

👍 I think that would be prudent.

cygnusv · 2023-10-17T14:16:53Z

examples/taco/webpack-5/src/index.html

@@ -6,7 +6,8 @@
    <script src="index.js"></script>
  </head>
  <body>
-    <noscript>This page contains webassembly and javascript content, please enable
+    <noscript
+      >This page contains webassembly and javascript content, please enable


I guess this <noscript > is done by a linter, but it looks pretty ugly

I guess I could play around with linter rules, but I don't think these files are read as frequently.

cygnusv · 2023-10-17T14:18:31Z

packages/shared/package.json

    "typedoc": "typedoc"
  },
  "dependencies": {
    "@ethersproject/abi": "^5.7.0",
    "@ethersproject/providers": "^5.7.2",
+    "@nucypher/nucypher-contracts": "^7.0.0-rc.1",


cygnusv · 2023-10-17T14:22:01Z

packages/shared/src/contracts/ethers-typechain/common.ts

@@ -40,5 +40,5 @@ export type GetContractTypeFromFactory<F> = F extends MinEthersFactory<
  : never;

 export type GetARGsTypeFromFactory<F> = F extends MinEthersFactory<any, any>
-  ? Parameters<F["deploy"]>
+  ? Parameters<F['deploy']>


Just curious: if these files are generated automatically, why the linting change?

It's an oversight on my part. They should be generated and formatted in one step (to prevent line changes), but I haven't set it up yet.

derekpierre

🎸 - good work.

Approved, but let's hide the registerEncrypters function from the API for now, before merging, until we sort out the proper logic. Let's ensure there's a follow-up issue for tracking.

…echain

piotr-roslaniec force-pushed the contract-registry branch from 14b7264 to 56404a2 Compare October 6, 2023 14:36

KPrasch reviewed Oct 6, 2023

View reviewed changes

packages/shared/package.json Outdated Show resolved Hide resolved

KPrasch reviewed Oct 16, 2023

View reviewed changes

packages/shared/package.json Outdated Show resolved Hide resolved

piotr-roslaniec mentioned this pull request Oct 16, 2023

Support encryptor allowlist #306

Closed

piotr-roslaniec force-pushed the contract-registry branch 4 times, most recently from a3efcae to 9a4a1e4 Compare October 17, 2023 12:43

piotr-roslaniec marked this pull request as ready for review October 17, 2023 13:54

piotr-roslaniec requested review from jMyles, KPrasch, cygnusv, theref, derekpierre and manumonti October 17, 2023 13:55

KPrasch approved these changes Oct 17, 2023

View reviewed changes

derekpierre reviewed Oct 17, 2023

View reviewed changes

demos/taco-demo/src/App.tsx Outdated Show resolved Hide resolved

derekpierre reviewed Oct 17, 2023

View reviewed changes

examples/pre/nextjs/src/app/page.tsx Outdated Show resolved Hide resolved

KPrasch reviewed Oct 17, 2023

View reviewed changes

derekpierre reviewed Oct 17, 2023

View reviewed changes

packages/shared/abis/Coordinator.json Outdated

Copy link

Member

derekpierre Oct 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Happy to see these files go away.

derekpierre reviewed Oct 17, 2023

View reviewed changes

cygnusv approved these changes Oct 17, 2023

View reviewed changes

derekpierre approved these changes Oct 17, 2023

View reviewed changes

piotr-roslaniec and others added 5 commits October 17, 2023 16:35

feat(allowlist): register encrypters in the ritual allowlist

5dbaf42

feature(contracts): use @nucypher/nucypher-contracts package with typ…

599cb72

…echain

Update packages/shared/package.json

e68eb8b

chore: update lockfile

948193b

feature: expose domain in user facing apis

80ccc72

piotr-roslaniec added 2 commits October 17, 2023 16:35

chore: remove unused file

67c8620

chore: document a todo

48810bb

piotr-roslaniec force-pushed the contract-registry branch from 9a4a1e4 to 2b0a6e2 Compare October 17, 2023 14:49

chore: use testnet domain in examples and demos

ed55e6b

piotr-roslaniec force-pushed the contract-registry branch from 2b0a6e2 to ed55e6b Compare October 17, 2023 15:07

piotr-roslaniec merged commit d52f9e6 into nucypher:monorepo Oct 17, 2023
2 checks passed

piotr-roslaniec deleted the contract-registry branch October 17, 2023 15:16

piotr-roslaniec mentioned this pull request Oct 18, 2023

Use @nucypher/nucypher-contracts NPM package instead of custom registry #310

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use `@nucypher/nucypher-contracts` contract registry #314

Use `@nucypher/nucypher-contracts` contract registry #314

piotr-roslaniec commented Oct 6, 2023 •

edited

Loading

codecov-commenter commented Oct 6, 2023 •

edited

Loading

KPrasch left a comment

KPrasch Oct 17, 2023

derekpierre Oct 17, 2023

derekpierre Oct 17, 2023

derekpierre Oct 17, 2023

piotr-roslaniec Oct 17, 2023

derekpierre Oct 17, 2023

derekpierre Oct 17, 2023 •

edited

Loading

piotr-roslaniec Oct 17, 2023

derekpierre Oct 17, 2023

cygnusv Oct 17, 2023

piotr-roslaniec Oct 17, 2023

cygnusv Oct 17, 2023

cygnusv Oct 17, 2023

piotr-roslaniec Oct 17, 2023

derekpierre left a comment •

edited

Loading

Use @nucypher/nucypher-contracts contract registry #314

Use @nucypher/nucypher-contracts contract registry #314

Conversation

piotr-roslaniec commented Oct 6, 2023 • edited Loading

codecov-commenter commented Oct 6, 2023 • edited Loading

Codecov Report

KPrasch left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

derekpierre Oct 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

derekpierre left a comment • edited Loading

Choose a reason for hiding this comment

Use `@nucypher/nucypher-contracts` contract registry #314

Use `@nucypher/nucypher-contracts` contract registry #314

piotr-roslaniec commented Oct 6, 2023 •

edited

Loading

codecov-commenter commented Oct 6, 2023 •

edited

Loading

derekpierre Oct 17, 2023 •

edited

Loading

derekpierre left a comment •

edited

Loading