[WIP] API Rework

.changeset/config.json

@@ -2,12 +2,7 @@
   "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
   "changelog": "@changesets/cli/changelog",
   "commit": false,
-  "fixed": [
-    [
-      "@nucypher/shared",
-      "@nucypher/taco"
-    ]
-  ],
+  "fixed": [["@nucypher/shared", "@nucypher/taco"]],
   "linked": [],
   "access": "public",
   "baseBranch": "main",

.eslintrc.js

@@ -1,54 +1,51 @@
 /** @type {import('eslint').Linter.Config} */
 module.exports = {
-  'root': true,
-  'parser': '@typescript-eslint/parser',
-  'env': {
-    'es6': true,
+  root: true,
+  parser: '@typescript-eslint/parser',
+  env: {
+    es6: true,
   },
-  'ignorePatterns': [
+  ignorePatterns: [
     'node_modules',
     'build',
     'coverage',
     'src/contracts/ethers-typechain',
   ],
-  'plugins': [
-    'import',
-    'eslint-comments',
-  ],
-  'extends': [
+  plugins: ['import', 'eslint-comments'],
+  extends: [
     'eslint:recommended',
     'plugin:eslint-comments/recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:import/typescript',
     'prettier',
   ],
-  'globals': {
-    'BigInt': true,
-    'console': true,
-    'WebAssembly': true,
+  globals: {
+    BigInt: true,
+    console: true,
+    WebAssembly: true,
   },
-  'rules': {
+  rules: {
     '@typescript-eslint/explicit-module-boundary-types': 'off',
     'eslint-comments/disable-enable-pair': [
       'error',
       {
-        'allowWholeFile': true,
+        allowWholeFile: true,
       },
     ],
     'import/order': [
       'error',
       {
         'newlines-between': 'always',
-        'alphabetize': {
-          'order': 'asc',
+        alphabetize: {
+          order: 'asc',
         },
       },
     ],
     'sort-imports': [
       'error',
       {
-        'ignoreDeclarationSort': true,
-        'ignoreCase': true,
+        ignoreDeclarationSort: true,
+        ignoreCase: true,
       },
     ],
   },

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,19 +9,23 @@
 
 - [ ] 1
 - [ ] 2
-- [X] 3
+- [x] 3
 
 **What this does:**
-> High-level idea of the changes introduced in this PR.
-> List relevant API changes (if any), as well as related PRs and issues.
+
+> High-level idea of the changes introduced in this PR. List relevant API
+> changes (if any), as well as related PRs and issues.
 
 **Issues fixed/closed:**
+
 > - Fixes #...
 
 **Why it's needed:**
-> Explain how this PR fits in the greater context of the NuCypher Network.
-> E.g., if this PR address a `nucypher/productdev` issue, let reviewers know!
+
+> Explain how this PR fits in the greater context of the NuCypher Network. E.g.,
+> if this PR address a `nucypher/productdev` issue, let reviewers know!
 
 **Notes for reviewers:**
-> What should reviewers focus on?
-> Is there a particular commit/function/section of your PR that requires more attention from reviewers?
+
+> What should reviewers focus on? Is there a particular commit/function/section
+> of your PR that requires more attention from reviewers?

.github/dependabot.yml

@@ -1,12 +1,12 @@
 version: 2
 updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
+  - package-ecosystem: 'github-actions'
+    directory: '/'
     schedule:
-      interval: "monthly"
+      interval: 'monthly'
     open-pull-requests-limit: 5
-  - package-ecosystem: "npm"
-    directory: "/"
+  - package-ecosystem: 'npm'
+    directory: '/'
     schedule:
-      interval: "monthly"
+      interval: 'monthly'
     open-pull-requests-limit: 5

.github/workflows/lynx.yml

@@ -2,26 +2,27 @@ name: '🔎 Lynx Testnet Example'
 
 on:
   schedule:
-    - cron: "0 * * * *"  # Every hour
+    - cron: '0 * * * *' # Every hour
   pull_request:
   workflow_dispatch:
 
 # TODO: Use variables when GH supports it for forks. See https://github.com/orgs/community/discussions/44322
 env:
-  RPC_PROVIDER_URL: "https://rpc-amoy.polygon.technology"
-  ENCRYPTOR_PRIVATE_KEY: "0x900edb9e8214b2353f82aa195e915128f419a92cfb8bbc0f4784f10ef4112b86"
-  CONSUMER_PRIVATE_KEY: "0xf307e165339cb5deb2b8ec59c31a5c0a957b8e8453ce7fe8a19d9a4c8acf36d4"
-  RITUAL_ID: "0"
+  RPC_PROVIDER_URL: 'https://rpc-amoy.polygon.technology'
+  ENCRYPTOR_PRIVATE_KEY: '0x900edb9e8214b2353f82aa195e915128f419a92cfb8bbc0f4784f10ef4112b86'
+  CONSUMER_PRIVATE_KEY: '0xf307e165339cb5deb2b8ec59c31a5c0a957b8e8453ce7fe8a19d9a4c8acf36d4'
+  RITUAL_ID: '0'
 
 jobs:
   networks:
-    name: '🔎 Lynx Testnet Example on Node ${{ matrix.node }} and ${{ matrix.os }}'
+    name:
+      '🔎 Lynx Testnet Example on Node ${{ matrix.node }} and ${{ matrix.os }}'
 
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node: [ '18.x' ]
-        os: [ ubuntu-latest ]
+        node: ['18.x']
+        os: [ubuntu-latest]
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/main.yml

@@ -1,5 +1,5 @@
 name: CI
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
@@ -9,8 +9,8 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node: [ '18.x', '20.x', '22.x' ]
-        os: [ ubuntu-latest ]
+        node: ['18.x', '20.x', '22.x']
+        os: [ubuntu-latest]
     steps:
       - uses: actions/checkout@v4
 
@@ -41,7 +41,6 @@ jobs:
         with:
           # https://community.codecov.com/t/upload-issues-unable-to-locate-build-via-github-actions-api/3954/21
           fail_ci_if_error: false
-
 # TODO: Fix or replace bundlemon on CI
 #      - name: Analyze bundle size
 #        uses: lironer/bundlemon-action@v1

.github/workflows/mainnet.yml

@@ -2,15 +2,15 @@ name: '🔎 Mainnet Example'
 
 on:
   schedule:
-    - cron: "0 * * * *"  # Every hour
+    - cron: '0 * * * *' # Every hour
   workflow_dispatch:
 
 # TODO: Use variables when GH supports it for forks. See https://github.com/orgs/community/discussions/44322
 env:
-  RPC_PROVIDER_URL: "https://rpc-mainnet.maticvigil.com"
+  RPC_PROVIDER_URL: 'https://rpc-mainnet.maticvigil.com'
   ENCRYPTOR_PRIVATE_KEY: ${{ secrets.MAINNET_ENCRYPTOR_PRIVATE_KEY }}
   CONSUMER_PRIVATE_KEY: ${{ secrets.MAINNET_CONSUMER_PRIVATE_KEY }}
-  RITUAL_ID: "9"
+  RITUAL_ID: '9'
 
 jobs:
   networks:
@@ -19,8 +19,8 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node: [ '18.x' ]
-        os: [ ubuntu-latest ]
+        node: ['18.x']
+        os: [ubuntu-latest]
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/npm.yml

@@ -2,16 +2,16 @@ name: 'Test npmjs.com package'
 
 on:
   schedule:
-    - cron: "0 * * * *"  # Every hour
+    - cron: '0 * * * *' # Every hour
   workflow_dispatch:
 
 jobs:
   npm:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '18.x' ]
-        version: [ 'latest', 'mainnet', 'devnet', 'testnet' ]
+        node: ['18.x']
+        version: ['latest', 'mainnet', 'devnet', 'testnet']
 
     steps:
       - uses: pnpm/action-setup@v4

.github/workflows/release.yml

@@ -2,14 +2,14 @@ name: Release
 on:
   push:
     branches:
-      - "main"
+      - 'main'
 
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
 jobs:
   publish:
     name: Publish NPM package using changesets
-    runs-on: "ubuntu-latest"
+    runs-on: 'ubuntu-latest'
     steps:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v4

.github/workflows/tapir.yml

@@ -2,28 +2,29 @@ name: '🔎 Tapir Testnet Example'
 
 on:
   schedule:
-    - cron: "0 * * * *"  # Every hour
+    - cron: '0 * * * *' # Every hour
   pull_request:
     branches:
       - main
   workflow_dispatch:
 
 # TODO: Use variables when GH supports it for forks. See https://github.com/orgs/community/discussions/44322
 env:
-  RPC_PROVIDER_URL: "https://rpc-amoy.polygon.technology"
-  ENCRYPTOR_PRIVATE_KEY: "0x900edb9e8214b2353f82aa195e915128f419a92cfb8bbc0f4784f10ef4112b86"
-  CONSUMER_PRIVATE_KEY: "0xf307e165339cb5deb2b8ec59c31a5c0a957b8e8453ce7fe8a19d9a4c8acf36d4"
-  RITUAL_ID: "0"
+  RPC_PROVIDER_URL: 'https://rpc-amoy.polygon.technology'
+  ENCRYPTOR_PRIVATE_KEY: '0x900edb9e8214b2353f82aa195e915128f419a92cfb8bbc0f4784f10ef4112b86'
+  CONSUMER_PRIVATE_KEY: '0xf307e165339cb5deb2b8ec59c31a5c0a957b8e8453ce7fe8a19d9a4c8acf36d4'
+  RITUAL_ID: '0'
 
 jobs:
   networks:
-    name: '🔎 Tapir Testnet Example on Node ${{ matrix.node }} and ${{ matrix.os }}'
+    name:
+      '🔎 Tapir Testnet Example on Node ${{ matrix.node }} and ${{ matrix.os }}'
 
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node: [ '18.x' ]
-        os: [ ubuntu-latest ]
+        node: ['18.x']
+        os: [ubuntu-latest]
 
     steps:
       - uses: actions/checkout@v4

demos/taco-demo/src/App.tsx

@@ -78,7 +78,9 @@ export default function App() {
     setDecryptedMessage('');
     setDecryptionErrors([]);
 
-    const encryptedMessageHex = await downloadData(encryptedMessageId) as string;
+    const encryptedMessageHex = (await downloadData(
+      encryptedMessageId,
+    )) as string;
     const encryptedMessage = ThresholdMessageKit.fromBytes(
       Buffer.from(encryptedMessageHex, 'hex'),
     );
@@ -119,7 +121,7 @@ export default function App() {
       <h2>Notice</h2>
       <p>
         In production (mainnet domain), your wallet address (encryptor) will also have
-        to be allow-listed for this specific ritual. However, we have 
+        to be allow-listed for this specific ritual. However, we have
         <a href={'https://docs.threshold.network/app-development/threshold-access-control-tac/integration-guide/get-started-with-tac#testnet-configuration'}>publicly available testnet rituals</a>
         for use when developing your apps.
       </p>

demos/taco-nft-demo/src/App.tsx

@@ -11,11 +11,11 @@ import { useEthers } from '@usedapp/core';
 import { ethers } from 'ethers';
 import React, { useEffect, useState } from 'react';
 
+import { DEFAULT_DOMAIN, DEFAULT_RITUAL_ID } from './config';
 import { Decrypt } from './Decrypt';
 import { Encrypt } from './Encrypt';
 import { NFTConditionBuilder } from './NFTConditionBuilder';
 import { Spinner } from './Spinner';
-import { DEFAULT_DOMAIN, DEFAULT_RITUAL_ID } from './config';
 
 const chainIdForDomain = {
   [domains.DEVNET]: 80002,
@@ -43,7 +43,6 @@ export default function App() {
     switchNetwork(chainId);
   }, [chainId]);
 
-
   const encryptMessage = async (message: string) => {
     if (!condition) {
       return;

demos/taco-nft-demo/src/NFTConditionBuilder.tsx

@@ -1,5 +1,5 @@
 import { conditions } from '@nucypher/taco';
-import { Sepolia, useEthers} from '@usedapp/core';
+import { Sepolia, useEthers } from '@usedapp/core';
 import React, { useState } from 'react';
 
 interface Props {
@@ -97,8 +97,8 @@ export const NFTConditionBuilder = ({
           <div>
             <p>
               You can mint an NFT{' '}
-              <a href="https://nfts2me.com/create/generative/">here</a> or use your own
-              contract.
+              <a href="https://nfts2me.com/create/generative/">here</a> or use
+              your own contract.
             </p>
           </div>
           <div>

demos/taco-nft-demo/tsconfig.json

@@ -6,11 +6,11 @@
     "noEmit": true,
     "resolveJsonModule": true,
     "esModuleInterop": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
   },
   "references": [
     {
-      "path": "../../packages/taco/tsconfig.es.json"
-    }
-  ]
+      "path": "../../packages/taco/tsconfig.es.json",
+    },
+  ],
 }

demos/taco-nft-demo/webpack.config.js

@@ -33,8 +33,8 @@ module.exports = {
           DEFAULT_RITUAL_ID: JSON.stringify(process.env.DEFAULT_RITUAL_ID),
           DEFAULT_DOMAIN: JSON.stringify(process.env.DEFAULT_DOMAIN),
         },
-      }
-    })
+      },
+    }),
   ].filter(Boolean),
   module: {
     rules: [

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

@@ -10,7 +10,7 @@ import {
   toHexString,
 } from '@nucypher/pre';
 import { ethers } from 'ethers';
-import { hexlify } from "ethers/lib/utils";
+import { hexlify } from 'ethers/lib/utils';
 import { useEffect, useState } from 'react';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any