chore(refactor): divide shared package into pre and taco

.gitignore

@@ -14,3 +14,4 @@ examples/*/pnpm-lock.yaml
 pnpm-debug.log
 docs-json
 ./docs
+.next

examples/nextjs/package.json

@@ -9,7 +9,7 @@
     "type-check": "tsc -p tsconfig.build.json"
   },
   "dependencies": {
-    "@nucypher/shared": "workspace:*",
+    "@nucypher/pre": "workspace:*",
     "@types/node": "20.6.3",
     "@types/react": "18.2.22",
     "@types/react-dom": "18.2.7",
@@ -22,7 +22,6 @@
     "typescript": "5.2.2"
   },
   "peerDependencies": {
-    "@nucypher/shared": "workspace:*",
     "ethers": "^5.7.2",
     "typescript": "5.2.2"
   }

examples/nextjs/src/app/page.tsx

@@ -7,7 +7,7 @@ import {
   initialize,
   SecretKey,
   toHexString,
-} from '@nucypher/shared';
+} from '@nucypher/pre';
 import {ethers} from 'ethers';
 import {useEffect, useState} from 'react';
 

examples/nodejs/package.json

@@ -9,7 +9,9 @@
     "type-check": "tsc"
   },
   "dependencies": {
-    "@nucypher/shared": "workspace:*",
+    "@nucypher/pre": "workspace:*"
+  },
+  "peerDependencies": {
     "ethers": "^5.7.2"
   }
 }

examples/nodejs/src/index.ts

@@ -5,7 +5,7 @@ import {
   initialize,
   SecretKey,
   toBytes,
-} from '@nucypher/shared';
+} from '@nucypher/pre';
 import { ethers } from 'ethers';
 
 const makeAlice = () => {

examples/pre/nextjs/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

examples/react/package.json

@@ -23,8 +23,7 @@
     ]
   },
   "dependencies": {
-    "@nucypher/shared": "workspace:*",
-    "ethers": "^5.7.2",
+    "@nucypher/pre": "workspace:*",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
@@ -33,5 +32,8 @@
     "@types/react": "^18.2.21",
     "@types/react-dom": "^18.2.7",
     "react-scripts": "^5.0.1"
+  },
+  "peerDependencies": {
+    "ethers": "^5.7.2"
   }
 }

examples/react/src/App.tsx

@@ -6,7 +6,7 @@ import {
   initialize,
   SecretKey,
   toHexString,
-} from '@nucypher/shared';
+} from '@nucypher/pre';
 import { ethers } from 'ethers';
 import { useEffect, useState } from 'react';
 

examples/taco/nextjs/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

examples/webpack-5/package.json

@@ -11,14 +11,16 @@
     "type-check": "tsc"
   },
   "dependencies": {
-    "@nucypher/shared": "workspace:*",
-    "ethers": "^5.7.2"
+    "@nucypher/pre": "workspace:*"
   },
   "devDependencies": {
     "copy-webpack-plugin": "^10.2.4",
     "esbuild-loader": "^2.11.0",
     "webpack": "^5.4.0",
     "webpack-cli": "^4.9.2",
     "webpack-dev-server": "^4.7.4"
+  },
+  "peerDependencies": {
+    "ethers": "^5.7.2"
   }
 }

examples/webpack-5/src/index.ts

@@ -1,10 +1,4 @@
-import {
-  Alice,
-  Bob,
-  SecretKey,
-  getPorterUri,
-  initialize,
-} from '@nucypher/shared';
+import { Alice, Bob, SecretKey, getPorterUri, initialize } from '@nucypher/pre';
 import { ethers } from 'ethers';
 
 declare global {

packages/shared/src/characters/alice.ts → packages/pre/src/characters/alice.ts

@@ -4,6 +4,7 @@ import {
   Signer,
   VerifiedKeyFrag,
 } from '@nucypher/nucypher-core';
+import { ChecksumAddress, PorterClient } from '@nucypher/shared';
 import { ethers } from 'ethers';
 
 import { Keyring } from '../keyring';
@@ -13,8 +14,6 @@ import {
   EnactedPolicy,
   PreEnactedPolicy,
 } from '../policy';
-import { PorterClient } from '../porter';
-import { ChecksumAddress } from '../types';
 
 import { RemoteBob } from './bob';
 

packages/shared/src/characters/bob.ts → packages/pre/src/characters/bob.ts

@@ -5,11 +5,10 @@ import {
   SecretKey,
   Signer,
 } from '@nucypher/nucypher-core';
+import { PorterClient, zip } from '@nucypher/shared';
 
 import { Keyring } from '../keyring';
 import { PolicyMessageKit, RetrievalResult } from '../kits';
-import { PorterClient } from '../porter';
-import { zip } from '../utils';
 
 export class RemoteBob {
   private constructor(

packages/pre/src/characters/enrico.ts

@@ -0,0 +1,39 @@
+import { MessageKit, PublicKey, SecretKey } from '@nucypher/nucypher-core';
+import { ConditionExpression, toBytes } from '@nucypher/shared';
+
+import { Keyring } from '../keyring';
+
+export class Enrico {
+  public readonly encryptingKey: PublicKey;
+  private readonly keyring: Keyring;
+  public conditions?: ConditionExpression | undefined;
+
+  constructor(
+    encryptingKey: PublicKey,
+    verifyingKey?: SecretKey,
+    conditions?: ConditionExpression,
+  ) {
+    this.encryptingKey = encryptingKey;
+    this.keyring = new Keyring(verifyingKey ?? SecretKey.random());
+    this.conditions = conditions;
+  }
+
+  public get verifyingKey(): PublicKey {
+    return this.keyring.publicKey;
+  }
+
+  public encryptMessagePre(
+    plaintext: Uint8Array | string,
+    withConditions?: ConditionExpression,
+  ): MessageKit {
+    if (!withConditions) {
+      withConditions = this.conditions;
+    }
+
+    return new MessageKit(
+      this.encryptingKey,
+      plaintext instanceof Uint8Array ? plaintext : toBytes(plaintext),
+      withConditions ? withConditions.toWASMConditions() : null,
+    );
+  }
+}

packages/shared/src/characters/index.ts → packages/pre/src/characters/index.ts

@@ -1,3 +1,4 @@
 export * from './alice';
 export * from './bob';
 export * from './enrico';
+export * from './pre-recipient';

packages/pre/src/pre-recipient.ts → packages/pre/src/characters/pre-recipient.ts

@@ -10,15 +10,15 @@ import {
   base64ToU8Receiver,
   ConditionContext,
   ConditionExpression,
-  Keyring,
-  PolicyMessageKit,
   PorterClient,
-  RetrievalResult,
   toJSON,
   zip,
 } from '@nucypher/shared';
 import { ethers } from 'ethers';
 
+import { Keyring } from '../keyring';
+import { PolicyMessageKit, RetrievalResult } from '../kits';
+
 export type PreDecrypterJSON = {
   porterUri: string;
   policyEncryptingKeyBytes: Uint8Array;

packages/pre/src/index.ts

@@ -1,21 +1,11 @@
-// TODO: Create a pre module and export it here
-// Similarly to how taco works
-// export {pre} from './pre';
-// What goes into the pre module? Should we re-export the basic building blocks and/or remake the helper methods?
 export {
-  Alice,
-  BlockchainPolicyParameters,
-  Bob,
   Cohort,
-  EnactedPolicy,
-  Enrico,
-  Keyring,
-  PolicyMessageKit,
   PorterClient,
-  PreEnactedPolicy,
-  RemoteBob,
   conditions,
+  fromHexString,
   getPorterUri,
+  toBytes,
+  toHexString,
 } from '@nucypher/shared';
 
 export {
@@ -27,8 +17,11 @@ export {
   SecretKey,
   Signer,
   TreasureMap,
+  initialize,
 } from '@nucypher/nucypher-core';
 
 export { DeployedPreStrategy, PreStrategy } from './pre-strategy';
 
-export { PreDecrypter } from './pre-recipient';
+export { Alice, Bob, PreDecrypter } from './characters';
+
+export { EnactedPolicy } from './policy';

packages/shared/src/keyring.ts → packages/pre/src/keyring.ts

@@ -7,9 +7,9 @@ import {
   Signer,
   VerifiedKeyFrag,
 } from '@nucypher/nucypher-core';
+import { toBytes } from '@nucypher/shared';
 
 import { PolicyMessageKit } from './kits';
-import { toBytes } from './utils';
 
 export class Keyring {
   constructor(public readonly secretKey: SecretKey) {}

packages/shared/src/kits/message.ts → packages/pre/src/kits/message.ts

@@ -5,8 +5,7 @@ import {
   RetrievalKit,
   SecretKey,
 } from '@nucypher/nucypher-core';
-
-import { ChecksumAddress } from '../types';
+import { ChecksumAddress } from '@nucypher/shared';
 
 import { RetrievalResult } from './retrieval';
 

packages/shared/src/kits/retrieval.ts → packages/pre/src/kits/retrieval.ts

@@ -1,6 +1,5 @@
 import { VerifiedCapsuleFrag } from '@nucypher/nucypher-core';
-
-import { ChecksumAddress } from '../types';
+import { ChecksumAddress } from '@nucypher/shared';
 
 export class RetrievalResult {
   constructor(

packages/shared/src/policy.ts → packages/pre/src/policy.ts

@@ -6,13 +6,17 @@ import {
   TreasureMap,
   VerifiedKeyFrag,
 } from '@nucypher/nucypher-core';
+import {
+  PreSubscriptionManagerAgent,
+  toBytes,
+  toCanonicalAddress,
+  toEpoch,
+  Ursula,
+  zip,
+} from '@nucypher/shared';
 import { ethers } from 'ethers';
 
 import { Alice, RemoteBob } from './characters';
-import { PreSubscriptionManagerAgent } from './contracts';
-import { Ursula } from './porter';
-import { toBytes, toEpoch, zip } from './utils';
-import { toCanonicalAddress } from './web3';
 
 export type EnactedPolicy = {
   readonly id: HRAC;

packages/pre/src/pre-strategy.ts

@@ -1,18 +1,21 @@
 import { PublicKey, SecretKey } from '@nucypher/nucypher-core';
 import {
-  Alice,
   base64ToU8Receiver,
-  Bob,
   Cohort,
   CohortJSON,
   ConditionExpression,
-  EnactedPolicy,
-  Enrico,
   toJSON,
 } from '@nucypher/shared';
 import { ethers } from 'ethers';
 
-import { PreDecrypter, PreDecrypterJSON } from './pre-recipient';
+import {
+  Alice,
+  Bob,
+  Enrico,
+  PreDecrypter,
+  PreDecrypterJSON,
+} from './characters';
+import { EnactedPolicy } from './policy';
 
 export type PreStrategyJSON = {
   cohort: CohortJSON;

packages/shared/test/integration/enrico.test.ts → packages/pre/test/enrico.test.ts

@@ -1,5 +1,13 @@
 // Disabling because we want to access Alice.keyring which is a private property
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import {
+  ConditionExpression,
+  Enrico,
+  ERC721Ownership,
+  PolicyMessageKit,
+  RetrievalResult,
+  toBytes,
+} from '@nucypher/shared';
 import {
   bytesEqual,
   fakeAlice,
@@ -9,15 +17,6 @@ import {
 } from '@nucypher/test-utils';
 import { expect, test } from 'vitest';
 
-import {
-  ConditionExpression,
-  Enrico,
-  ERC721Ownership,
-  PolicyMessageKit,
-  RetrievalResult,
-  toBytes,
-} from '../../src';
-
 test('enrico', () => {
   test('alice decrypts message encrypted by enrico', async () => {
     const label = 'fake-label';

packages/shared/test/integration/message-kit.test.ts → packages/pre/test/message-kit.test.ts

@@ -1,8 +1,7 @@
+import { MessageKit, toBytes } from '@nucypher/shared';
 import { fakeBob } from '@nucypher/test-utils';
 import { expect, test } from 'vitest';
 
-import { MessageKit, toBytes } from '../../src';
-
 test('message kit', () => {
   test('bob decrypts', () => {
     const bob = fakeBob();