mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 04:07:57 +00:00
Chevdor
a30092ab42
* Add markdown linting - add linter default rules - adapt rules to current code - fix the code for linting to pass - add CI check fix #1243 * Fix markdown for Substrate * Fix tooling install * Fix workflow * Add documentation * Remove trailing spaces * Update .github/.markdownlint.yaml Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix mangled markdown/lists * Fix captalization issues on known words
24 lines
836 B
Markdown
24 lines
836 B
Markdown
# Atomic Swap
|
|
|
|
A module for atomically sending funds.
|
|
|
|
- [`atomic_swap::Config`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/trait.Config.html)
|
|
- [`Call`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/enum.Call.html)
|
|
- [`Module`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/struct.Module.html)
|
|
|
|
## Overview
|
|
|
|
A module for atomically sending funds from an origin to a target. A proof
|
|
is used to allow the target to approve (claim) the swap. If the swap is not
|
|
claimed within a specified duration of time, the sender may cancel it.
|
|
|
|
## Interface
|
|
|
|
### Dispatchable Functions
|
|
|
|
- `create_swap` - called by a sender to register a new atomic swap
|
|
- `claim_swap` - called by the target to approve a swap
|
|
- `cancel_swap` - may be called by a sender after a specified duration
|
|
|
|
License: Apache-2.0
|