Document split command (ordinals#4062)

raphjaph · Nov 10, 2024 · 9b88cd9 · 9b88cd9
1 parent e473e78
commit 9b88cd9
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -22,6 +22,7 @@ Summary
   - [Explorer](guides/explorer.md)
   - [Wallet](guides/wallet.md)
   - [Batch Inscribing](guides/batch-inscribing.md)
+  - [Splitting](guides/splitting.md)
   - [Collecting](guides/collecting.md)
     - [Sparrow Wallet](guides/collecting/sparrow-wallet.md)
   - [Moderation](guides/moderation.md)

diff --git a/docs/src/guides/splitting.md b/docs/src/guides/splitting.md
@@ -0,0 +1,26 @@
+Splitting
+=========
+
+Complex transactions can be created using the `ord wallet split` command.
+
+The `split` command takes a YAML configuration file, which specifies any number
+of outputs to be created, their bitcoin value, and their value of any number of
+runes. It does not currently allow assigning inscriptions to outputs.
+
+The `split` command can be used to split cardinal, bitcoin-only outputs for
+transacting, distribute runes to large numbers of recipients in a single
+transaction.
+
+To send a split transaction using the configuration in `splits.yaml`, run the
+following command:
+
+```bash
+ord wallet split --fee-rate 21 --splits split.yaml
+```
+
+Example `splits.yaml`
+--------------------`
+
+```yaml
+{{#include ../../../splits.yaml}}
+```