Struct pallet_atomic_swap::pallet::Pallet

source ·

pub struct Pallet<T>(_);

Expand description

The pallet implementing the on-chain logic.

Implementations

source

impl<T: Config> Pallet<T>

source

pub fn create_swap(
 origin: OriginFor<T>,
 target: T::AccountId,
 hashed_proof: HashedProof,
 action: T::SwapAction,
 duration: T::BlockNumber
) -> DispatchResult

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.

source

pub fn claim_swap(
 origin: OriginFor<T>,
 proof: Vec<u8>,
 action: T::SwapAction
) -> DispatchResult

Claim an atomic swap.

The dispatch origin for this call must be Signed.

proof: Revealed proof of the claim.
action: Action defined in the swap, it must match the entry in blockchain. Otherwise the operation fails. This is used for weight calculation.

source

pub fn cancel_swap(
 origin: OriginFor<T>,
 target: T::AccountId,
 hashed_proof: HashedProof
) -> DispatchResult

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.

Trait Implementations

source

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

source

impl<T> Clone for Pallet<T>

source

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<T> Debug for Pallet<T>

source

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl<T: Config> GetStorageVersion for Pallet<T>

source

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

source

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

source

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

source

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

source

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists. Read more

source

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen. Read more

source

fn on_runtime_upgrade() -> Weight

Perform a module upgrade. Read more

source

fn try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block. Read more

source

fn pre_upgrade() -> Result<Vec<u8, Global>, &'static str>

Execute some pre-checks prior to a runtime upgrade. Read more

source

fn post_upgrade(_state: Vec<u8, Global>) -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade. Read more

source

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain. Read more

source

fn integrity_test()

Run integrity test. Read more

source

impl<T: Config> IntegrityTest for Pallet<T>

source

fn integrity_test()

Run integrity test. Read more

source

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

source

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced). Read more

source

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

source

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen. Read more

source

impl<T: Config> OnGenesis for Pallet<T>

source

fn on_genesis()

Something that should happen at genesis.

source

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

source

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation. Read more

source

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

source

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen. Read more

source

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

source

fn on_runtime_upgrade() -> Weight

Perform a module upgrade. Read more

source

fn pre_upgrade() -> Result<Vec<u8>, &'static str>

Execute some pre-checks prior to a runtime upgrade. Read more

source

fn post_upgrade(state: Vec<u8>) -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade. Read more

source

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, &'static str>

Same as on_runtime_upgrade, but perform the optional pre_upgrade and post_upgrade as well. Read more

source

impl<T: Config> PalletInfoAccess for Pallet<T>

source

fn index() -> usize

Index of the pallet as configured in the runtime.

source

fn name() -> &'static str

Name of the pallet as configured in the runtime.

source

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

source

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

source

impl<T: Config> PalletsInfoAccess for Pallet<T>

source

fn count() -> usize

The number of pallets’ information that this type represents. Read more

source

fn infos() -> Vec<PalletInfoData> ⓘ

All of the pallets’ information that this type represents.

source

impl<T> PartialEq<Pallet<T>> for Pallet<T>

source

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

fn try_state(
n: <T as Config>::BlockNumber,
_s: TryStateSelect
) -> Result<(), &'static str>

Execute the state checks.

source

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

source

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey> ⓘ

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation. Read more

source

impl<T> Eq for Pallet<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Pallet<T>where
T: RefUnwindSafe,

impl<T> Send for Pallet<T>where
T: Send,

impl<T> Sync for Pallet<T>where
T: Sync,

impl<T> Unpin for Pallet<T>where
T: Unpin,

impl<T> UnwindSafe for Pallet<T>where
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> CheckedConversion for T

source

fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

source

fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> Downcast for Twhere
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source