chore(examples): add a nodejs-taco example

.gitignore

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

examples/README.md

@@ -1,4 +1,17 @@
-# `integration-examples`
+# `examples`
 
 This directory contains a set of examples showing how to integrate `@nucypher/*`
 into your application.
+
+## Examples
+
+- [**`nextjs`**](./nextjs): A Next.js application that uses `@nucypher/pre` to
+  encrypt and decrypt data.
+- [**`nodejs-pre`**](./nodejs-pre): A Node.js application that uses `@nucypher/pre` to
+  encrypt and decrypt data.
+- [**`nodejs-taco`**](./nodejs-taco): A Node.js application that uses `@nucypher/taco` to
+  encrypt and decrypt data.
+- [**`react`**](./react): A React application that uses `@nucypher/pre` to
+  encrypt and decrypt data.
+- [**`webpack`**](./webpack): A Webpack application that uses `@nucypher/pre` to
+  encrypt and decrypt data.

examples/nodejs-pre/.env.example

@@ -0,0 +1,2 @@
+RPC_PROVIDER_URL=
+PRIVATE_KEY=

examples/nodejs-pre/README.md

@@ -0,0 +1,20 @@
+# `nodejs-pre` integration example
+
+Shows how to use `@nucypher/pre in Node.js.
+
+## Setup
+
+Setup environment variables:
+
+```bash
+cp .env.example .env
+```
+
+Update `.env` with your values.
+
+## Usage
+
+```bash
+pnpm install
+pnpm start
+```

examples/nodejs/package.json → examples/nodejs-pre/package.json

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

examples/nodejs/src/index.ts → examples/nodejs-pre/src/index.ts

@@ -6,8 +6,21 @@ import {
   SecretKey,
   toBytes,
 } from '@nucypher/pre';
+import * as dotenv from 'dotenv';
 import { ethers } from 'ethers';
 
+dotenv.config();
+
+const rpcProviderUrl = process.env.RPC_PROVIDER_URL;
+if (!rpcProviderUrl) {
+  throw new Error('RPC_PROVIDER_URL is not set.');
+}
+
+const privateKey = process.env.PRIVATE_KEY;
+if (!privateKey) {
+  throw new Error('PRIVATE_KEY is not set.');
+}
+
 const makeAlice = () => {
   const secretKey = SecretKey.fromBEBytes(
     toBytes('fake-secret-key-32-bytes-alice-x'),
@@ -35,30 +48,21 @@ const getRandomLabel = () => `label-${new Date().getTime()}`;
 const runExample = async () => {
   await initialize();
 
-  const provider = ethers.Wallet.createRandom();
-
-  const remoteBob = makeRemoteBob();
-  const threshold = 2;
-  const shares = 3;
-  const startDate = new Date();
-  const endDate = new Date(Date.now() + 1000 * 60 * 60 * 24 * 30); // In 30 days
+  const provider = new ethers.providers.JsonRpcProvider(rpcProviderUrl);
+  const signer = new ethers.Wallet(privateKey);
   const policyParams = {
-    bob: remoteBob,
+    bob: makeRemoteBob(),
     label: getRandomLabel(),
-    threshold,
-    shares,
-    startDate,
-    endDate,
+    threshold: 2,
+    shares: 3,
+    startDate: new Date(),
+    endDate: new Date(Date.now() + 1000 * 60 * 60 * 24 * 30), // In 30 days,
   };
   const porterUri = getPorterUri('tapir'); // Test network
-
   const alice = makeAlice();
-  const policy = await alice.grant(
-    provider.provider,
-    provider,
-    porterUri,
-    policyParams,
-  );
+
+  console.log('Creating policy...');
+  const policy = await alice.grant(provider, signer, porterUri, policyParams);
 
   console.log('Policy created:');
   console.log({ policy });

examples/nodejs-taco/.env.example

@@ -0,0 +1,2 @@
+RPC_PROVIDER_URL=
+PRIVATE_KEY=

examples/nodejs-taco/README.md

@@ -0,0 +1,20 @@
+# `nodejs-taco` integration example
+
+Shows how to use `@nucypher/taco` in Node.js.
+
+## Setup
+
+Setup environment variables:
+
+```bash
+cp .env.example .env
+```
+
+Update `.env` with your values.
+
+## Usage
+
+```bash
+pnpm install
+pnpm start
+```

examples/nodejs-taco/package.json

@@ -0,0 +1,18 @@
+{
+  "version": "0.1.0",
+  "private": true,
+  "license": "GPL-3.0-only",
+  "author": "Piotr Rosłaniec <p.roslaniec@gmail.com>",
+  "scripts": {
+    "check": "pnpm type-check",
+    "start": "ts-node src/index.ts",
+    "type-check": "tsc"
+  },
+  "dependencies": {
+    "@nucypher/taco": "workspace:*",
+    "dotenv": "^16.3.1"
+  },
+  "peerDependencies": {
+    "ethers": "^5.7.2"
+  }
+}

examples/nodejs-taco/src/index.ts

@@ -0,0 +1,57 @@
+import {
+  conditions,
+  decrypt,
+  encrypt,
+  getPorterUri,
+  initialize,
+  toBytes,
+} from '@nucypher/taco';
+import * as dotenv from 'dotenv';
+import { ethers } from 'ethers';
+
+dotenv.config();
+
+const rpcProviderUrl = process.env.RPC_PROVIDER_URL;
+if (!rpcProviderUrl) {
+  throw new Error('RPC_PROVIDER_URL is not set.');
+}
+
+const privateKey = process.env.PRIVATE_KEY;
+if (!privateKey) {
+  throw new Error('PRIVATE_KEY is not set.');
+}
+
+const runExample = async () => {
+  await initialize();
+
+  console.log('Encrypting message...');
+  const provider = new ethers.providers.JsonRpcProvider(rpcProviderUrl);
+  const message = toBytes('this is a secret');
+  const ownsNFT = new conditions.ERC721Ownership({
+    contractAddress: '0x1e988ba4692e52Bc50b375bcC8585b95c48AaD77',
+    parameters: [3591],
+    chain: 5,
+  });
+  const ritualId = 91; // Replace with your own ritual ID
+  const messageKit = await encrypt(provider, message, ownsNFT, ritualId);
+
+  console.log('Decrypting message...');
+  const porterUri = getPorterUri('tapir'); // Test network
+  const signer = new ethers.Wallet(privateKey);
+  const decryptedMessage = await decrypt(
+    provider,
+    messageKit,
+    signer,
+    porterUri,
+  );
+
+  console.assert(decryptedMessage === message);
+};
+
+runExample()
+  .then(() => {
+    console.log('Example finished.');
+  })
+  .catch((err) => {
+    console.error('Example failed:', err);
+  });

examples/nodejs-taco/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src"],
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "noEmit": true
+  },
+  "references": [
+    {
+      "path": "../../packages/shared/tsconfig.cjs.json"
+    }
+  ]
+}

packages/pre/test/acceptance/alice-grants.test.ts

@@ -5,14 +5,6 @@ import {
   PublicKey,
   VerifiedKeyFrag,
 } from '@nucypher/nucypher-core';
-import {
-  ChecksumAddress,
-  EnactedPolicy,
-  Enrico,
-  initialize,
-  toBytes,
-  Ursula,
-} from '@nucypher/shared';
 import {
   bytesEqual,
   fakeAlice,
@@ -32,6 +24,15 @@ import {
 } from '@nucypher/test-utils';
 import { beforeAll, expect, test } from 'vitest';
 
+import {
+  ChecksumAddress,
+  EnactedPolicy,
+  Enrico,
+  initialize,
+  toBytes,
+  Ursula,
+} from '../../src';
+
 test('story: alice shares message with bob through policy', () => {
   const message = 'secret-message-from-alice';
   const threshold = 2;

packages/pre/test/acceptance/delay-enact.test.ts

@@ -1,4 +1,3 @@
-import { initialize } from '@nucypher/shared';
 import {
   bytesEqual,
   fakeAlice,
@@ -13,6 +12,8 @@ import {
 } from '@nucypher/test-utils';
 import { beforeAll, expect, test } from 'vitest';
 
+import { initialize } from '../../src';
+
 test('story: alice creates a policy but someone else enacts it', () => {
   const threshold = 2;
   const shares = 3;

packages/pre/test/docs.test.ts

@@ -1,14 +1,3 @@
-import {
-  Cohort,
-  ConditionExpression,
-  ContractCondition,
-  ContractConditionProps,
-  ERC721Ownership,
-  getPorterUri,
-  initialize,
-  SecretKey,
-  toBytes,
-} from '@nucypher/shared';
 import {
   fakeProvider,
   fakeUrsulas,
@@ -23,7 +12,18 @@ import {
 import { providers } from 'ethers';
 import { beforeAll, expect, test, vi } from 'vitest';
 
-import { PreStrategy } from '../src';
+import {
+  Cohort,
+  ConditionExpression,
+  ContractCondition,
+  ContractConditionProps,
+  ERC721Ownership,
+  getPorterUri,
+  initialize,
+  PreStrategy,
+  SecretKey,
+  toBytes,
+} from '../src';
 
 test('doc tests', async () => {
   beforeAll(async () => {

packages/pre/test/enrico.test.ts

@@ -1,13 +1,5 @@
 // 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,
@@ -17,6 +9,15 @@ 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/pre/test/message-kit.test.ts

@@ -1,7 +1,8 @@
-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();