stellar-axelar-example 1.0.9

AxelarExample contract, responsible for demonstrating interchain message and token transfers with Gateway, GasService, and InterchainTokenService.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

use stellar_axelar_gateway::executable::AxelarExecutableInterface;
use stellar_axelar_std::types::Token;
use stellar_axelar_std::{Address, Bytes, BytesN, Env, String};

use crate::contract::AxelarExampleError;

pub trait AxelarExampleInterface: AxelarExecutableInterface {
    /// Retrieves the address of the gas service.
    fn gas_service(env: &Env) -> Address;

    /// Sends a message to a specified destination chain.
    ///
    /// The function also handles the payment of gas for the cross-chain transaction.
    ///
    /// # Arguments
    /// * `caller` - The address of the caller initiating the message.
    /// * `destination_chain` - The name of the destination chain where the message will be sent.
    /// * `destination_address` - The address on the destination chain where the message will be sent.
    /// * `message` - The message to be sent.
    /// * `gas_token` - An optional gas token used to pay for gas during the transaction.
    ///
    /// # Authorization
    /// - The `caller` must authorize.
    fn send(
        env: &Env,
        caller: Address,
        destination_chain: String,
        destination_address: String,
        message: Bytes,
        gas_token: Option<Token>,
    );

    /// Sends a token to a specified destination chain.
    ///
    /// The function also emits an event upon successful transfer.
    ///
    /// # Arguments
    /// * `caller` - The address of the caller initiating the token transfer.
    /// * `token_id` - The ID of the token to be transferred.
    /// * `destination_chain` - The name of the destination chain where the token will be sent.
    /// * `destination_app_contract` - The address of the application contract on the destination chain.
    /// * `amount` - The amount of the token to be transferred.
    /// * `recipient` - An optional recipient address on the destination chain.
    /// * `gas_token` - An optional gas token used to pay for gas during the transaction.
    ///
    /// # Authorization
    /// - The `caller` must authorize.
    fn send_token(
        env: &Env,
        caller: Address,
        token_id: BytesN<32>,
        destination_chain: String,
        destination_app_contract: Bytes,
        amount: i128,
        recipient: Option<Bytes>,
        gas_token: Option<Token>,
    ) -> Result<(), AxelarExampleError>;
}