🆕 Nillion SDK Release v0.6.0

[oceans404]

What’s new

• Bug Fixes: Resolved timeout issues for the get quote function.
• Nada Operators: Added not (~) operator
• Nada CLI Tools: Added metrics and a benchmarking tool for improved performance analysis.
• Testing Framework: Launched nada-test, a new Nada testing framework with enhanced features like ordered inputs/outputs and execution results in test files.
• Nillion Client Enhancements: Introduced retrieve_permissions, a new API for retrieving permissions of a secret.
• GRPC Update: New recommended GRPC endpoint for Python Client users

⛓️‍💥 Breaking changes

Developers will need to upgrade to the latest versions of the Nillion SDK and Nillion Clients due to breaking changes:

1. Program Compatibility: Existing Nada programs compiled with previous versions of nillion tools will not work until they are recompiled with the latest version of the nillion SDK. Please follow the upgrade steps to recompile your programs.
2. Nada Test Files: The nada test tool has been updated, and older test files will no longer be compatible. You must regenerate all test files using the new format. Refer to the upgrade steps for detailed instructions on how to generate the new test files.
3. GRPC Update for Nillion Python Client Users: If you’re using the Nillion Python Client and the nillion-python-helpers package, be aware of a breaking change in the GRPC configuration. Please upgrade to the latest versions of the py-nillion-client and nillion-python-helpers packages and update your network configuration to reflect the new recommended GRPC endpoint to ensure continued functionality.

📋 How to upgrade

1. Upgrade to the latest SDK version using nilup], the installer and version manager for the Nillion SDK

   nilup install latest
   nilup use latest

2. Upgrade Python packages: Nada, Python Client, and other Nillion libraries

   1. https://pypi.org/project/nada-dsl/ 0.6.0
   2. https://pypi.org/project/py-nillion-client/ 0.6.0
   3. https://pypi.org/project/nada-numpy/ 0.5.2
   4. https://pypi.org/project/nada-ai/ 0.5.0
   5. https://pypi.org/project/nillion-python-helpers/ 0.3.1

3. Upgrade JavaScript packages: ts-client

   npm i -D @nillion/client-core@latest @nillion/client-vms@latest @nillion/client-react-hooks@latest

4. Version 0.6.0 introduces updates to nada test, and removes the need to define a Nada value’s type within the test file. Re-generate nada test files with this command:

   nada generate-test --test-name [test-name] [program-name]
   

   Nada test file before 0.6.0

   ---
   program: addition
   inputs:
     num_1:
       SecretInteger: '30'
     num_2:
       SecretInteger: '10'
   expected_outputs:
     sum:
       SecretInteger: '40'

   Nada test file after 0.6.0

   ---
   program: addition
   inputs:
     num_1: 30
     num_2: 10
   expected_outputs:
     sum: 40

5. Re-compile all Nada programs

   nada build

6. Python Client users should update their Python .env to use the recommended Lavender Five GRPC endpoint.

   Previous GRPC: 65.109.228.73:9090

   Recommended GRPC: https://testnet-nillion-grpc.lavenderfive.com

7. Store all re-compiled Nada programs (using the new [program].nada.bin binary files) on the Nillion Testnet (Photon or Nucleus) - endpoints haven’t changed

🔧 New feature descriptions & resources

Metrics flag for nada run

We’ve introduced a new --metrics flag for the nada run command, allowing you to capture detailed test execution metrics in text, a yaml file, or a json file. This feature helps developers analyze program performance and protocol efficiency.

• Program metrics docs

Benchmarking tool for Nada CLI

Our new Nada CLI benchmarking tool allows you to evaluate the performance of your programs across multiple runs. The benchmark summary includes test duration, number of protocol rounds, round data, preprocessing elements, local operations executed, and online protocol steps.

• Benchmarking docs

NOT (~) Nada Operator

The NOT operator, represented by the tilde symbol (~), is used in the Nada DSL to invert or negate a boolean value. When applied to a boolean expression, the ~ operator flips its value—turning True to False and False to True.

• Nada by Example: NOT operator

Nada-Test Framework

nada-test is a testing framework designed for Nada programs, allowing you to write tests in a simple and flexible way. Unlike the static YAML test files that can be generated with the nada tool, nada-test generates dynamic tests at runtime based on the test functions you write, offering greater flexibility.

• nada-test docs
• example using nada-test to test the simple_shuffle program

Retrieve Permissions API

The Retrieve Permissions API lets you access the current permissions associated with your secret data and check if a user has access to an operation. Use this feature to check who has retrieval rights before performing operations, ensuring that your security policies are enforced.

• retrieve_permissions usage example