You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-9Lines changed: 7 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,15 +8,13 @@ The only crate published to crates.io is `simplicity-contracts`, so read its [RE
8
8
9
9
If you are new to contract development with Simplicity HL, below you will find a step-by-step workflow for how a contract can be developed, deployed, and used.
10
10
11
-
Everything starts with the actual Simplicity HL code. See the [.simf files](crates/contracts/src), especially the [Options contract](crates/contracts/src/options/source_simf/options.simf) as the most structured example. Check the issues referenced in the contract for better understanding of development implications.
11
+
Everything starts with the actual Simplicity HL code. See the [.simf files](crates/contracts/src), especially the [Options contract](crates/contracts/src/finance/options/source_simf/options.simf) as the most structured example. Check the issues referenced in the contract for better understanding of development implications.
12
12
13
13
You can use tools like [`hal-simplicity`](https://github.com/BlockstreamResearch/hal-simplicity) for ad-hoc interaction and manual testing.
14
14
15
-
If you want to build an application or service around your new contract, take a look at the relevant builders of arguments and witness. See the [Options contract](crates/contracts/src/options/mod.rs) for how to write Rust functions to build those — it is well tested.
15
+
If you want to build an application or service around your new contract, take a look at the relevant builders of arguments and witness. See the [Options contract](crates/contracts/src/finance/options/mod.rs) for how to write Rust functions to build those.
16
16
17
-
The next step after writing helper functions to build args and witness is to do actual testing. Again, see [mod.rs](crates/contracts/src/options/mod.rs) as the best example.
18
-
19
-
Here you could also take a look at how relevant SDK functions in [options](crates/contracts/src/sdk/options) are structured, and what their responsibilities are.
17
+
The next step after writing helper functions to build args and witness is to do actual testing. Again, see [mod.rs](crates/contracts/src/finance/options/mod.rs) as the best example.
20
18
21
19
The last step is actual transaction publishing on the chain. This part can be found in the [CLI README](crates/cli/README.md).
22
20
@@ -28,8 +26,8 @@ Though this repository provides only examples, and because the basic Simplicity
28
26
29
27
## Important Concepts
30
28
31
-
It is recommended to study the [options.simf](crates/contracts/src/options/source_simf/options.simf) and related issues on GitHub to understand better how to write such contracts securely.
29
+
It is recommended to study the [options.simf](crates/contracts/src/finance/options/source_simf/options.simf) and related issues on GitHub to understand better how to write such contracts securely.
32
30
33
-
You can see how to use the storage for 32 bytes in the [bytes32_tr_storage.simf](crates/contracts/src/bytes32_tr_storage/source_simf/bytes32_tr_storage.simf) file.
34
-
For a more general case, see the [array_tr_storage.simf](crates/contracts/src/array_tr_storage/source_simf/array_tr_storage.simf) file.
35
-
You can find a more detailed explanation of how it works in the first file.
31
+
You can see how to use the storage for 32 bytes in the [bytes32_tr_storage.simf](crates/contracts/src/state_management/bytes32_tr_storage/source_simf/bytes32_tr_storage.simf) file.
32
+
For a more general case, see the [array_tr_storage.simf](crates/contracts/src/state_management/array_tr_storage/source_simf/array_tr_storage.simf) file.
33
+
You can find a more detailed explanation of how it works in the first file.
Copy file name to clipboardExpand all lines: crates/contracts/README.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,10 @@
1
-
# Simplicity HL Core -- Contracts
1
+
# Simplicity Contracts
2
2
3
3
This crate is a collection of contracts showcasing core possibilities of [Elements](https://docs.rs/elements) and [Simplicity HL](https://github.com/BlockstreamResearch/simfony).
4
4
5
-
Here you will find Simplicity HL implementations of [Options](https://blockstream.com/assets/downloads/pdf/options-whitepaper.pdf) (see [options](src/options)), Dual Currency Deposit Contract (see [dcd](src/dual_currency_deposit)), and more.
5
+
Here you will find Simplicity HL implementations of [Options](https://blockstream.com/assets/downloads/pdf/options-whitepaper.pdf) (see [finance/options](src/finance/options)), Dual Currency Deposit Contract (see [finance/dcd](src/finance/dcd)), storage contracts, and more.
6
6
7
-
The module that stands out is [`sdk`](src/sdk). This module does not contain contract source code; instead, it provides builder functions to help build Elements transactions to issue assets or transfer native currency (see [basic](src/sdk/basic)), as well as builder functions for the Options contract.
8
-
9
-
This SDK can be used as a reference for how to build libraries targeting a particular Simplicity contract, integrateable with mobile/desktop, etc.
7
+
Wallet-facing transaction construction is schema-first and lives in the wallet ABI crate. Contract-side modules in this crate focus on program compilation, argument/witness helpers, execution, and transaction finalization primitives.
0 commit comments