From 7fdb711617f9900f45ab64504b2b8e92101800a6 Mon Sep 17 00:00:00 2001 From: Dan Forbes Date: Fri, 19 Jun 2020 06:02:03 -0700 Subject: [PATCH 1/2] Simple Docs for Atomic Swap Pallet --- frame/atomic-swap/src/lib.rs | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/frame/atomic-swap/src/lib.rs b/frame/atomic-swap/src/lib.rs index aa33c9a849fff..54ba31a09a50c 100644 --- a/frame/atomic-swap/src/lib.rs +++ b/frame/atomic-swap/src/lib.rs @@ -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) +//! - [`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)] From b2a3b0d5940d4dfd07462ad64089fab4bb884698 Mon Sep 17 00:00:00 2001 From: Dan Forbes Date: Fri, 19 Jun 2020 06:33:30 -0700 Subject: [PATCH 2/2] Fix copy-and-paste error --- frame/atomic-swap/src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frame/atomic-swap/src/lib.rs b/frame/atomic-swap/src/lib.rs index 54ba31a09a50c..8686138c2b4d7 100644 --- a/frame/atomic-swap/src/lib.rs +++ b/frame/atomic-swap/src/lib.rs @@ -19,7 +19,7 @@ //! //! A module for atomically sending funds. //! -//! - [`scheduler::Trait`](./trait.Trait.html) +//! - [`atomic_swap::Trait`](./trait.Trait.html) //! - [`Call`](./enum.Call.html) //! - [`Module`](./struct.Module.html) //!