From 98793d91bff735425e71bb14aa4437934cddee34 Mon Sep 17 00:00:00 2001 From: psofiterol Date: Wed, 26 Feb 2025 15:20:22 -0700 Subject: [PATCH] chore: replace all nillion-sv-wrappers references with secretvaults --- docs/build/nilQL.md | 5 +++-- docs/build/secret-vault.md | 2 +- docs/build/secretVault-secretDataAnalytics/build.md | 2 +- .../secretVault-secretDataAnalytics/create-schema.md | 8 ++++---- docs/build/secretVault-secretDataAnalytics/encryption.md | 2 +- .../secretVault-secretDataAnalytics/generate-tokens.md | 8 ++++---- docs/build/secretVault-secretDataAnalytics/retrieve.md | 8 ++++---- docs/build/secretVault-secretDataAnalytics/upload.md | 8 ++++---- 8 files changed, 22 insertions(+), 21 deletions(-) diff --git a/docs/build/nilQL.md b/docs/build/nilQL.md index 997eb44..b8d91c5 100644 --- 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 index 8388947..dea831d 100644 --- 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 index a39e7d4..915cae4 100644 --- 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 index 2664760..cb0fedb 100644 --- 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 -### 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 ```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 ``` ```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 ``` diff --git a/docs/build/secretVault-secretDataAnalytics/encryption.md b/docs/build/secretVault-secretDataAnalytics/encryption.md index feb9154..d18e895 100644 --- 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 index 8a161bb..bcf5431 100644 --- 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 -### 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 ```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 ``` ```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 ``` diff --git a/docs/build/secretVault-secretDataAnalytics/retrieve.md b/docs/build/secretVault-secretDataAnalytics/retrieve.md index ef95e50..e5a8375 100644 --- 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 -### 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 ```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 ``` ```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 ``` diff --git a/docs/build/secretVault-secretDataAnalytics/upload.md b/docs/build/secretVault-secretDataAnalytics/upload.md index 0aef535..eacac4f 100644 --- 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 -### 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 ```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 ``` ```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 ```