mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 15:47:58 +00:00
22632efc5f
* Re-generate READMEs to fix doc links; set readme field in package manifests * Re-generate READMEs to fix doc links; set readme field in package manifests * Re-generate READMEs to fix doc links; set readme field in package manifests * Re-generate READMEs to fix doc links; set readme field in package manifests * Revert stuff that shouldn't have been committed * Revert stuff that shouldn't have been committed * Fix parent relative link generation * Manually remove this incorrect link for now.
23 lines
833 B
Markdown
23 lines
833 B
Markdown
# Atomic Swap
|
|
|
|
A module for atomically sending funds.
|
|
|
|
- [`atomic_swap::Trait`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/trait.Trait.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 |