@inco/js 0.1.21 → 0.1.23

package/README.md

@@ -1,50 +1,106 @@
-# @inco/js (called `@inco/js` for now)
+# @inco/js
 
 The @inco/js package contains the TypeScript SDK for creating dapps built on Inco.
 
-## Install the package
+## Current Status: Active Development
 
-Since the package is private in the Github package registry, you'll need to use npm to log in into the registry first. Obviously, this is only needed if you want to access the package from outside the monorepo, as the monorepo already has workspaces set up.
+The SDK is currently going through active development, to support all new features that Inco offers. As such, do expect breaking changes in subsequent releases, which will be documented in the [CHANGELOG](./CHANGELOG.md). The current state of `@inco/js` includes all low-level blocks to build functional dapps, but an improved public-facing API is also in the works.
 
-1. Create a Github Personal Access Token (Classic)
+## Install
 
-Go to the [Personal Access Tokens](https://github.com/settings/tokens) page on Github, and create a new access token with the `read:packages` permission. Give it an explicit name like `inco-js-npm-github-pkg-registry`, and save the access token in a secure place, e.g. your password manager.
-
-2. Login via npm to Github Package Registry.
+Choose your favorite package manager:
 
 ```bash
-cd /path/to/my/project
-npm login --scope=@inco-fhevm --registry=https://npm.pkg.github.com
+npm install @inco/js
+# or
+bun install @inco/js
+# or
+yarn add @inco/js
 ```
 
-You'll be asked to enter Username and Password. Put in your Github username, and paste the access token on step 1 as password.
-
-3. Tell npm to look into Github Package Registry.
-
-Create a new `.npmrc` in `/path/to/my/project`, with the following lines:
+## Usage
 
-```
-@inco-fhevm:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=${READ_PACKAGE_TOKEN}
+A typical usage of `@inco/js` includes 3 steps:
+
+1. Encrypting a value.
+2. Posting the ciphertext to the contract, which will perform confidential computes on it.
+3. Requesting a reencryption of the result of the computation.
+
+### 1. Encrypt a value
+
+```ts
+import { getSupportedChain, getViemChain, handleTypes, HexString } from '@inco/js';
+import { EciesScheme, encryptionSchemes, PlaintextWithContextOf } from '@inco/js/encryption';
+import {
+  decodeSecp256k1PublicKey,
+  generateSecp256k1Keypair,
+  getActiveLightningDeployment,
+  getEciesEncryptor,
+} from '@inco/js/lite';
+import { createWalletClient, hexToBytes } from 'viem';
+
+// Setup. Do it once at initialization.
+const chain = getSupportedChain('baseSepolia');
+const lightningConfig = getActiveLightningDeployment(chain);
+const walletClient = createWalletClient({
+    chain: getViemChain(chain),
+    account: /* Choose your account */,
+    transport: /* Choose your transport */,
+});
+const dappAddress = '0x0000000000000000000000000000000000000000'; // Put your contract address here
+
+// Define plaintext, along with context needed for verification.
+const plaintext = 42n; // bigint
+const plaintextWithContext: PlaintextWithContextOf<EciesScheme, typeof handleTypes.euint256> = {
+    plaintext: {
+        scheme: encryptionSchemes.ecies,
+        value: plaintext,
+        type: handleTypes.euint256,
+    },
+    context: {
+        hostChainId: BigInt(chain.id),
+        aclAddress: lightningConfig.executorAddress,
+        userAddress: walletClient.account.address,
+        contractAddress: dappAddress,
+    },
+};
+
+// Encrypt.
+const ephemeralKeypair = await generateSecp256k1Keypair();
+const eciesPubKey = decodeSecp256k1PublicKey(hexToBytes(lightningConfig.eciesPublicKey));
+const encryptor = getEciesEncryptor({
+    scheme: encryptionSchemes.ecies,
+    pubKeyA: eciesPubKey,
+    privKeyB: ephemeralKeypair,
+});
+const { ciphertext } = await encryptor(plaintextWithContext);
+console.log(ciphertext.value); // Will print the encrypted value as hex
 ```
 
-Then, you can do `npm install @inco/js`!
+### 2. Post the ciphertext to the contract
 
-Note: If using bun or another package manager, take a look how they manage install scopes.
+For this step, there is nothing specific to the `@inco/js`. We recommend continue using [viem](https://viem.sh). In particular, take a look at their [`writeContract`](https://viem.sh/docs/contract/writeContract) methods to make a transaction on chain, and pass in the `ciphertext.value` from the previous step as the input ciphertext.
 
-4. Resources
+### 3. Request a reencryption
 
-- Github docs: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry
-- Medium article: https://medium.com/@aamiralihussain53/a-guide-to-publishing-private-npm-package-on-github-9c533a251e2d
+After submitting your transaction, the Inco covalidators will process your request and perform the computation. In your contract, the result handle of the computation should be stored on chain, let's call it `resultHandle` of type `Handle` (hex).
 
-## Usage
-
-Currently, there are no docs as how to use the @inco/js package, as it only exposes low-level functions. There's some API work to do to make it more user-friendly.
+```ts
+import { incoLiteReencryptor } from "@inco/js/lite";
+import { Hex } from "viem";
 
-To take a look at the low-level functions, see [the E2E test](./test/incolite.ts), which shows how to encrypt, send an encrypted input to the host chain, request a reencrypt and wait for a decrypt.
-
-## Publishing the package
+// Reencrypt.
+let resultHandle = "0x..." as Hex; // Retrieve it, e.g. by reading from your dapp contract.
+const reencryptor = await incoLiteReencryptor({
+  chainId: BigInt(chain.id),
+  walletClient: walletClient,
+}); // This step will ask you to sign an EIP-712 needed for reencryption verification
+const resultPlaintext = await reencryptor({
+  handle: resultHandle,
+});
+console.log(resultPlaintext.value); // Plaintext of the final result after computation
+```
 
-Currently the publishing process is manual, and anyone with enough rights can run `bun run publish:github` to publish to the Github Packages registry.
+## License
 
-Some gitops process should replace this manual setup.
+See the [LICENSE](./LICENSE) file.

package/dist/binary.d.ts

@@ -15,3 +15,6 @@ export declare function bytesToHex(bs: Uint8Array): Hex;
 export declare const Bytes32: Schema.brand<Schema.filter<Schema.transformOrFail<Schema.Union<[typeof Schema.String, Schema.refine<object & Uint8Array<ArrayBufferLike>, Schema.Schema<object, object, never>>]>, Schema.TemplateLiteral<`0x${string}`>, never>>, "Bytes32">;
 export declare function asBytes32(x: BytesIsh): Bytes32;
 export type Bytes32 = typeof Bytes32.Type;
+export type Address = typeof Address.Type;
+export declare const Address: Schema.brand<Schema.filter<Schema.TemplateLiteral<`0x${string}`>>, "Address">;
+export declare function parseAddress(address: string): Address;

package/dist/encryption/index.cjs

@@ -41,7 +41,7 @@ var __export = (target, all) => {
 };
 var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
 
-// node_modules/viem/_esm/utils/data/isHex.js
+// ../node_modules/viem/_esm/utils/data/isHex.js
 function isHex(value6, { strict: strict2 = true } = {}) {
   if (!value6)
     return false;
@@ -50,19 +50,18 @@ function isHex(value6, { strict: strict2 = true } = {}) {
   return strict2 ? /^0x[0-9a-fA-F]*$/.test(value6) : value6.startsWith("0x");
 }
 
-// node_modules/viem/_esm/utils/data/size.js
+// ../node_modules/viem/_esm/utils/data/size.js
 function size21(value6) {
   if (isHex(value6, { strict: false }))
     return Math.ceil((value6.length - 2) / 2);
   return value6.length;
 }
-var init_size = () => {
-};
+var init_size = () => {};
 
-// node_modules/viem/_esm/errors/version.js
-var version = "2.22.23";
+// ../node_modules/viem/_esm/errors/version.js
+var version = "2.24.3";
 
-// node_modules/viem/_esm/errors/base.js
+// ../node_modules/viem/_esm/errors/base.js
 function walk(err, fn) {
   if (fn?.(err))
     return err;
@@ -150,7 +149,7 @@ var init_base = __esm(() => {
   };
 });
 
-// node_modules/viem/_esm/errors/abi.js
+// ../node_modules/viem/_esm/errors/abi.js
 var AbiEncodingLengthMismatchError, BytesSizeMismatchError, UnsupportedPackedAbiType;
 var init_abi = __esm(() => {
   init_base();
@@ -180,7 +179,7 @@ var init_abi = __esm(() => {
   };
 });
 
-// node_modules/viem/_esm/errors/data.js
+// ../node_modules/viem/_esm/errors/data.js
 var SizeExceedsPaddingSizeError;
 var init_data = __esm(() => {
   init_base();
@@ -191,7 +190,7 @@ var init_data = __esm(() => {
   };
 });
 
-// node_modules/viem/_esm/utils/data/pad.js
+// ../node_modules/viem/_esm/utils/data/pad.js
 function pad(hexOrBytes, { dir: dir2, size: size22 = 32 } = {}) {
   if (typeof hexOrBytes === "string")
     return padHex(hexOrBytes, { dir: dir2, size: size22 });
@@ -229,7 +228,7 @@ var init_pad = __esm(() => {
   init_data();
 });
 
-// node_modules/viem/_esm/errors/encoding.js
+// ../node_modules/viem/_esm/errors/encoding.js
 var IntegerOutOfRangeError, SizeOverflowError;
 var init_encoding = __esm(() => {
   init_base();
@@ -245,7 +244,7 @@ var init_encoding = __esm(() => {
   };
 });
 
-// node_modules/viem/_esm/utils/encoding/fromHex.js
+// ../node_modules/viem/_esm/utils/encoding/fromHex.js
 function assertSize(hexOrBytes, { size: size22 }) {
   if (size21(hexOrBytes) > size22)
     throw new SizeOverflowError({
@@ -258,7 +257,7 @@ var init_fromHex = __esm(() => {
   init_size();
 });
 
-// node_modules/viem/_esm/utils/encoding/toHex.js
+// ../node_modules/viem/_esm/utils/encoding/toHex.js
 function toHex(value6, opts = {}) {
   if (typeof value6 === "number" || typeof value6 === "bigint")
     return numberToHex(value6, opts);
@@ -330,7 +329,7 @@ var init_toHex = __esm(() => {
   encoder2 = /* @__PURE__ */ new TextEncoder;
 });
 
-// node_modules/viem/_esm/utils/encoding/toBytes.js
+// ../node_modules/viem/_esm/utils/encoding/toBytes.js
 function toBytes(value6, opts = {}) {
   if (typeof value6 === "number" || typeof value6 === "bigint")
     return numberToBytes(value6, opts);
@@ -435,8 +434,7 @@ function aoutput(out, instance) {
     throw new Error("digestInto() expects output buffer of length at least " + min4);
   }
 }
-var init__assert = () => {
-};
+var init__assert = () => {};
 
 // ../node_modules/@noble/hashes/esm/_u64.js
 function fromBig(n, le = false) {
@@ -698,7 +696,7 @@ var init_sha3 = __esm(() => {
   shake256 = /* @__PURE__ */ genShake(31, 136, 256 / 8);
 });
 
-// node_modules/viem/_esm/utils/hash/keccak256.js
+// ../node_modules/viem/_esm/utils/hash/keccak256.js
 function keccak256(value6, to_) {
   const to = to_ || "hex";
   const bytes = keccak_256(isHex(value6, { strict: false }) ? toBytes(value6) : value6);
@@ -712,7 +710,7 @@ var init_keccak256 = __esm(() => {
   init_toHex();
 });
 
-// node_modules/viem/_esm/errors/address.js
+// ../node_modules/viem/_esm/errors/address.js
 var InvalidAddressError;
 var init_address = __esm(() => {
   init_base();
@@ -729,7 +727,7 @@ var init_address = __esm(() => {
   };
 });
 
-// node_modules/viem/_esm/utils/lru.js
+// ../node_modules/viem/_esm/utils/lru.js
 var LruMap;
 var init_lru = __esm(() => {
   LruMap = class LruMap extends Map {
@@ -763,7 +761,7 @@ var init_lru = __esm(() => {
   };
 });
 
-// node_modules/viem/_esm/utils/address/getAddress.js
+// ../node_modules/viem/_esm/utils/address/getAddress.js
 function checksumAddress(address_, chainId) {
   if (checksumAddressCache.has(`${address_}.${chainId}`))
     return checksumAddressCache.get(`${address_}.${chainId}`);
@@ -790,7 +788,7 @@ var init_getAddress = __esm(() => {
   checksumAddressCache = /* @__PURE__ */ new LruMap(8192);
 });
 
-// node_modules/viem/_esm/utils/address/isAddress.js
+// ../node_modules/viem/_esm/utils/address/isAddress.js
 function isAddress(address, options) {
   const { strict: strict2 = true } = options ?? {};
   const cacheKey = `${address}.${strict2}`;
@@ -816,12 +814,12 @@ var init_isAddress = __esm(() => {
   isAddressCache = /* @__PURE__ */ new LruMap(8192);
 });
 
-// node_modules/viem/_esm/utils/data/concat.js
+// ../node_modules/viem/_esm/utils/data/concat.js
 function concatHex(values7) {
   return `0x${values7.reduce((acc, x) => acc + x.replace("0x", ""), "")}`;
 }
 
-// node_modules/viem/_esm/utils/regex.js
+// ../node_modules/viem/_esm/utils/regex.js
 var arrayRegex, bytesRegex, integerRegex;
 var init_regex = __esm(() => {
   arrayRegex = /^(.*)\[([0-9]*)\]$/;
@@ -1503,8 +1501,7 @@ var tracingFunction = (name) => {
   };
 };
 var internalCall = /* @__PURE__ */ tracingFunction("effect_internal_function");
-var genConstructor = function* () {
-}.constructor;
+var genConstructor = function* () {}.constructor;
 
 // ../node_modules/effect/dist/esm/Hash.js
 var randomHashCache = /* @__PURE__ */ globalValue(/* @__PURE__ */ Symbol.for("effect/Hash/randomHashCache"), () => new WeakMap);
@@ -1851,8 +1848,7 @@ var StructuralCommitPrototype = {
   ...StructuralPrototype
 };
 var Base = /* @__PURE__ */ function() {
-  function Base2() {
-  }
+  function Base2() {}
   Base2.prototype = CommitPrototype;
   return Base2;
 }();
@@ -5355,8 +5351,7 @@ var Reference = () => (id, options) => {
   Error.stackTraceLimit = 2;
   const creationError = new Error;
   Error.stackTraceLimit = limit;
-  function ReferenceClass() {
-  }
+  function ReferenceClass() {}
   Object.setPrototypeOf(ReferenceClass, ReferenceProto);
   ReferenceClass.key = id;
   ReferenceClass.defaultValue = options.defaultValue;
@@ -8296,8 +8291,7 @@ var prettyErrorMessage = (u) => {
     if (hasProperty(u, "toString") && isFunction2(u["toString"]) && u["toString"] !== Object.prototype.toString && u["toString"] !== globalThis.Array.prototype.toString) {
       return u["toString"]();
     }
-  } catch {
-  }
+  } catch {}
   return stringifyCircular(u);
 };
 var locationRegex = /\((.*)\)/g;
@@ -8871,8 +8865,7 @@ var zip2 = /* @__PURE__ */ dual(2, (self, that) => flatMap6(self, (a) => map9(th
 var zipLeft = /* @__PURE__ */ dual(2, (self, that) => flatMap6(self, (a) => as(that, a)));
 var zipRight = /* @__PURE__ */ dual(2, (self, that) => flatMap6(self, () => that));
 var never = /* @__PURE__ */ asyncInterrupt(() => {
-  const interval = setInterval(() => {
-  }, 2 ** 31 - 1);
+  const interval = setInterval(() => {}, 2 ** 31 - 1);
   return sync(() => clearInterval(interval));
 });
 var interruptFiber = (self) => flatMap6(fiberId, (fiberId2) => pipe(self, interruptAsFiber(fiberId2)));
@@ -12692,16 +12685,11 @@ class Const {
   get value() {
     return this.effect;
   }
-  onStart(_context, _effect, _parent, _fiber) {
-  }
-  onEnd(_value, _fiber) {
-  }
-  onEffect(_fiber, _effect) {
-  }
-  onSuspend(_fiber) {
-  }
-  onResume(_fiber) {
-  }
+  onStart(_context, _effect, _parent, _fiber) {}
+  onEnd(_value, _fiber) {}
+  onEffect(_fiber, _effect) {}
+  onSuspend(_fiber) {}
+  onResume(_fiber) {}
   map(f) {
     return new ProxySupervisor(this, pipe(this.value, map9(f)));
   }
@@ -13175,8 +13163,7 @@ class FiberRuntime extends Class {
       return whileLoop({
         while: () => !isDone3,
         body,
-        step: () => {
-        }
+        step: () => {}
       });
     }
     return null;
@@ -22706,7 +22693,7 @@ class TrieIterator {
   }
 }
 var isTrie = (u) => hasProperty(u, TrieTypeId);
-// node_modules/viem/_esm/utils/abi/encodePacked.js
+// ../node_modules/viem/_esm/utils/abi/encodePacked.js
 init_abi();
 init_address();
 init_isAddress();
@@ -22775,7 +22762,7 @@ function encode6(type2, value6, isArray2 = false) {
   throw new UnsupportedPackedAbiType(type2);
 }
 
-// node_modules/viem/_esm/index.js
+// ../node_modules/viem/_esm/index.js
 init_toBytes();
 init_toHex();
 // src/schema.ts
@@ -22837,6 +22824,10 @@ var Bytes32 = BytesToHex.pipe(exports_Schema.filter((x) => x.length === 66 || `E
 function asBytes32(x) {
   return parse3(Bytes32, x);
 }
+var Address = HexString.pipe(exports_Schema.filter((s) => s.length === 42 || `Address must be a 20-byte '0x'-prefixed hex string, but got: ${s}`), exports_Schema.brand("Address"));
+function parseAddress(address) {
+  return parse3(Address, address);
+}
 
 // src/handle.ts
 var import_sha32 = __toESM(require_sha3());