Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Simple Docs for Atomic Swap Pallet #6434

Merged
merged 2 commits into from
Jun 19, 2020
Merged

Simple Docs for Atomic Swap Pallet #6434

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7fdb711
Simple Docs for Atomic Swap Pallet
danforbes Jun 19, 2020
b2a3b0d
Fix copy-and-paste error
danforbes Jun 19, 2020
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
22 changes: 21 additions & 1 deletion frame/atomic-swap/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,27 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! # Atomic swap support pallet
//! # Atomic Swap
//!
//! A module for atomically sending funds.
//!
//! - [`scheduler::Trait`](./trait.Trait.html)
shawntabrizi marked this conversation as resolved.
Show resolved Hide resolved
//! - [`Call`](./enum.Call.html)
//! - [`Module`](./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

// Ensure we're `no_std` when compiling for Wasm.
#![cfg_attr(not(feature = "std"), no_std)]
Expand Down