-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #35 from NillionNetwork/release
Release 0.2.1
- Loading branch information
Showing
22 changed files
with
1,369 additions
and
210 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| # Arithmetic and Logic | ||
|
|
||
| Nada programs can work with common arithmetic and logic values (such as integers and booleans) and operations (such as addition and conditional expressions). | ||
|
|
||
| ## Integers | ||
|
|
||
| The example below computes the revenue generated from the sales of two categories of product. In this example, all inputs are of type `SecretInteger`, so the result `revenue` is also of this type. | ||
|
|
||
| <iframe src='img/nada-lang-tutorial-arithmetic-and-logic-0.html' height='350px' width='100%'></iframe> | ||
| <!--```python | ||
| from nada_dsl import * | ||
| def nada_main(): | ||
| pricing = Party(name="pricing") | ||
| inventory = Party(name="inventory") | ||
| accounting = Party(name="accounting") | ||
| price_potato = SecretInteger(Input(name="price_potato", party=pricing)) | ||
| price_tomato = SecretInteger(Input(name="price_tomato", party=pricing)) | ||
| quantity_potato = SecretInteger(Input(name="quantity_potato", party=inventory)) | ||
| quantity_tomato = SecretInteger(Input(name="quantity_tomato", party=inventory)) | ||
| revenue = (price_potato * quantity_potato) + (price_tomato + quantity_tomato) | ||
| return [Output(revenue, "revenue", accounting)] | ||
| ````--> | ||
|
|
||
| Suppose that the price information is public. In this case, `revenue` is still of type [`SecretInteger`](nada-lang-types#primitive-data-types) because the quantity information is private. If `revenue` were of type [`PublicInteger`](nada-lang-types#primitive-data-types), it would (in some cases) be possible to determine the quantity information from the revenue by working backwards. | ||
|
|
||
| <iframe src='img/nada-lang-tutorial-arithmetic-and-logic-1.html' height='350px' width='100%'></iframe> | ||
| <!--```python | ||
| from nada_dsl import * | ||
| def nada_main(): | ||
| pricing = Party(name="pricing") | ||
| inventory = Party(name="inventory") | ||
| accounting = Party(name="accounting") | ||
| price_potato = PublicInteger(Input(name="price_potato", party=pricing)) | ||
| price_tomato = PublicInteger(Input(name="price_tomato", party=pricing)) | ||
| quantity_potato = SecretInteger(Input(name="quantity_potato", party=inventory)) | ||
| quantity_tomato = SecretInteger(Input(name="quantity_tomato", party=inventory)) | ||
| revenue = (price_potato * quantity_potato) + (price_tomato + quantity_tomato) | ||
| return [Output(revenue, "revenue", accounting)] | ||
| ```--> | ||
|
|
||
| What about integer values that appear in the program as literals (*i.e.*, they are not secret or public inputs) but are used within calculations involving inputs? These should be of type [`Integer`](nada-lang-types#primitive-data-types). | ||
|
|
||
| <iframe src='img/nada-lang-tutorial-arithmetic-and-logic-2.html' height='300px' width='100%'></iframe> | ||
| <!--```python | ||
| from nada_dsl import * | ||
| def nada_main(): | ||
| pricing = Party(name="pricing") | ||
| inventory = Party(name="inventory") | ||
| accounting = Party(name="accounting") | ||
| price = PublicInteger(Input(name="price", party=pricing)) | ||
| quantity = SecretInteger(Input(name="quantity", party=inventory)) | ||
| revenue_in_cents = Integer(100) * price * quantity | ||
| return [Output(revenue_in_cents, "revenue_in_cents", accounting)] | ||
| ```--> | ||
|
|
||
| ## Boolean Values and Comparison of Integers | ||
|
|
||
| Comparison operations can be applied to integers. Such comparison expressions evaluate to Nada boolean values. Whether this resulting value is secret depends on whether the integers being compared are secret. Furthermore, Nada boolean values support the `if_else` method, which implements a variant of the [ternary conditional operator](https://en.wikipedia.org/wiki/Ternary_conditional_operator) that can work with Nada values (even if they are secret). | ||
|
|
||
| The example below leverages both an integer comparison operator and the ternary operator to determine the larger of two secret inputs. | ||
|
|
||
| <iframe src='img/nada-lang-tutorial-arithmetic-and-logic-3.html' height='278px' width='100%'></iframe> | ||
| <!--```python | ||
| from nada_dsl import * | ||
| def nada_main(): | ||
| data_owner = Party(name="data_owner") | ||
| x = SecretInteger(Input(name="x", party=data_owner)) | ||
| y = SecretInteger(Input(name="y", party=data_owner)) | ||
| condition = x > y | ||
| maximum = condition.if_else(x, y) | ||
| return [Output(maximum, "maximum", data_owner)] | ||
| ```--> | ||
|
|
||
| ## Built-in Python Constants and Operations | ||
|
|
||
| Because Nada is a DSL embedded inside Python, [built-in constants of type `int` and `bool`](https://docs.python.org/3/library/stdtypes.html) (and the operators associated with these types) can be used directly. However, it is important to understand that these cannot be used interchangeably or mixed. The example below demonstrates both correct and incorrect usage of built-in and Nada values. | ||
|
|
||
| <iframe src='img/nada-lang-tutorial-arithmetic-and-logic-4.html' height='350px' width='100%'></iframe> | ||
| <!--```python | ||
| from nada_dsl import * | ||
| def nada_main(): | ||
| data_owner = Party(name="data_owner") | ||
| x = SecretInteger(Input(name="x", party=data_owner)) | ||
| # Permitted. | ||
| a = x + Integer(123) + Integer(456) | ||
| b = x + Integer(123 + 456) | ||
| # Not permitted. | ||
| c = x + 123 + 456 | ||
| d = x + 123 | ||
| return [Output(a, "a", data_owner), Output(b, "b", data_owner)] | ||
| ```--> | ||
| ```` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # Functions | ||
|
|
||
| The Nada DSL supports a limited form of user-defined functions. | ||
|
|
||
| ## Basic Example | ||
|
|
||
| The example below introduces a function that calculates the total of three secret integer values. Notice that the arguments and the function itself both have [Python type annotations](https://docs.python.org/3/library/typing.html). | ||
|
|
||
| <iframe src='img/nada-lang-tutorial-functions-0.html' height='334px' width='100%'></iframe> | ||
| <!--```python | ||
| from nada_dsl import * | ||
| def total(x: SecretInteger, y: SecretInteger, z: SecretInteger) -> SecretInteger: | ||
| return x + y + z | ||
| def nada_main(): | ||
| data_owner = Party(name="data_owner") | ||
| x = SecretInteger(Input(name="x", party=data_owner)) | ||
| y = SecretInteger(Input(name="y", party=data_owner)) | ||
| z = SecretInteger(Input(name="z", party=data_owner)) | ||
| t = total(x, y, z) | ||
| return [Output(t, "t", data_owner)] | ||
| ```--> |
Oops, something went wrong.