Skip to main content

multiliquid_svm_sdk/
lib.rs

1// The README ends with docs.rs link definitions for crates.io and GitHub. Markdown uses the first definition of a
2// label, so these intra-doc definitions take precedence in rustdoc and keep navigation within the built version.
3#![doc = "[api]: crate"]
4#![doc = "[http-quote]: crate::guides::mainnet#http-quote-example"]
5#![doc = "[client-configuration]: crate::guides::integration#client-configuration"]
6#![doc = "[integration]: crate::guides::integration"]
7#![doc = "[mainnet]: crate::guides::mainnet"]
8#![doc = "[offline-quote]: crate::guides::offline_quote"]
9#![doc = "[development]: crate::guides::development"]
10#![doc = "[`MultiliquidClient`]: crate::MultiliquidClient"]
11#![doc = "[`MultiliquidClientConfig`]: crate::MultiliquidClientConfig"]
12#![doc = "[`SwapParams`]: crate::SwapParams"]
13#![doc = "[`LpLiquidityParams`]: crate::LpLiquidityParams"]
14#![doc = "[`FundLpFeeVaultParams`]: crate::FundLpFeeVaultParams"]
15#![doc = "[lp-fee-vaults]: crate::guides::integration#lp-fee-vaults"]
16#![doc = "[`PairFilters`]: crate::PairFilters"]
17#![doc = "[`CapitalProviderFetchOptions`]: crate::CapitalProviderFetchOptions"]
18#![doc = "[capital-providers]: crate::guides::integration#capital-providers"]
19#![doc = "[`Rpc`]: crate::Rpc"]
20#![cfg_attr(feature = "http", doc = "[`HttpRpcClient`]: crate::HttpRpcClient")]
21#![doc = "[`swap_program_client`]: crate::swap_program_client"]
22#![doc = "[`treasury_program_client`]: crate::treasury_program_client"]
23#![doc = "[`generated::treasury`]: crate::generated::treasury"]
24#![doc = "[`SWAP_IDL`]: crate::SWAP_IDL"]
25#![doc = "[`TREASURY_IDL`]: crate::TREASURY_IDL"]
26#![doc = ""]
27#![doc = include_str!("../README.md")]
28
29pub mod accounts;
30pub mod client;
31pub mod constants;
32pub mod error;
33pub mod errors;
34pub mod events;
35pub mod format;
36pub mod generated;
37#[cfg(doc)]
38pub mod guides;
39pub mod liquidity;
40pub mod lp;
41pub mod math;
42pub mod oracle;
43pub mod pda;
44pub mod quote;
45pub mod quote_core;
46pub mod registry;
47pub mod rpc;
48pub mod swap;
49pub mod token;
50pub mod transaction;
51pub mod treasury;
52pub mod treasury_planner;
53pub mod treasury_program_client;
54pub mod types;
55pub mod validation;
56
57pub use accounts::{
58    check_pause_status, decode_asset_config, decode_global_config, decode_lp_protocol_fee_config,
59    decode_lp_stable_config, decode_pair, decode_user_vault_info_used, fetch_asset_config,
60    fetch_global_config, fetch_global_config_and_pair, fetch_lp_protocol_fee_config,
61    fetch_lp_stable_config, fetch_pair, fetch_swap_state, fetch_user_vault_info_used,
62    resolve_swap_pair,
63};
64pub use client::{MultiliquidClient, MultiliquidClientConfig};
65pub use constants::*;
66pub use error::{Result, SdkError};
67pub use errors::{
68    create_no_liquidity_error, create_no_user_funds_error, parse_simulation_program_error,
69    parse_simulation_program_error_from_logs, parse_swap_error, parse_synthetic_simulation_error,
70    parse_treasury_error, swap_error_category, ParsedProgramError, ParsedSimulationProgramError,
71    ProgramErrorMetadata, SwapErrorMetadata, SWAP_ERROR_MAP, TREASURY_ERROR_MAP,
72};
73pub use events::{
74    decode_swap_executed_event, parse_swap_events_from_logs, parse_swap_events_from_transaction,
75};
76pub use format::{to_human_readable, to_human_readable_signed, to_native_amount};
77/// Generated swap instructions, account codecs, events, and error metadata.
78pub use generated::swap as swap_program_client;
79/// Bundled npm swap IDL as an embedded JSON string, not a parsed JSON object.
80pub use generated::swap::IDL as SWAP_IDL;
81/// Bundled npm treasury IDL as an embedded JSON string, not a parsed JSON object.
82pub use generated::treasury::IDL as TREASURY_IDL;
83pub use lp::{
84    build_add_liquidity_instruction, build_add_liquidity_transaction, build_close_pair_instruction,
85    build_close_pair_transaction, build_fund_lp_fee_vault_instruction,
86    build_fund_lp_fee_vault_transaction, build_init_pair_instruction, build_init_pair_transaction,
87    build_remove_liquidity_instruction, build_remove_liquidity_transaction,
88    build_update_pair_instruction, build_update_pair_transaction,
89};
90pub use math::{
91    bps_to_fixed_point, calculate_protocol_fee_amount, calculate_spread_protocol_fee_rate,
92    calculate_swap_results, ceil_div, SWAP_FIXED_POINT_SCALE, SWAP_ONE_BPS_FIXED_POINT,
93};
94pub use oracle::{
95    calculate_nav, read_i32_le, read_i64_le, read_u64_le, resolve_oracle_accounts,
96    resolve_pyth_oracle_accounts,
97};
98pub use pda::{
99    canonicalize_pair_mints, derive_asset_config, derive_associated_token_account,
100    derive_fee_vault, derive_global_config, derive_lp_fee_vault, derive_lp_fee_vault_authority,
101    derive_lp_protocol_fee_config, derive_lp_stable_config, derive_pair, derive_program_authority,
102    derive_program_data, derive_treasury_apy_entry, derive_treasury_asset_config,
103    derive_treasury_global_config, derive_treasury_user_position, derive_treasury_vault,
104    derive_treasury_vault_authority, derive_user_vault_info, derive_vault, derive_vault_authority,
105};
106pub use quote::{get_quote, get_quote_via_simulation};
107pub use quote_core::{
108    compute_swap_quote, compute_swap_quote_from_resolved_inputs, fetch_cluster_unix_timestamp,
109    fetch_oracle_account_data_map, quote_requires_cluster_timestamp, SwapQuoteResolvedInputs,
110    CLUSTER_TIMESTAMP_LOOKBACK_SLOTS,
111};
112pub use registry::{
113    discover_pairs, get_mainnet_rwa_transfer_hook, get_offline_pairs, DEFAULT_REGISTRY_API_URL,
114    DEFAULT_REGISTRY_FETCH_TIMEOUT_MS, DEVNET_PAIRS, MAINNET_PAIRS, MAINNET_RWA_TRANSFER_HOOKS,
115    PAIR_REGISTRY,
116};
117#[cfg(feature = "http")]
118pub use registry::{get_capital_providers, get_pairs};
119#[cfg(feature = "http")]
120pub use rpc::HttpRpcClient;
121pub use rpc::{Rpc, RpcFilter, SimulationResult};
122pub use solana_account::Account;
123/// A Solana account address.
124///
125/// `Pubkey` is a type alias of [`solana_address::Address`], the type behind `solana_pubkey::Pubkey` 4.x, so values
126/// pass between this crate and code using either name without conversion.
127pub type Pubkey = solana_address::Address;
128pub use solana_commitment_config::{CommitmentConfig, CommitmentLevel};
129pub use solana_hash::Hash;
130pub use solana_instruction::{AccountMeta, Instruction};
131pub use solana_message::VersionedMessage;
132pub use solana_signature::Signature;
133pub use solana_transaction::versioned::VersionedTransaction;
134pub use swap::{build_swap_instruction, build_swap_transaction};
135pub use token::{
136    create_associated_token_account_idempotent_instruction, create_transfer_checked_instruction,
137    detect_token_program, detect_token_program_from_account_info, ensure_ata_instructions,
138    fetch_mint_account_contexts, merge_account_metas, parse_mint_account_context,
139    read_mint_decimals, read_token_account_amount, resolve_transfer_hook_accounts,
140    resolve_transfer_hook_accounts_for_program, MintAccountContext, TransferHookTransfer,
141};
142pub use transaction::build_unsigned_transaction;
143pub use treasury::{
144    decode_treasury_user_position_account, decode_treasury_user_position_with_pending_deposits,
145    encode_treasury_user_position_with_pending_deposits,
146    fetch_all_maybe_treasury_user_position_accounts, fetch_all_treasury_user_position_accounts,
147    fetch_maybe_treasury_user_position_account, fetch_treasury_user_position_account,
148    fetch_treasury_user_position_with_pending_deposits, TreasuryUserPositionWithPendingDeposits,
149};
150pub use treasury_planner::{
151    resolve_treasury_liquidity_plan, resolve_treasury_swap_plan, ResolveTreasuryLiquidityPlanInput,
152    ResolveTreasurySwapPlanInput, TreasuryLiquidityPlan, TreasuryLiquidityPlanAccounts,
153    TreasuryOperation, TreasurySwapPlan, TreasurySwapPlanAccounts,
154};
155pub use types::*;
156pub use validation::{assert_bps, assert_positive_amount, assert_u16, assert_u64_amount};