forked from paritytech/substrate
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pallet: Atomic Swap (paritytech#6349)
* Init atomic swap pallet * Implement module swap operations * Add successful swap test * Bump node spec_version * Fix storage name * Add ProofLimit parameter to prevent proof size being too large * Add missing events * Basic weight support * Add basic docs * Mark swap on claim This handles the additional case if `repatriate_reserved` fails. * Add additional expire handler * Update frame/atomic-swap/src/lib.rs Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> * Add docs on ProofLimit * Fix test * Return Ok(()) even when the transfer fails Because we need to mark the swap as claimed no matter what. * Remove retry logic It's overkill. Swap is about something being executed, not necessarily successful. Although there should be logic (reserve and unreserve) to make it so that both parties *believes* that the execution is successful. * succeed -> succeeded * Add docs on duration -- revealer should use duration shorter than counterparty * Missing trait type Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
- Loading branch information
1 parent
b02101e
commit bd72cb6
Showing
6 changed files
with
460 additions
and
2 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
[package] | ||
name = "pallet-atomic-swap" | ||
version = "2.0.0-rc3" | ||
authors = ["Parity Technologies <admin@parity.io>"] | ||
edition = "2018" | ||
license = "Apache-2.0" | ||
homepage = "https://substrate.dev" | ||
repository = "https://github.com/paritytech/substrate/" | ||
description = "FRAME atomic swap pallet" | ||
|
||
[package.metadata.docs.rs] | ||
targets = ["x86_64-unknown-linux-gnu"] | ||
|
||
[dependencies] | ||
serde = { version = "1.0.101", optional = true } | ||
codec = { package = "parity-scale-codec", version = "1.3.0", default-features = false } | ||
frame-support = { version = "2.0.0-rc3", default-features = false, path = "../support" } | ||
frame-system = { version = "2.0.0-rc3", default-features = false, path = "../system" } | ||
sp-runtime = { version = "2.0.0-rc3", default-features = false, path = "../../primitives/runtime" } | ||
sp-std = { version = "2.0.0-rc3", default-features = false, path = "../../primitives/std" } | ||
sp-io = { version = "2.0.0-rc3", default-features = false, path = "../../primitives/io" } | ||
sp-core = { version = "2.0.0-rc3", default-features = false, path = "../../primitives/core" } | ||
|
||
[dev-dependencies] | ||
pallet-balances = { version = "2.0.0-rc3", default-features = false, path = "../balances" } | ||
|
||
[features] | ||
default = ["std"] | ||
std = [ | ||
"serde", | ||
"codec/std", | ||
"frame-support/std", | ||
"frame-system/std", | ||
"sp-runtime/std", | ||
"sp-std/std", | ||
"sp-io/std", | ||
"sp-core/std", | ||
"pallet-balances/std", | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,248 @@ | ||
// This file is part of Substrate. | ||
|
||
// Copyright (C) 2017-2020 Parity Technologies (UK) Ltd. | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
//! # Atomic swap support pallet | ||
|
||
// Ensure we're `no_std` when compiling for Wasm. | ||
#![cfg_attr(not(feature = "std"), no_std)] | ||
|
||
mod tests; | ||
|
||
use sp_std::prelude::*; | ||
use sp_io::hashing::blake2_256; | ||
use frame_support::{ | ||
decl_module, decl_storage, decl_event, decl_error, ensure, | ||
traits::{Get, Currency, ReservableCurrency, BalanceStatus}, | ||
weights::Weight, | ||
dispatch::DispatchResult, | ||
}; | ||
use frame_system::{self as system, ensure_signed}; | ||
use codec::{Encode, Decode}; | ||
use sp_runtime::RuntimeDebug; | ||
|
||
/// Pending atomic swap operation. | ||
#[derive(Clone, RuntimeDebug, Eq, PartialEq, Encode, Decode)] | ||
pub struct PendingSwap<AccountId, Balance, BlockNumber> { | ||
/// Source of the swap. | ||
pub source: AccountId, | ||
/// Balance value of the swap. | ||
pub balance: Balance, | ||
/// End block of the lock. | ||
pub end_block: BlockNumber, | ||
} | ||
|
||
/// Balance type from the pallet's point of view. | ||
pub type BalanceFor<T> = <<T as Trait>::Currency as Currency<<T as frame_system::Trait>::AccountId>>::Balance; | ||
|
||
/// AccountId type from the pallet's point of view. | ||
pub type AccountIdFor<T> = <T as frame_system::Trait>::AccountId; | ||
|
||
/// BlockNumber type from the pallet's point of view. | ||
pub type BlockNumberFor<T> = <T as frame_system::Trait>::BlockNumber; | ||
|
||
/// PendingSwap type from the pallet's point of view. | ||
pub type PendingSwapFor<T> = PendingSwap<AccountIdFor<T>, BalanceFor<T>, BlockNumberFor<T>>; | ||
|
||
/// Hashed proof type. | ||
pub type HashedProof = [u8; 32]; | ||
|
||
/// Atomic swap's pallet configuration trait. | ||
pub trait Trait: frame_system::Trait { | ||
/// The overarching event type. | ||
type Event: From<Event<Self>> + Into<<Self as frame_system::Trait>::Event>; | ||
/// The currency mechanism. | ||
type Currency: ReservableCurrency<Self::AccountId>; | ||
/// Limit of proof size. | ||
/// | ||
/// Atomic swap is only atomic if once the proof is revealed, both parties can submit the proofs | ||
/// on-chain. If A is the one that generates the proof, then it requires that either: | ||
/// - A's blockchain has the same proof length limit as B's blockchain. | ||
/// - Or A's blockchain has shorter proof length limit as B's blockchain. | ||
/// | ||
/// If B sees A is on a blockchain with larger proof length limit, then it should kindly refuse | ||
/// to accept the atomic swap request if A generates the proof, and asks that B generates the | ||
/// proof instead. | ||
type ProofLimit: Get<u32>; | ||
} | ||
|
||
decl_storage! { | ||
trait Store for Module<T: Trait> as AtomicSwap { | ||
pub PendingSwaps: double_map | ||
hasher(twox_64_concat) T::AccountId, hasher(blake2_128_concat) HashedProof | ||
=> Option<PendingSwapFor<T>>; | ||
} | ||
} | ||
|
||
decl_error! { | ||
pub enum Error for Module<T: Trait> { | ||
/// Swap already exists. | ||
AlreadyExist, | ||
/// Swap proof is invalid. | ||
InvalidProof, | ||
/// Proof is too large. | ||
ProofTooLarge, | ||
/// Source does not match. | ||
SourceMismatch, | ||
/// Swap has already been claimed. | ||
AlreadyClaimed, | ||
/// Swap does not exist. | ||
NotExist, | ||
/// Duration has not yet passed for the swap to be cancelled. | ||
DurationNotPassed, | ||
} | ||
} | ||
|
||
decl_event!( | ||
/// Event of atomic swap pallet. | ||
pub enum Event<T> where | ||
Balance = BalanceFor<T>, | ||
AccountId = AccountIdFor<T>, | ||
PendingSwap = PendingSwapFor<T>, | ||
{ | ||
/// Swap created. | ||
NewSwap(AccountId, HashedProof, PendingSwap), | ||
/// Swap claimed. The last parameter indicates whether the execution succeeds. | ||
SwapClaimed(AccountId, HashedProof, Balance, bool), | ||
/// Swap cancelled. | ||
SwapCancelled(AccountId, HashedProof), | ||
} | ||
); | ||
|
||
decl_module! { | ||
/// Module definition of atomic swap pallet. | ||
pub struct Module<T: Trait> for enum Call where origin: T::Origin { | ||
type Error = Error<T>; | ||
|
||
fn deposit_event() = default; | ||
|
||
/// Register a new atomic swap, declaring an intention to send funds from origin to target | ||
/// on the current blockchain. The target can claim the fund using the revealed proof. If | ||
/// the fund is not claimed after `duration` blocks, then the sender can cancel the swap. | ||
/// | ||
/// The dispatch origin for this call must be _Signed_. | ||
/// | ||
/// - `target`: Receiver of the atomic swap. | ||
/// - `hashed_proof`: The blake2_256 hash of the secret proof. | ||
/// - `balance`: Funds to be sent from origin. | ||
/// - `duration`: Locked duration of the atomic swap. For safety reasons, it is recommended | ||
/// that the revealer uses a shorter duration than the counterparty, to prevent the | ||
/// situation where the revealer reveals the proof too late around the end block. | ||
#[weight = T::DbWeight::get().reads_writes(1, 1).saturating_add(40_000_000)] | ||
fn create_swap( | ||
origin, | ||
target: AccountIdFor<T>, | ||
hashed_proof: HashedProof, | ||
balance: BalanceFor<T>, | ||
duration: BlockNumberFor<T>, | ||
) { | ||
let source = ensure_signed(origin)?; | ||
ensure!( | ||
!PendingSwaps::<T>::contains_key(&target, hashed_proof), | ||
Error::<T>::AlreadyExist | ||
); | ||
|
||
T::Currency::reserve(&source, balance)?; | ||
|
||
let swap = PendingSwap { | ||
source, | ||
balance, | ||
end_block: frame_system::Module::<T>::block_number() + duration, | ||
}; | ||
PendingSwaps::<T>::insert(target.clone(), hashed_proof.clone(), swap.clone()); | ||
|
||
Self::deposit_event( | ||
RawEvent::NewSwap(target, hashed_proof, swap) | ||
); | ||
} | ||
|
||
/// Claim an atomic swap. | ||
/// | ||
/// The dispatch origin for this call must be _Signed_. | ||
/// | ||
/// - `proof`: Revealed proof of the claim. | ||
#[weight = T::DbWeight::get().reads_writes(2, 2) | ||
.saturating_add(40_000_000) | ||
.saturating_add((proof.len() as Weight).saturating_mul(100)) | ||
] | ||
fn claim_swap( | ||
origin, | ||
proof: Vec<u8>, | ||
) -> DispatchResult { | ||
ensure!( | ||
proof.len() <= T::ProofLimit::get() as usize, | ||
Error::<T>::ProofTooLarge, | ||
); | ||
|
||
let target = ensure_signed(origin)?; | ||
let hashed_proof = blake2_256(&proof); | ||
|
||
let swap = PendingSwaps::<T>::get(&target, hashed_proof) | ||
.ok_or(Error::<T>::InvalidProof)?; | ||
|
||
let succeeded = T::Currency::repatriate_reserved( | ||
&swap.source, | ||
&target, | ||
swap.balance, | ||
BalanceStatus::Free, | ||
).is_ok(); | ||
|
||
PendingSwaps::<T>::remove(target.clone(), hashed_proof.clone()); | ||
|
||
Self::deposit_event( | ||
RawEvent::SwapClaimed(target, hashed_proof, swap.balance, succeeded) | ||
); | ||
|
||
Ok(()) | ||
} | ||
|
||
/// Cancel an atomic swap. Only possible after the originally set duration has passed. | ||
/// | ||
/// The dispatch origin for this call must be _Signed_. | ||
/// | ||
/// - `target`: Target of the original atomic swap. | ||
/// - `hashed_proof`: Hashed proof of the original atomic swap. | ||
#[weight = T::DbWeight::get().reads_writes(1, 1).saturating_add(40_000_000)] | ||
fn cancel_swap( | ||
origin, | ||
target: AccountIdFor<T>, | ||
hashed_proof: HashedProof, | ||
) { | ||
let source = ensure_signed(origin)?; | ||
|
||
let swap = PendingSwaps::<T>::get(&target, hashed_proof) | ||
.ok_or(Error::<T>::NotExist)?; | ||
ensure!( | ||
swap.source == source, | ||
Error::<T>::SourceMismatch, | ||
); | ||
ensure!( | ||
frame_system::Module::<T>::block_number() >= swap.end_block, | ||
Error::<T>::DurationNotPassed, | ||
); | ||
|
||
T::Currency::unreserve( | ||
&swap.source, | ||
swap.balance, | ||
); | ||
PendingSwaps::<T>::remove(&target, hashed_proof.clone()); | ||
|
||
Self::deposit_event( | ||
RawEvent::SwapCancelled(target, hashed_proof) | ||
); | ||
} | ||
} | ||
} |
Oops, something went wrong.