Merge pull request #218 from NillionNetwork/psofiterol/update-sv

chore: replace all nillion-sv-wrappers references with secretvaults
NillionNetwork · Feb 26, 2025 · e912299 · e912299
2 parents 6054105 + 98793d9
commit e912299
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 21 deletions.
diff --git a/docs/build/nilQL.md b/docs/build/nilQL.md
@@ -10,7 +10,7 @@ Developers can use nilQL as a general-purpose encryption/decryption library for
 
 ### With SecretVault and SecretDataAnalytics
 
-You can interact with SecretVault and SecretDataAnalytics either directly through nilQL or using the optional [nillion-sv-wrappers](https://github.com/NillionNetwork/nillion-sv-wrappers) package:
+You can interact with SecretVault and SecretDataAnalytics either directly through nilQL or using the optional secretvaults package (available in [JS](https://github.com/NillionNetwork/secretvaults-js) and [Python](https://github.com/NillionNetwork/secretvaults-py)):
 
 - Use nilQL to encrypt record field values with your organization's private key before storage in a [SecretVault](/build/secret-vault) collection
 - Store the encrypted shares of record field values across your organization's nilDB nodes
@@ -20,7 +20,8 @@ You can interact with SecretVault and SecretDataAnalytics either directly throug
 
 - [nilql-ts](https://github.com/NillionNetwork/nilql-ts): TypeScript library for web and Node.js environments
 - [nilql-py](https://github.com/NillionNetwork/nilql-py): Python library for server-side applications
-- [nillion-sv-wrappers](https://github.com/NillionNetwork/nillion-sv-wrappers): an NPM package wrapper providing simplified integration with nilQL, SecretVault, and SecretDataAnalytics
+- [secretvaults (JS)](https://github.com/NillionNetwork/secretvaults-js): an NPM package wrapper providing simplified integration with nilQL & SecretVault
+- [secretvaults (Python)](https://github.com/NillionNetwork/secretvaults-py): an PyPi package wrapper providing simplified integration with nilQL & SecretVault
 
 ## Supported Operations
 

diff --git a/docs/build/secret-vault.md b/docs/build/secret-vault.md
@@ -17,7 +17,7 @@ This approach offers stronger security than traditional databases where all data
 
 ## How to use SecretVault
 
-Interact with [nilDB APIs](/api/overview) or the JS [nillion-sv-wrappers](https://github.com/NillionNetwork/secretvault-js) helper package shown in the [Quickstart](/build/secret-vault-quickstart) to use SecretVault (also available in [Python](https://github.com/NillionNetwork/secretvaults-py)). First complete setup by registering an organization and defining the structure of your data collections. After setup, you can securely store, retrieve, and query data from SecretVault.
+Interact with [nilDB APIs](/api/overview) or the JS [secretvaults](https://github.com/NillionNetwork/secretvault-js) helper package shown in the [Quickstart](/build/secret-vault-quickstart) to use SecretVault (also available in [Python](https://github.com/NillionNetwork/secretvaults-py)). First complete setup by registering an organization and defining the structure of your data collections. After setup, you can securely store, retrieve, and query data from SecretVault.
 
 ### 1. Register an Organization
 

diff --git a/docs/build/secretVault-secretDataAnalytics/build.md b/docs/build/secretVault-secretDataAnalytics/build.md
@@ -2,7 +2,7 @@
 
 ## How to use SecretVault APIs
 
-Interact with [nilDB APIs](/api/overview) or the JS [nillion-sv-wrappers](https://github.com/NillionNetwork/secretvault-js) helper package shown in the [Quickstart](/build/secret-vault-quickstart) to use SecretVault (also available in [Python](https://github.com/NillionNetwork/secretvaults-py)). First complete setup by registering an organization and defining the structure of your data collections. After setup, you can securely store, retrieve, and query data from SecretVault.
+Interact with [nilDB APIs](/api/overview) or the JS [secretvaults](https://github.com/NillionNetwork/secretvault-js) helper package shown in the [Quickstart](/build/secret-vault-quickstart) to use SecretVault (also available in [Python](https://github.com/NillionNetwork/secretvaults-py)). First complete setup by registering an organization and defining the structure of your data collections. After setup, you can securely store, retrieve, and query data from SecretVault.
 
 ### 1. Register an Organization
 

diff --git a/docs/build/secretVault-secretDataAnalytics/create-schema.md b/docs/build/secretVault-secretDataAnalytics/create-schema.md
@@ -137,10 +137,10 @@ https://github.com/NillionNetwork/blind-module-examples/blob/main/nildb/secretva
 </TabItem> 
 <TabItem value="wrapper" label="JavaScript (with wrapper)">
 
-### Install nillion-sv-wrappers
+### Install secretvaults
 
 ```bash
-npm i nillion-sv-wrappers
+npm i secretvaults
 ```
 
 ### Run the createSchema script
@@ -152,12 +152,12 @@ node createSchema.js
 <Tabs>
   <TabItem value="createSchema" label="createSchema.js">
 ```javascript reference showGithubLink
-https://github.com/NillionNetwork/nillion-sv-wrappers/blob/main/examples/createSchema.js
+https://github.com/NillionNetwork/secretvaults-js/blob/main/examples/createSchema.js
 ```
 </TabItem>
   <TabItem value="orgConfig" label="orgConfig.js">
 ```javascript reference showGithubLink
-https://github.com/NillionNetwork/nillion-sv-wrappers/blob/main/examples/orgConfig.js
+https://github.com/NillionNetwork/secretvaults-js/blob/main/examples/orgConfig.js
 ```
 </TabItem>
 </Tabs>

diff --git a/docs/build/secretVault-secretDataAnalytics/encryption.md b/docs/build/secretVault-secretDataAnalytics/encryption.md
@@ -79,5 +79,5 @@ const operation = {
 ```
 
 ```javascript reference showGithubLink
-https://github.com/NillionNetwork/nillion-sv-wrappers/blob/main/nilQl/wrapper.js#L47-L50
+https://github.com/NillionNetwork/secretvaults-js/blob/main/nilQl/wrapper.js#L47-L50
 ```
diff --git a/docs/build/secretVault-secretDataAnalytics/generate-tokens.md b/docs/build/secretVault-secretDataAnalytics/generate-tokens.md
@@ -80,10 +80,10 @@ https://github.com/NillionNetwork/blind-module-examples/blob/main/nildb/secretva
 
 <TabItem value="wrapper" label="JavaScript (with wrapper)">
 
-### Install nillion-sv-wrappers
+### Install secretvaults
 
 ```bash
-npm i nillion-sv-wrappers
+npm i secretvaults
 ```
 
 ### Run the generateApiTokens script
@@ -95,12 +95,12 @@ node generateApiTokens.js
 <Tabs>
   <TabItem value="generateApiTokens" label="generateApiTokens.js">
 ```javascript reference showGithubLink
-https://github.com/NillionNetwork/nillion-sv-wrappers/blob/main/examples/generateApiTokens.js
+https://github.com/NillionNetwork/secretvaults-js/blob/main/examples/generateApiTokens.js
 ```
 </TabItem>
   <TabItem value="orgConfig" label="orgConfig.js">
 ```javascript reference showGithubLink
-https://github.com/NillionNetwork/nillion-sv-wrappers/blob/main/examples/orgConfig.js
+https://github.com/NillionNetwork/secretvaults-js/blob/main/examples/orgConfig.js
 ```
 </TabItem>
 

diff --git a/docs/build/secretVault-secretDataAnalytics/retrieve.md b/docs/build/secretVault-secretDataAnalytics/retrieve.md
@@ -69,10 +69,10 @@ https://github.com/NillionNetwork/blind-module-examples/blob/main/nildb/secretva
 </TabItem>
 <TabItem value="wrapper" label="JavaScript (with wrapper)">
 
-### Install nillion-sv-wrappers
+### Install secretvaults
 
 ```bash
-npm i nillion-sv-wrappers
+npm i secretvaults
 ```
 
 ### Run the readWriteSv script
@@ -84,12 +84,12 @@ node readWriteSv.js
 <Tabs>
   <TabItem value="readWriteSv" label="readWriteSv.js">
 ```javascript reference showGithubLink
-https://github.com/NillionNetwork/nillion-sv-wrappers/blob/main/examples/readWriteSv.js
+https://github.com/NillionNetwork/secretvaults-js/blob/main/examples/readWriteSv.js
 ```
 </TabItem>
   <TabItem value="orgConfig" label="orgConfig.js">
 ```javascript reference showGithubLink
-https://github.com/NillionNetwork/nillion-sv-wrappers/blob/main/examples/orgConfig.js
+https://github.com/NillionNetwork/secretvaults-js/blob/main/examples/orgConfig.js
 ```
 </TabItem>
 </Tabs>

diff --git a/docs/build/secretVault-secretDataAnalytics/upload.md b/docs/build/secretVault-secretDataAnalytics/upload.md
@@ -104,10 +104,10 @@ https://github.com/NillionNetwork/blind-module-examples/blob/main/nildb/secretva
 </TabItem>
 <TabItem value="wrapper" label="JavaScript (with wrapper)">
 
-### Install nillion-sv-wrappers
+### Install secretvaults
 
 ```bash
-npm i nillion-sv-wrappers
+npm i secretvaults
 ```
 
 ### Run the readWriteSv script
@@ -119,12 +119,12 @@ node readWriteSv.js
 <Tabs>
   <TabItem value="readWriteSv" label="readWriteSv.js">
 ```javascript reference showGithubLink
-https://github.com/NillionNetwork/nillion-sv-wrappers/blob/main/examples/readWriteSv.js
+https://github.com/NillionNetwork/secretvaults-js/blob/main/examples/readWriteSv.js
 ```
 </TabItem>
   <TabItem value="orgConfig" label="orgConfig.js">
 ```javascript reference showGithubLink
-https://github.com/NillionNetwork/nillion-sv-wrappers/blob/main/examples/orgConfig.js
+https://github.com/NillionNetwork/secretvaults-js/blob/main/examples/orgConfig.js
 ```
 </TabItem>
 </Tabs>