Skip to content

Commit 651a23a

Browse files
authored
fix: clarify README a bit (#23)
1 parent a3ff46d commit 651a23a

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This repository provides example code for **placing and filling Orders** on Signet, built using utilities from [signet-sdk](https://github.com/init4tech/signet-sdk).
44

5+
The repo is intended to _illustrate_ how Fillers can interact with the Signet SDK in order to build Filler software. It is a set of demos and examples; it is not a full-service, out-of-the-box, production-ready Filler.
6+
57
---
68

79
## Fillers
@@ -16,6 +18,7 @@ The `Filler` struct demonstrates the basic steps required to **fill Signet Order
1618
### Missing Components
1719
In production, a Filler will need to:
1820

21+
- Add **scaffolding** around the the Filler logic to run on a perpetual basis.
1922
- Implement custom **business logic** to determine which Orders to fill.
2023
- Potentially extend the example logic with **advanced strategies**, such as performing swaps to source liquidity between fills.
2124

@@ -114,6 +117,9 @@ Et voilà! 🎉
114117
---
115118

116119
### Troubleshooting
117-
Signet Bundles are tied to a **specific block**.
118-
If your Bundle is not included in that block, it will **not** mine in later blocks.
119-
Simply re-run the script to retry.
120+
Signet Bundles target one **specific block number**.
121+
If a Bundle is not included in that exact block, it won't be “retried” in subsequent blocks.
122+
123+
The current example script naively sends each Bundle to one single target block. When running the example, if Bundles are not mining, it is possible that they were simply not included in the target block. A naive solution is to simply re-run the script to try submitting a new Bundle.
124+
125+
More robust, production-ready software should include bespoke business logic to continually run the Filler logic, such that Bundles are perpetually (re)submitted on a block-by-block basis.

0 commit comments

Comments
 (0)