pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-11 14:11:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Simple Docs for Atomic Swap Pallet (#6434)

Browse Source 
* Simple Docs for Atomic Swap Pallet

* Fix copy-and-paste error
This commit is contained in:
Dan Forbes
2020-06-19 06:55:15 -07:00
committed by GitHub
parent 40e4868424
commit bce6a426f1
1 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/frame/atomic-swap/src/lib.rs
+21 -1
View File
@@ -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.
//!
//! - [`atomic_swap::Trait`](./trait.Trait.html)
//! - [`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)]