Skip to content

Commit 4f91ecd

Browse files
committed
update simfony references to SimplicityHL in README.md
1 parent c8f6498 commit 4f91ecd

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
Simfony is a high-level language for writing Bitcoin smart contracts.
1+
SimplicityHL is a high-level language for writing Bitcoin smart contracts.
22

3-
Simfony looks and feels like [Rust](https://www.rust-lang.org). Just how Rust compiles down to assembly language, Simfony compiles down to [Simplicity](https://github.com/BlockstreamResearch/simplicity) bytecode. Developers write Simfony, full nodes execute Simplicity.
3+
SimplicityHL looks and feels like [Rust](https://www.rust-lang.org). Just how Rust compiles down to assembly language, SimplicityHL compiles down to [Simplicity](https://github.com/BlockstreamResearch/simplicity) bytecode. Developers write SimplicityHL, full nodes execute Simplicity.
44

5-
**Simfony is a work in progress and is not yet ready for production use.**
5+
**SimplicityHL is a work in progress and is not yet ready for production use.**
66

77
```rust
88
let a: u32 = 10;
@@ -16,49 +16,49 @@ let b = {
1616
assert!(jet::eq_32(b, 7));
1717
```
1818

19-
Take a look at the [example programs](https://github.com/BlockstreamResearch/simfony/tree/master/examples).
19+
Take a look at the [example programs](https://github.com/BlockstreamResearch/SimplicityHL/tree/master/examples).
2020

2121
## MSRV
2222

2323
This crate should compile with any feature combination on **Rust 1.78.0** or higher.
2424

2525
## Simplicity's need for a high-level language
2626

27-
Simplicity introduces a groundbreaking low-level programming language and machine model meticulously crafted for blockchain-based smart contracts. The primary goal is to provide a streamlined and comprehensible foundation that facilitates static analysis and encourages reasoning through formal methods. While the elegance of the language itself is distilled into something as succinct as fitting onto a T-shirt, it's important to note that the simplicity of the language doesn't directly equate to simplicity in the development process. Simfony revolves around demystifying and simplifying the complexities involved in this ecosystem.
27+
Simplicity introduces a groundbreaking low-level programming language and machine model meticulously crafted for blockchain-based smart contracts. The primary goal is to provide a streamlined and comprehensible foundation that facilitates static analysis and encourages reasoning through formal methods. While the elegance of the language itself is distilled into something as succinct as fitting onto a T-shirt, it's important to note that the simplicity of the language doesn't directly equate to simplicity in the development process. SimplicityHL revolves around demystifying and simplifying the complexities involved in this ecosystem.
2828

2929
The distinguishing aspects that set Simplicity apart from conventional programming languages are:
3030

3131
- **Distinct Programming Paradigm**: Simplicity's programming model requires a paradigm shift from conventional programming. It hinges on reasoning about programs in a functional sense with a focus on combinators. This intricacy surpasses even popular functional languages like Haskell, with its own unique challenges.
3232
- **Exceptional Low-Level Nature**: Unlike high-level languages such as JavaScript or Python, Simplicity operates at an extremely low level, resembling assembly languages. This design choice enables easier reasoning about the formal semantics of programs, but is really work on directly.
3333

34-
## Simfony
34+
## SimplicityHL
3535

36-
Simfony is a high-level language that compiles to Simplicity. It maps programming concepts from Simplicity onto programming concepts that developers are more familar with. In particular, Rust is a popular language whose functional aspects fit Simplicity well. Simfony aims to closely resemble Rust.
36+
SimplicityHL is a high-level language that compiles to Simplicity. It maps programming concepts from Simplicity onto programming concepts that developers are more familar with. In particular, Rust is a popular language whose functional aspects fit Simplicity well. SimplicityHL aims to closely resemble Rust.
3737

38-
Just how Rust is compiled to assembly language, Simfony is compiled to Simplicity. Just how writing Rust doesn't necessarily produce the most efficient assembly, writing Simfony doesn't necessarily produce the most efficient Simplicity code. The compilers try to optimize the target code they produce, but manually written target code can be more efficient. On the other hand, a compiled language is much easier to read, write and reason about. Assembly is meant to be consumed by machines while Rust is meant to be consumed by humans. Simplicity is meant to be consumed by Bitcoin full nodes while Simfony is meant to be consumed by Bitcoin developers.
38+
Just how Rust is compiled to assembly language, SimplicityHL is compiled to Simplicity. Just how writing Rust doesn't necessarily produce the most efficient assembly, writing SimplicityHL doesn't necessarily produce the most efficient Simplicity code. The compilers try to optimize the target code they produce, but manually written target code can be more efficient. On the other hand, a compiled language is much easier to read, write and reason about. Assembly is meant to be consumed by machines while Rust is meant to be consumed by humans. Simplicity is meant to be consumed by Bitcoin full nodes while SimplicityHL is meant to be consumed by Bitcoin developers.
3939

4040
## Installation
4141

42-
Clone the repo and build the Simfony compiler using cargo.
42+
Clone the repo and build the SimplicityHL compiler using cargo.
4343

4444
```bash
45-
git clone https://github.com/BlockstreamResearch/simfony.git
46-
cd simfony
45+
git clone https://github.com/BlockstreamResearch/SimplicityHL.git
46+
cd SimplicityHL
4747
cargo build
4848
```
4949

50-
Optionally, install the Simfony compiler using cargo.
50+
Optionally, install the SimplicityHL compiler using cargo.
5151

5252
```bash
5353
cargo install --path .
5454
```
5555

5656
## Usage
5757

58-
The Simfony compiler takes two arguments:
58+
The SimplicityHL compiler takes two arguments:
5959

60-
1. A path to a Simfony program file (`.simf`)
61-
1. A path to a Simfony witness file (`.wit`, optional)
60+
1. A path to a SimplicityHL program file (`.simf`)
61+
1. A path to a SimplicityHL witness file (`.wit`, optional)
6262

6363
The compiler produces a base64-encoded Simplicity program. Witness data will be included if a witness file is provided.
6464

0 commit comments

Comments
 (0)