Skip to content

Commit 56c1ff1

Browse files
committed
Fixed typos in README.md
1 parent 057cdcd commit 56c1ff1

File tree

1 file changed

+33
-10
lines changed

1 file changed

+33
-10
lines changed

Readme.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
# Simplicity DEX
22

3-
A distributed exchange built on the NOSTR protocol, leveraging Simplicity smart contracts and the PACT (PACT for Auditable Contract Transactions) messaging protocol.
3+
A distributed exchange built on the NOSTR protocol, leveraging Simplicity smart contracts and the PACT (PACT for
4+
Auditable Contract Transactions) messaging protocol.
45

56
## Overview
67

7-
Simplicity DEX is a decentralized exchange that combines the power of Simplicity smart contracts with the distributed messaging capabilities of NOSTR. By utilizing the PACT protocol, we enable secure, auditable, and transparent trading of digital assets without relying on centralized intermediaries.
8+
Simplicity DEX is a decentralized exchange that combines the power of Simplicity smart contracts with the distributed
9+
messaging capabilities of NOSTR. By utilizing the PACT protocol, we enable secure, auditable, and transparent trading of
10+
digital assets without relying on centralized intermediaries.
811

912
## Key Features
1013

@@ -16,11 +19,13 @@ Simplicity DEX is a decentralized exchange that combines the power of Simplicity
1619

1720
## DEX Messaging Protocol
1821

19-
The core of our DEX is the **PACT (PACT for Auditable Contract Transactions)** protocol, which defines the format of trading offers. This protocol is fully adapted to be compatible with the NOSTR event structure.
22+
The core of our DEX is the **PACT (PACT for Auditable Contract Transactions)** protocol, which defines the format of
23+
trading offers. This protocol is fully adapted to be compatible with the NOSTR event structure.
2024

2125
### Offer Structure
2226

23-
A PACT offer is implemented as a standard NOSTR event with kind `30078` (non-standard, ephemeral event kind for DEX offers). The event structure maps to PACT requirements as follows:
27+
A PACT offer is implemented as a standard NOSTR event with kind `30078` (non-standard, ephemeral event kind for DEX
28+
offers). The event structure maps to PACT requirements as follows:
2429

2530
| NOSTR Field | PACT Field | Data Type | Required | Description |
2631
|---------------|---------------|-----------------------|----------|-------------------------------------------------------------------------------------------------------------------|
@@ -39,11 +44,28 @@ The `tags` field contains structured metadata as key-value pairs:
3944

4045
```json
4146
[
42-
["asset_to_sell", "<liquid_asset_id>"],
43-
["asset_to_buy", "<liquid_asset_id>"],
44-
["price", "1000000", "sats_per_contract"],
45-
["expiry", "1735689600"],
46-
["compiler", "simplicity-v1.2.3", "deterministic_build_hash"]
47+
[
48+
"asset_to_sell",
49+
"<liquid_asset_id>"
50+
],
51+
[
52+
"asset_to_buy",
53+
"<liquid_asset_id>"
54+
],
55+
[
56+
"price",
57+
"1000000",
58+
"sats_per_contract"
59+
],
60+
[
61+
"expiry",
62+
"1735689600"
63+
],
64+
[
65+
"compiler",
66+
"simplicity-v1.2.3",
67+
"deterministic_build_hash"
68+
]
4769
]
4870
```
4971

@@ -99,4 +121,5 @@ This project is licensed under the MIT License - see the LICENSE file for detail
99121

100122
## Disclaimer
101123

102-
This software is experimental and should be used with caution. Always verify contract code and understand the risks before trading.
124+
This software is experimental and should be used with caution. Always verify contract code and understand the risks
125+
before trading.

0 commit comments

Comments
 (0)