Struct FlamingoContract

pub struct FlamingoContract<'a, P: JsonRpcProvider> { /* private fields */ }

Flamingo Finance contract interface for Neo N3

Flamingo Finance is a DeFi platform on Neo N3 offering trading, earning, and borrowing services. This contract interface provides methods to interact with the Flamingo Finance smart contract.

Implementations

impl<'a, P: JsonRpcProvider + 'static> FlamingoContract<'a, P>

pub const CONTRACT_HASH: &'static str = "f970f4cddcd087ab5d8a5697a32b3cfd32c8b465"

The script hash of the Flamingo Finance contract on Neo N3 MainNet

pub const SWAP: &'static str = "swap"

Method name for swapping tokens

pub const ADD_LIQUIDITY: &'static str = "addLiquidity"

Method name for adding liquidity

pub const REMOVE_LIQUIDITY: &'static str = "removeLiquidity"

Method name for removing liquidity

pub const STAKE: &'static str = "stake"

Method name for staking tokens

pub const CLAIM_REWARDS: &'static str = "claimRewards"

Method name for claiming rewards

pub fn new(provider: Option<&'a RpcClient<P>>) -> Self

Creates a new FlamingoContract instance with the default contract hash

Arguments

• provider - An optional reference to an RPC client

Returns

A new FlamingoContract instance

pub fn with_script_hash( script_hash: ScriptHash, provider: Option<&'a RpcClient<P>>, ) -> Self

Creates a new FlamingoContract instance with a custom script hash

Arguments

• script_hash - The script hash of the Flamingo Finance contract
• provider - An optional reference to an RPC client

Returns

A new FlamingoContract instance

pub async fn swap( &self, from_token: &ScriptHash, to_token: &ScriptHash, amount: i64, min_return: i64, account: &Account, ) -> Result<TransactionBuilder<'_, P>, ContractError>

Swaps tokens on Flamingo Finance

Arguments

• from_token - The script hash of the token to swap from
• to_token - The script hash of the token to swap to
• amount - The amount of tokens to swap
• min_return - The minimum amount of tokens to receive
• account - The account that will sign the transaction

Returns

A transaction builder that can be used to build and sign the transaction

pub async fn add_liquidity( &self, token_a: &ScriptHash, token_b: &ScriptHash, amount_a: i64, amount_b: i64, account: &Account, ) -> Result<TransactionBuilder<'_, P>, ContractError>

Adds liquidity to a Flamingo Finance liquidity pool

Arguments

• token_a - The script hash of the first token
• token_b - The script hash of the second token
• amount_a - The amount of the first token to add
• amount_b - The amount of the second token to add
• account - The account that will sign the transaction

Returns

A transaction builder that can be used to build and sign the transaction

pub async fn remove_liquidity( &self, token_a: &ScriptHash, token_b: &ScriptHash, liquidity: i64, account: &Account, ) -> Result<TransactionBuilder<'_, P>, ContractError>

Removes liquidity from a Flamingo Finance liquidity pool

Arguments

• token_a - The script hash of the first token
• token_b - The script hash of the second token
• liquidity - The amount of liquidity tokens to remove
• account - The account that will sign the transaction

Returns

A transaction builder that can be used to build and sign the transaction

pub async fn stake( &self, token: &ScriptHash, amount: i64, account: &Account, ) -> Result<TransactionBuilder<'_, P>, ContractError>

Stakes tokens on Flamingo Finance

Arguments

• token - The script hash of the token to stake
• amount - The amount of tokens to stake
• account - The account that will sign the transaction

Returns

A transaction builder that can be used to build and sign the transaction

pub async fn claim_rewards( &self, account: &Account, ) -> Result<TransactionBuilder<'_, P>, ContractError>

Claims rewards from Flamingo Finance

Arguments

• account - The account that will sign the transaction

Returns

A transaction builder that can be used to build and sign the transaction

Trait Implementations

impl<'a, P: Clone + JsonRpcProvider> Clone for FlamingoContract<'a, P>

fn clone(&self) -> FlamingoContract<'a, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, P: Debug + JsonRpcProvider> Debug for FlamingoContract<'a, P>

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

Formats the value using the given formatter.

impl<'de, 'a, P> Deserialize<'de> for FlamingoContract<'a, P>

where P: Default + JsonRpcProvider,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, P: JsonRpcProvider> Serialize for FlamingoContract<'a, P>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, P: JsonRpcProvider> SmartContractTrait<'a> for FlamingoContract<'a, P>

type P = P

fn script_hash(&self) -> H160

fn set_script_hash(&mut self, script_hash: H160)

fn provider(&self) -> Option<&RpcClient<P>>

const DEFAULT_ITERATOR_COUNT: usize = 100usize

fn name<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = String> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn set_name(&mut self, _name: String)

fn invoke_function<'life0, 'life1, 'async_trait>( &'life0 self, function: &'life1 str, params: Vec<ContractParameter>, ) -> Pin<Box<dyn Future<Output = Result<TransactionBuilder<'_, Self::P>, ContractError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn build_invoke_function_script<'life0, 'life1, 'async_trait>( &'life0 self, function: &'life1 str, params: Vec<ContractParameter>, ) -> Pin<Box<dyn Future<Output = Result<Bytes, ContractError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn call_function_returning_string<'life0, 'life1, 'async_trait>( &'life0 self, function: &'life1 str, params: Vec<ContractParameter>, ) -> Pin<Box<dyn Future<Output = Result<String, ContractError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn call_function_returning_int<'life0, 'life1, 'async_trait>( &'life0 self, function: &'life1 str, params: Vec<ContractParameter>, ) -> Pin<Box<dyn Future<Output = Result<i32, ContractError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn call_function_returning_bool<'life0, 'life1, 'async_trait>( &'life0 self, function: &'life1 str, params: Vec<ContractParameter>, ) -> Pin<Box<dyn Future<Output = Result<bool, ContractError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn call_invoke_function<'life0, 'life1, 'async_trait>( &'life0 self, function: &'life1 str, params: Vec<ContractParameter>, signers: Vec<Signer>, ) -> Pin<Box<dyn Future<Output = Result<InvocationResult, ContractError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn throw_if_fault_state( &self, output: &InvocationResult, ) -> Result<(), ContractError>

fn call_function_returning_script_hash<'life0, 'life1, 'async_trait>( &'life0 self, function: &'life1 str, params: Vec<ContractParameter>, ) -> Pin<Box<dyn Future<Output = Result<H160, ContractError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn call_function_returning_iterator<'life0, 'life1, 'async_trait, U>( &'life0 self, function: &'life1 str, params: Vec<ContractParameter>, mapper: Arc<dyn Fn(StackItem) -> U + Send + Sync>, ) -> Pin<Box<dyn Future<Output = Result<NeoIterator<'_, U, Self::P>, ContractError>> + Send + 'async_trait>>

where U: Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn call_function_and_unwrap_iterator<'life0, 'life1, 'async_trait, U>( &'life0 self, function: &'life1 str, params: Vec<ContractParameter>, _max_items: usize, mapper: impl 'async_trait + Fn(StackItem) -> U + Send, ) -> Pin<Box<dyn Future<Output = Result<Vec<U>, ContractError>> + Send + 'async_trait>>

where U: 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn calc_native_contract_hash(contract_name: &str) -> Result<H160, ContractError>

fn calc_contract_hash( sender: H160, nef_checksum: u32, contract_name: &str, ) -> Result<H160, ContractError>

fn get_manifest<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ContractManifest> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,