Skip to content

Commit b6d4036

Browse files
heueristikgitbook-bot
authored andcommitted
GITBOOK-62: No subject
1 parent 570ef93 commit b6d4036

30 files changed

+371
-450
lines changed

Diff for: SUMMARY.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,14 @@
2323
* [Resource Machine](learn/page/README.md)
2424
* [Information Flow Control](learn/page/information-flow-control.md)
2525
* [Resources](learn/resources/README.md)
26-
* [Resource Object](learn/resources/resource-object.md)
27-
* [Resource Logic](learn/resources/resource-logic.md)
26+
* [State](learn/resources/state.md)
27+
* [Logic](learn/resources/logic.md)
28+
* [Kind](learn/resources/kind.md)
29+
* [Lifecycle](learn/resources/lifecycle.md)
2830
* [Transactions](learn/transactions/README.md)
29-
* [Transaction Object](learn/transactions/transaction-object.md)
31+
* [Delta](learn/transactions/delta.md)
3032
* [Actions](learn/transactions/actions.md)
33+
* [Balanced Transactions](learn/transactions/balanced-transactions.md)
3134
* [Intents](learn/transactions/intents.md)
3235
* [Applications](learn/applications/README.md)
3336
* [Backend](learn/applications/backend.md)
@@ -36,11 +39,9 @@
3639
* [Indexing](learn/services/indexing.md)
3740
* [Solving](learn/services/solving.md)
3841

39-
## Further Resources
42+
***
4043

41-
* [Overview](further-resources/advanced.md)
42-
* [Juvix](further-resources/juvix/README.md)
43-
* [Installation Steps](further-resources/juvix/installation-steps.md)
44-
* [Install Juvix](further-resources/juvix/install-juvix.md)
45-
* [Write a Juvix Project](further-resources/juvix/write-a-juvix-project.md)
46-
* [Configure a Juvix Package](further-resources/juvix/configure-a-juvix-package.md)
44+
* [Data Structures](data-structures/README.md)
45+
* [Resource](data-structures/resource.md)
46+
* [Transaction](data-structures/transaction.md)
47+
* [Action](data-structures/action.md)

Diff for: build/anoma-app-examples/simplecounter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The following outlines the basics of the SimpleCounter example application. The
1111

1212
## Prerequisites
1313

14-
Before creating the SimpleCounter application, make sure to have [Juvix installed](../../further-resources/juvix/install-juvix.md). Also consider looking at [Your First Anoma dApp](../your-first-anoma-application/) for some introductory explanations.
14+
Before creating the SimpleCounter application, make sure to have [Juvix installed](broken-reference). Also consider looking at [Your First Anoma dApp](../your-first-anoma-application/) for some introductory explanations.
1515

1616
## Let's write some SimpleCounter code
1717

Diff for: build/getting-started.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
icon: screwdriver-wrench
32
description: Install Juvix in less than 5 minutes.
3+
icon: screwdriver-wrench
44
---
55

66
# Getting Started
@@ -14,7 +14,7 @@ Get started by installing Juvix in less than 5 minutes.
1414
Please select from the options below to install the Juvix compiler on your system. We currently support
1515

1616
* Linux `x86_64`
17-
* macOS `x86_64` and `aarch64 (M1/M2)` 
17+
* macOS `x86_64` and `aarch64 (M1/M2)`
1818

1919
{% hint style="info" %}
2020
All example applications are currently compliant with the `anoma-apps` [v0.2.0 release](https://github.com/anoma/anoma-apps/releases/tag/v0.2.0).
@@ -76,16 +76,16 @@ brew install --overwrite juvix-nightly
7676

7777
Alternatively, you can download and unzip the compiler executable linked below
7878

79-
* [macOS x86\_64](https://github.com/anoma/juvix-nightly-builds/releases/download/nightly-2025-02-13-0.6.9-8b06157/juvix-darwin-x86_64.tar.gz)
80-
* [macOS aarch64 (M1/M2)](https://github.com/anoma/juvix-nightly-builds/releases/download/nightly-2025-02-13-0.6.9-8b06157/juvix-darwin-aarch64.tar.gz)
79+
* [macOS x86\_64](https://github.com/anoma/juvix-nightly-builds/releases/download/nightly-2025-01-23-0.6.9-6ff4d88/juvix-darwin-x86_64.tar.gz)
80+
* [macOS aarch64 (M1/M2)](https://github.com/anoma/juvix-nightly-builds/releases/download/nightly-2025-01-23-0.6.9-6ff4d88/juvix-darwin-aarch64.tar.gz)
8181

8282
and move it to a directory on your shell's `PATH (e.g., /usr/local/bin`).
8383
{% endtab %}
8484

8585
{% tab title="Linux" %}
8686
Download and unzip the compiler executable linked below
8787

88-
* [Linux x86\_64](https://github.com/anoma/juvix-nightly-builds/releases/download/nightly-2025-02-13-0.6.9-8b06157/juvix-linux-x86_64.tar.gz)
88+
* [Linux x86\_64](https://github.com/anoma/juvix-nightly-builds/releases/download/nightly-2025-01-23-0.6.9-6ff4d88/juvix-linux-x86_64.tar.gz)
8989

9090
and move it to a directory on your shell's `PATH (e.g., /usr/local/bin`).
9191
{% endtab %}

Diff for: build/your-first-anoma-application/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
icon: rocket-launch
32
description: >-
43
A tutorial setting you up to build, run, and test your first Anoma
54
application.
5+
icon: rocket-launch
66
---
77

88
# Your First Anoma App
@@ -31,7 +31,7 @@ juvix init
3131
```
3232
{% endcode %}
3333

34-
In the following chapter, we're going to construct the scaffolding of the [resource object](../../learn/resources/resource-object.md) and add our custom label.
34+
In the following chapter, we're going to construct the scaffolding of the [resource object](broken-reference) and add our custom label.
3535

3636
Once the Juvix project is created, we want to change the `Package.juvix` file to the following:
3737

Diff for: data-structures/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
hidden: true
3+
icon: folder-tree
4+
---
5+
6+
# Data Structures
7+

Diff for: data-structures/action.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Action
2+
3+
```agda
4+
type Action :=
5+
mkAction@{
6+
commitments : List Nat;
7+
nullifiers : List Nat;
8+
proofs : List Proof;
9+
appData : Nat;
10+
};
11+
```
12+
13+
* **`commitments`:** Computed for each created resource (see [#creation](../learn/resources/#creation "mention")).
14+
* **`nullifiers`:** Computed for each consumed resource (see [#consumption](../learn/resources/#consumption "mention")).
15+
* **`proofs`:** Contains a logic and compliance proof for each resource referred in the `commitments` and `nullifiers` fields.
16+
* **`appData`:** A map (encoded as a natural number) containing arbitrary, application-specific data.

Diff for: learn/resources/resource-object.md renamed to data-structures/resource.md

+1-16
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,4 @@
1-
---
2-
description: This page describes the structure of the resource object in detail.
3-
layout:
4-
title:
5-
visible: true
6-
description:
7-
visible: true
8-
tableOfContents:
9-
visible: true
10-
outline:
11-
visible: true
12-
pagination:
13-
visible: true
14-
---
15-
16-
# Resource Object
1+
# Resource
172

183
The resource object is a data structure that contains multiple fields.
194

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
---
2-
description: This page describes the structure of the transaction object in detail.
3-
---
4-
5-
# Transaction Object
1+
# Transaction
62

73
Transactions contain all the data required to conduct an Anoma state transition.
84

@@ -16,9 +12,11 @@ type Transaction :=
1612
};
1713
```
1814

19-
* **`actions`:** A list of [actions](actions.md) constituting separate contexts for consumed and created resources.
15+
* **`actions`:** A list of [actions](../learn/transactions/actions.md) constituting separate contexts for consumed and created resources.
2016
* **`roots`:** A list of roots being required to prove that consumed resources have been created before.
2117
* **`delta`:** The transaction delta indicating if a transaction is balanced or not.
2218
* **`deltaProof`:** A proof that the transaction is balanced being required in the shielded case.
2319

2420
Further information can be found on [Anoma Resource Machine specs page](https://specs.anoma.net/latest/arch/system/state/resource_machine/index.html).
21+
22+
##

Diff for: further-resources/advanced.md

-9
This file was deleted.

Diff for: further-resources/juvix/README.md

-2
This file was deleted.

Diff for: further-resources/juvix/configure-a-juvix-package.md

-3
This file was deleted.

Diff for: further-resources/juvix/install-juvix.md

-7
This file was deleted.

Diff for: further-resources/juvix/installation-steps.md

-108
This file was deleted.

Diff for: further-resources/juvix/write-a-juvix-project.md

-84
This file was deleted.

Diff for: learn/applications/interface.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The application interface consists of two components:
1313

1414
## Transaction Functions 
1515

16-
Transaction functions take arbitrary input data and output a [transaction object](../transactions/transaction-object.md). Besides populating the transaction object with the required data[^1], they also take care of checking the input arguments for correctness and can return error messages.
16+
Transaction functions take arbitrary input data and output a [transaction object](broken-reference). Besides populating the transaction object with the required data[^1], they also take care of checking the input arguments for correctness and can return error messages.
1717

1818
Transaction function examples are:
1919

0 commit comments

Comments
 (0)