🆕 Nillion SDK Release v0.2.1

[oceans404]

Nillion SDK Release 0.2.1 includes new Nada language features, improvements to the nada tool, 2 breaking changes to the Nillion Python Client, and the sunsetting of SecretArrays.

How to upgrade

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

nilup install latest
nilup use latest

• Install nada-dsl version 0.2.1
• Install py-nillion-client version 0.2.1
• Install @nillion/nillion-client-js-browser version 0.2.1

2. If you are using Nada programs, you need to recompile all programs. Programs compiled with a previous version of the Nillion SDK need to be recompiled with pynadac to be stored and used with version 0.2.1 of the SDK.
3. If you are using the Nillion Python Client, follow migration steps for breaking changes to user_id and party_id (see below)

What’s new

🎉 New Nada Language Features

Nillion SDK Release 0.2.1 introduces private equality, left shift, right shift, and probabilistic truncation to the Nada language.

Name	Syntax	Supported Types (P: Public, S: Secret)
Private Equality	x == y	S ← S == S, S ← S == P, S ← P == S, P ← P == P
Left Shift	x << y	P ← P << P, S ← S << P
Right Shift	x >> y	P ← P >> P, S ← S >> P
Probabilistic truncation	x.trunc_pr(y)	S ← S.trunc_pr(P)

Check out https://docs.nillion.com/nada-lang-operators for a full overview of the primitive Nada operations.

⛏️ Nada Tool Improvements

The nada tool now has the ability to print program requirements, and get a Nada program’s protocols model and bytecode in text format. Check out the nada tool documentation to learn more about usage https://docs.nillion.com/nada

Print program requirements

The new program-requirements command prints the runtime requirements of the preprocessing elements of a program.

Example: 3 Party addition program

from nada_dsl import *

def nada_main():
    party1 = Party(name="Party1")
    party2 = Party(name="Party2")
    party3 = Party(name="Party3")
    a = SecretInteger(Input(name="A", party=party1))
    b = SecretInteger(Input(name="B", party=party2))

    result = a + b

    return [Output(result, "my_output", party3)]

Command: nada program-requirements <program-name>

Program requirements printed for the 3 Party addition program example with nada program-requirements main

Requirements:
 ProgramRequirements {
    alpha_elements: 2,
    runtime_elements: {
        Lambda: 2,
    },
}

Check out the docs here: https://docs.nillion.com/nada#get-program-requirements

Get a Nada program’s protocols model in text format

Command: nada run <test-name> --protocols-text

Protocols model main.nada.protocols.txt text file generated for the 3 Party addition program example with nada run main --protocols-text

Inputs:

iaddr(0): A (ref 0) (sizeof: 1)
iaddr(1): B (ref 0) (sizeof: 1)

Literals:

Protocols:
rty(ShamirShareInteger) = P2S iaddr(0)   # result = a + b  -> main.py:10
rty(ShamirShareInteger) = P2S iaddr(1)   # result = a + b  -> main.py:10
rty(ShamirShareInteger) = ADD addr(2) addr(3)   # result = a + b  -> main.py:10

Outputs:
addr(4): my_output

Check out the docs here: https://docs.nillion.com/nada#run-and-get-protocols-model-text-file

Get a Nada program’s bytecode in text format

Here’s the bytecode main.nada.bytecode.txt text file generated for the 3 Party addition program example with nada run main --bytecode-text

Header:
Party: Party1 id(0)   # party1 = Party(name="Party1")  -> main.py:4
 Inputs:
  iaddr(0) rty(SecretInteger) = Input(A)   # a = SecretInteger(Input(name="A", party=party1))  -> main.py:7
 Outputs:

Party: Party2 id(1)   # party2 = Party(name="Party2")  -> main.py:5
 Inputs:
  iaddr(1) rty(SecretInteger) = Input(B)  # b = SecretInteger(Input(name="B", party=party2))  -> main.py:8
 Outputs:

Party: Party3 id(2)   # party3 = Party(name="Party3")  -> main.py:6
 Inputs:
 Outputs:
  oaddr(0) rty(SecretInteger) = Output(my_output) addr(2)  #   -> main.py:12

Literals:



Operations:
addr(0) rty(SecretInteger) = Load iaddr(0)  # a = SecretInteger(Input(name="A", party=party1))  -> main.py:7
addr(1) rty(SecretInteger) = Load iaddr(1)   # b = SecretInteger(Input(name="B", party=party2))  -> main.py:8
addr(2) rty(SecretInteger) = Addition addr(0) addr(1)  # result = a + b  -> main.py:10

Check out the docs here: https://docs.nillion.com/nada#run-and-get-bytecode-in-text-format

⛓️‍💥 Breaking Changes

Nillion Python Client user_id and party_id have changed from methods to attributes

The user_id() and party_id() Nillion Python Client methods have been deprecated and replaced with attributes. This change reduces the overhead of method calls for accessing these properties and keeps the Nillion Python Client consistent with the Nillion JavaScript Client, which has user_id and party_id attributes. Check out user_id and party_id in the Python Client Reference.

• user_id() → user_id
• party_id() → party_id

Migration Steps:

1. Search for instances: Use your IDE or code searching tools to find all instances where user_id() and party_id() are called on the Nillion Python Client.
2. Replace method calls: Replace all method calls with attribute accesses as shown in the Version 0.2.1 example.
3. Test: Thoroughly test your application to ensure that there are no issues due to this change.

# Previous: user_id and party_id methods
print("User ID:", client.user_id())
print("Party ID:", client.party_id())

# Version 0.2.1: user_id and party_id attributes
print("User ID:", client.user_id)
print("Party ID:", client.party_id)

🌅 Sunsetting SecretArray in favor of Python lists

We are removing any reference to the experimental SecretArray type from the documentation. We believe the use of Python lists is more effective for development. The Nada DSL supports the introduction and use of Python lists that contain secret integer values. This includes using a subset of the list comprehension syntax supported by Python. Check out updated Nada Language documentation and examples of using Python lists of SecretIntegers:

• Lists and comprehensions: https://docs.nillion.com/nada-lang-tutorial-lists-and-comprehensions
• Lists and iteration: https://docs.nillion.com/nada-lang-tutorial-lists-and-iteration