Skip to content

Commit

Permalink
Merge pull request #1406 from Phala-Network/doc
Browse files Browse the repository at this point in the history
doc: add transfer_to_cluster docstring
  • Loading branch information
h4x3rotab authored Oct 11, 2023
2 parents 2b6734c + 74334d1 commit a7f8efe
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion pallets/phala/src/phat.rs
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,18 @@ pub mod pallet {
Ok(())
}

/// Transfer `amount` of on-chain token to the `dest_account` in the cluster of id `cluster_id`.
/// Transfers some native token to an account in a Phat Contract cluster.
///
/// The token will be deducted from the sender's account, and transfer to the specified
/// account in the cluster, for token usage (gas, storage deposit, etc) inside the cluster.
/// Please note that currently it's only supported to transfer token from the blockchain
/// into the cluster, not the reverse.
///
/// # Arguments
///
/// * `amount` - The amount of the native token to transfer.
/// * `cluster_id` - The cluster id to transfer into.
/// * `dest_account` - The account in the cluster to receive the token.
#[pallet::call_index(2)]
#[pallet::weight({0})]
pub fn transfer_to_cluster(
Expand Down

0 comments on commit a7f8efe

Please sign in to comment.