Refactor library architecture

.github/actions/setup-smplx/action.yml

@@ -17,6 +17,6 @@ runs:
       shell: bash
       run: |
         set -euo pipefail
-        REVISION="${{ inputs.commit-sha}}"
+        REVISION="${{ inputs.commit-sha }}"
         OWNER_REPO="${{ inputs.owner-repo }}"
         bash "$GITHUB_WORKSPACE/.github/scripts/setup-smplx" "${REVISION}" "${OWNER_REPO}"

.github/workflows/tests.yml

@@ -46,8 +46,6 @@ jobs:
 
       - name: Install simplex-cli
         uses: ./.github/actions/setup-smplx
-        with:
-          commit-sha: '3afcc04aae8a0a92722b28bc1d16ef27983d4aa1'
 
       - name: Generate contract artifacts
         shell: bash

Cargo.toml

@@ -5,8 +5,7 @@ rust-version = "1.91.0"
 version = "0.1.0"
 
 [dependencies]
-# todo: Replace git dependency with crates.io version that supports modules once available
-smplx-std = { git = "https://github.com/BlockstreamResearch/smplx.git", rev = "3afcc04" }
+smplx-std = "0.0.7"
 
 anyhow = { version = "1.0.101" }
 rand = { version = "0.8.6" }

README.md

@@ -3,32 +3,22 @@
 This repository contains the standard library for [SimplicityHL](https://github.com/BlockstreamResearch/SimplicityHL).
 
 > [!NOTE]
-> If you are using the VS Code syntax highlighting extension, you may see errors because the extension does not support modules and imports yet.
+> The VS Code syntax-highlighting extension does not yet support modules and imports, so you may see spurious errors when editing files in this repo.
 
-## Dev Info
-### Installation
+## Installation
 
-> Project currently uses Simplex version 0.0.6 from the dev branch.
+> Project currently uses Simplex version `0.0.7`.
 
-To compile the project, execute the following command:
-
-```bash
-cargo build
-```
-
-To download simplexup, run:
+Install `siplexup`, then use it to install the pinned Simplex toolchain:
 
 ```bash
 curl -L https://smplx.simplicity-lang.org | bash
+simplexup
 ```
 
-To install a specific Simplex version (in this case from the specific commit):
-
-```bash
-simplexup --commit 3afcc04aae8a0a92722b28bc1d16ef27983d4aa1
-```
+## Usage
 
-### Compilation
+### Build
 
 To compile the contracts, execute the following command:
 
@@ -56,22 +46,21 @@ To run the tests using multiple threads:
 simplex test --test-threads 8
 ```
 
-To run a specific test:
+To run a specific test module:
 
 ```bash
-simplex test test_name
+simplex test u8_test
 ```
 
-### Linting
-
-To format the rust files, execute the following command:
+To run a specific test:
 
 ```bash
-cargo fmt
+simplex test test_name
 ```
 
-To check the project for common mistakes:
+### Lint & format
 
 ```bash
+cargo fmt
 cargo clippy --workspace --all-targets --all-features -- -D warnings
 ```

Simplex.toml

@@ -1,10 +1,13 @@
-# Default Simplex Config
+# DEFAULT CONFIG 
 
 # [build]
 # src_dir = "./simf"
 # simf_files = ["*.simf"]
 # out_dir = "./src/artifacts"
 
+# [dependencies]
+# some_dep = { git = "<git url>", path = "<or a relative path>" } 
+
 # [regtest]
 # mnemonic = "exist carry drive collect lend cereal occur much tiger just involve mean"
 # bitcoins = 10_000_000
@@ -16,6 +19,7 @@
 # [test]
 # mnemonic = "exist carry drive collect lend cereal occur much tiger just involve mean"
 # bitcoins = 10_000_000
+# verbosity = 0
 
 # [test.esplora]
 # url = "<esplora url>"