Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document split command #4062

Merged
merged 1 commit into from
Nov 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
26 changes: 26 additions & 0 deletions docs/src/guides/splitting.md
Original file line number Diff line number Diff line change
@@ -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}}
```
Loading