Nillion Client
There are 3 Nillion Clients - a Python, JavaScript, and CLI Client. Each Nillion Client provides APIs that you can use for generating user and node keys, and managing programs, secrets, and permissions on the Nillion Network.
Nillion Client Guides
🗃️ Python Client
3 items.
🗃️ JavaScript Client
3 items.
📄️ CLI Client
The nillion tool is a command-line version of the Nillion Client. We refer to the tool as the CLI Client.
NillionClient
Create an instance of NillionClient
NillionClient creates an instance of the Nillion Client library with node key, bootnodes, connection mode, user key, and payments parameters. This client instance interacts with programs, secrets, and permissions on the network as the user via their user key.
Programs
Store a program
store_program uploads a compiled Nada program to the Nillion Network.
store_program returns the stored program's program_id from the network.
Run a stored program
compute runs a stored Nada program by program_id against stored secrets by store_id and secret_name and/or secrets provided by the user when running compute. A user needs permission to compute on stored secrets for a specific program.
compute returns the program result from the network.
Program permissions
| Operation | Permission needed | Description |
|---|---|---|
store_program | - | Any user with an allowlisted peer ID can store a program on the Nillion Network |
compute | add_compute_permissions | Allows a user to compute on the secret for a specific program |
Secrets
Store secrets
store_secrets uploads permissioned secrets to the Nillion Network. Each secret value is uploaded with a secret_name that is set by the user. Every node in the network stores a particle of these secrets.
store_secrets returns the secret's store_id from the network.
Set permissions while storing secrets
The user storing the secrets can give "default permissions" of the secrets with default_for_user(user_id). Any user_id with these "default permissions" will have permission to retrieve and update secret permissions.
The user storing the secret can give other user_ids limited permissions to the secrets by specifying the user_id to allowlist and the intended secret permissions (retrieve / update / delete / compute) to grant that user.
| Permission | Operation unlocked | Description |
|---|---|---|
default_for_user | permissions | Allows a user to update permissions for a secret |
add_retrieve_permissions | retrieve_secret | Allows a user to read or retrieve a secret |
add_update_permissions | update_secret | Allows a user to update a secret |
add_delete_permissions | delete_secret | Allows a user to delete a secret |
add_compute_permissions | compute | Allows a user to compute on a secret as an input to a specific program ID |
Retrieve a secret
retrieve_secret retrieves a secret by store_id and secret_name. A user needs to have secret retrieve permissions (add_retrieve_permissions) to retrieve a stored secret.
retrieve_secret returns the secret from the network.
Update a secret
update_secret updates a secret value by store_id. A user needs to have secret update permissions (add_update_permissions) to update a stored secret.
Delete a secret
delete_secret deletes a secret value by store_id. A user needs to have secret delete permissions (add_delete_permissions) to delete a stored secret.
Permissions
Update permissions
update_permissions replaces the permissions of a secret by store_id. A user needs to have default_for_user permissions (grants the ability to retrieve and update secret permissions) to update permissions of a stored secret.
The user updating permissions for the secrets can give other user_ids limited permissions to the secrets by specifying the user_id to allowlist and the intended secret permissions to grant that user.