feat!: Create private node using exchange key pair

wnfs-wg · Mar 31, 2024 · 0f322fe · 0f322fe
1 parent 055e351
commit 0f322fe
Show file tree

Hide file tree

Showing 5 changed files with 548 additions and 182 deletions.
diff --git a/packages/nest/README.md b/packages/nest/README.md
@@ -43,7 +43,7 @@ const fs = await FileSystem.create({
 })
 
 // Create the private node of which we'll keep the encryption key around.
-const { capsuleKey } = await fs.mountPrivateNode({
+const { capsuleKey } = await fs.createPrivateNode({
   path: Path.root(), // ie. root private directory
 })
 
@@ -146,11 +146,22 @@ const receiverDataRoot = dataRoot
 const { dataRoot } = await fs.share(pathToPrivateItem, receiverDataRoot)
 const sharerDataRoot = dataRoot
 // Step 5
-const { share } = await fs.receive(sharerDataRoot, publicKey, privateKey)
+const { share } = await fs.receive(sharerDataRoot, { publicKey, privateKey })
 
 await share.read('utf8')
 ```
 
+## Manage private node using exchange key pair
+
+Instead of keeping the symmetric capsule key around we can use an exchange key pair to mount a private node. This basically creates a share for ourselves.
+
+```ts
+await fs.createPrivateNode({
+  path: Path.root(),
+  exchangeKeyPair: { publicKey, privateKey }, // 🔑 Pass in key pair here
+})
+```
+
 ## Transactions
 
 ```ts