2019-04-11 00:25:14 -07:00
|
|
|
//! Defines traits for blocking (synchronous) and non-blocking (asynchronous)
|
|
|
|
//! communication with a Solana server as well a a trait that encompasses both.
|
|
|
|
//!
|
|
|
|
//! //! Synchronous implementations are expected to create transactions, sign them, and send
|
|
|
|
//! them with multiple retries, updating blockhashes and resigning as-needed.
|
|
|
|
//!
|
|
|
|
//! Asynchronous implementations are expected to create transactions, sign them, and send
|
|
|
|
//! them but without waiting to see if the server accepted it.
|
|
|
|
|
2020-10-24 08:39:28 -07:00
|
|
|
#![cfg(feature = "full")]
|
2020-10-19 13:19:24 -07:00
|
|
|
|
2019-11-02 00:38:30 -07:00
|
|
|
use crate::{
|
|
|
|
account::Account,
|
|
|
|
clock::Slot,
|
2019-11-06 13:15:00 -08:00
|
|
|
commitment_config::CommitmentConfig,
|
2020-05-20 16:42:46 -07:00
|
|
|
epoch_info::EpochInfo,
|
2020-02-28 12:27:01 -08:00
|
|
|
fee_calculator::{FeeCalculator, FeeRateGovernor},
|
2019-11-02 00:38:30 -07:00
|
|
|
hash::Hash,
|
|
|
|
instruction::Instruction,
|
|
|
|
message::Message,
|
|
|
|
pubkey::Pubkey,
|
|
|
|
signature::{Keypair, Signature},
|
2020-02-20 12:13:23 -08:00
|
|
|
signers::Signers,
|
2019-11-02 00:38:30 -07:00
|
|
|
transaction,
|
|
|
|
transport::Result,
|
|
|
|
};
|
2019-04-11 00:25:14 -07:00
|
|
|
|
2019-04-19 14:04:36 -07:00
|
|
|
pub trait Client: SyncClient + AsyncClient {
|
2019-09-06 09:07:40 -07:00
|
|
|
fn tpu_addr(&self) -> String;
|
2019-04-19 14:04:36 -07:00
|
|
|
}
|
2019-04-11 00:25:14 -07:00
|
|
|
|
|
|
|
pub trait SyncClient {
|
|
|
|
/// Create a transaction from the given message, and send it to the
|
|
|
|
/// server, retrying as-needed.
|
2020-06-24 20:35:38 -07:00
|
|
|
fn send_and_confirm_message<T: Signers>(
|
|
|
|
&self,
|
|
|
|
keypairs: &T,
|
|
|
|
message: Message,
|
|
|
|
) -> Result<Signature>;
|
2019-04-11 00:25:14 -07:00
|
|
|
|
|
|
|
/// Create a transaction from a single instruction that only requires
|
|
|
|
/// a single signer. Then send it to the server, retrying as-needed.
|
2020-06-24 20:35:38 -07:00
|
|
|
fn send_and_confirm_instruction(
|
|
|
|
&self,
|
|
|
|
keypair: &Keypair,
|
|
|
|
instruction: Instruction,
|
|
|
|
) -> Result<Signature>;
|
2019-04-11 00:25:14 -07:00
|
|
|
|
|
|
|
/// Transfer lamports from `keypair` to `pubkey`, retrying until the
|
|
|
|
/// transfer completes or produces and error.
|
2020-06-24 20:35:38 -07:00
|
|
|
fn transfer_and_confirm(
|
|
|
|
&self,
|
|
|
|
lamports: u64,
|
|
|
|
keypair: &Keypair,
|
|
|
|
pubkey: &Pubkey,
|
|
|
|
) -> Result<Signature>;
|
2019-04-11 00:25:14 -07:00
|
|
|
|
|
|
|
/// Get an account or None if not found.
|
|
|
|
fn get_account_data(&self, pubkey: &Pubkey) -> Result<Option<Vec<u8>>>;
|
|
|
|
|
2019-06-13 22:30:51 -07:00
|
|
|
/// Get an account or None if not found.
|
|
|
|
fn get_account(&self, pubkey: &Pubkey) -> Result<Option<Account>>;
|
|
|
|
|
2019-11-06 13:15:00 -08:00
|
|
|
/// Get an account or None if not found. Uses explicit commitment configuration.
|
|
|
|
fn get_account_with_commitment(
|
|
|
|
&self,
|
|
|
|
pubkey: &Pubkey,
|
|
|
|
commitment_config: CommitmentConfig,
|
|
|
|
) -> Result<Option<Account>>;
|
|
|
|
|
2019-04-11 00:25:14 -07:00
|
|
|
/// Get account balance or 0 if not found.
|
|
|
|
fn get_balance(&self, pubkey: &Pubkey) -> Result<u64>;
|
|
|
|
|
2019-11-06 13:15:00 -08:00
|
|
|
/// Get account balance or 0 if not found. Uses explicit commitment configuration.
|
|
|
|
fn get_balance_with_commitment(
|
|
|
|
&self,
|
|
|
|
pubkey: &Pubkey,
|
|
|
|
commitment_config: CommitmentConfig,
|
|
|
|
) -> Result<u64>;
|
|
|
|
|
2020-12-10 16:39:28 -08:00
|
|
|
fn get_minimum_balance_for_rent_exemption(&self, data_len: usize) -> Result<u64>;
|
|
|
|
|
2019-06-12 16:43:05 -07:00
|
|
|
/// Get recent blockhash
|
2021-10-26 09:06:41 -07:00
|
|
|
#[deprecated(since = "1.9.0", note = "Please use `get_latest_blockhash` instead")]
|
2019-06-12 16:43:05 -07:00
|
|
|
fn get_recent_blockhash(&self) -> Result<(Hash, FeeCalculator)>;
|
|
|
|
|
2019-11-06 13:15:00 -08:00
|
|
|
/// Get recent blockhash. Uses explicit commitment configuration.
|
2021-08-13 09:08:20 -07:00
|
|
|
#[deprecated(
|
2021-10-26 09:06:41 -07:00
|
|
|
since = "1.9.0",
|
2021-08-13 09:08:20 -07:00
|
|
|
note = "Please use `get_latest_blockhash_with_commitment` and `get_fee_for_message` instead"
|
|
|
|
)]
|
2019-11-06 13:15:00 -08:00
|
|
|
fn get_recent_blockhash_with_commitment(
|
|
|
|
&self,
|
|
|
|
commitment_config: CommitmentConfig,
|
2020-06-09 17:07:32 -07:00
|
|
|
) -> Result<(Hash, FeeCalculator, Slot)>;
|
2019-11-06 13:15:00 -08:00
|
|
|
|
2020-03-06 16:01:31 -08:00
|
|
|
/// Get `Some(FeeCalculator)` associated with `blockhash` if it is still in
|
|
|
|
/// the BlockhashQueue`, otherwise `None`
|
2021-08-13 09:08:20 -07:00
|
|
|
#[deprecated(
|
2021-10-26 09:06:41 -07:00
|
|
|
since = "1.9.0",
|
2021-08-13 09:08:20 -07:00
|
|
|
note = "Please use `get_fee_for_message` or `is_blockhash_valid` instead"
|
|
|
|
)]
|
2020-03-06 16:01:31 -08:00
|
|
|
fn get_fee_calculator_for_blockhash(&self, blockhash: &Hash) -> Result<Option<FeeCalculator>>;
|
|
|
|
|
2020-02-28 12:27:01 -08:00
|
|
|
/// Get recent fee rate governor
|
2021-08-13 09:08:20 -07:00
|
|
|
#[deprecated(
|
2021-10-26 09:06:41 -07:00
|
|
|
since = "1.9.0",
|
2021-08-13 09:08:20 -07:00
|
|
|
note = "Please do not use, will no longer be available in the future"
|
|
|
|
)]
|
2020-02-28 12:27:01 -08:00
|
|
|
fn get_fee_rate_governor(&self) -> Result<FeeRateGovernor>;
|
|
|
|
|
2019-04-11 00:25:14 -07:00
|
|
|
/// Get signature status.
|
|
|
|
fn get_signature_status(
|
|
|
|
&self,
|
|
|
|
signature: &Signature,
|
|
|
|
) -> Result<Option<transaction::Result<()>>>;
|
|
|
|
|
2019-11-06 13:15:00 -08:00
|
|
|
/// Get signature status. Uses explicit commitment configuration.
|
|
|
|
fn get_signature_status_with_commitment(
|
|
|
|
&self,
|
|
|
|
signature: &Signature,
|
|
|
|
commitment_config: CommitmentConfig,
|
|
|
|
) -> Result<Option<transaction::Result<()>>>;
|
|
|
|
|
2019-06-12 16:43:05 -07:00
|
|
|
/// Get last known slot
|
2019-11-02 00:38:30 -07:00
|
|
|
fn get_slot(&self) -> Result<Slot>;
|
2019-04-11 00:25:14 -07:00
|
|
|
|
2019-11-06 13:15:00 -08:00
|
|
|
/// Get last known slot. Uses explicit commitment configuration.
|
|
|
|
fn get_slot_with_commitment(&self, commitment_config: CommitmentConfig) -> Result<u64>;
|
|
|
|
|
2019-04-11 00:25:14 -07:00
|
|
|
/// Get transaction count
|
|
|
|
fn get_transaction_count(&self) -> Result<u64>;
|
2019-04-25 12:46:40 -07:00
|
|
|
|
2019-11-06 13:15:00 -08:00
|
|
|
/// Get transaction count. Uses explicit commitment configuration.
|
|
|
|
fn get_transaction_count_with_commitment(
|
|
|
|
&self,
|
|
|
|
commitment_config: CommitmentConfig,
|
|
|
|
) -> Result<u64>;
|
|
|
|
|
2020-05-20 16:42:46 -07:00
|
|
|
fn get_epoch_info(&self) -> Result<EpochInfo>;
|
|
|
|
|
2019-04-25 12:46:40 -07:00
|
|
|
/// Poll until the signature has been confirmed by at least `min_confirmed_blocks`
|
|
|
|
fn poll_for_signature_confirmation(
|
|
|
|
&self,
|
|
|
|
signature: &Signature,
|
|
|
|
min_confirmed_blocks: usize,
|
2019-07-02 20:56:10 -07:00
|
|
|
) -> Result<usize>;
|
2019-04-25 12:46:40 -07:00
|
|
|
|
|
|
|
/// Poll to confirm a transaction.
|
|
|
|
fn poll_for_signature(&self, signature: &Signature) -> Result<()>;
|
2019-04-27 08:39:29 -07:00
|
|
|
|
2021-08-13 09:08:20 -07:00
|
|
|
#[deprecated(
|
2021-10-26 09:06:41 -07:00
|
|
|
since = "1.9.0",
|
2021-08-13 09:08:20 -07:00
|
|
|
note = "Please use `get_new_latest_blockhash` instead"
|
|
|
|
)]
|
2019-05-13 12:49:37 -07:00
|
|
|
fn get_new_blockhash(&self, blockhash: &Hash) -> Result<(Hash, FeeCalculator)>;
|
2021-08-13 09:08:20 -07:00
|
|
|
|
|
|
|
/// Get last known blockhash
|
|
|
|
fn get_latest_blockhash(&self) -> Result<Hash>;
|
|
|
|
|
|
|
|
/// Get recent blockhash. Uses explicit commitment configuration.
|
|
|
|
fn get_latest_blockhash_with_commitment(
|
|
|
|
&self,
|
|
|
|
commitment_config: CommitmentConfig,
|
|
|
|
) -> Result<(Hash, u64)>;
|
|
|
|
|
|
|
|
/// Check if the blockhash is valid
|
|
|
|
fn is_blockhash_valid(&self, blockhash: &Hash, commitment: CommitmentConfig) -> Result<bool>;
|
|
|
|
|
|
|
|
/// Calculate the fee for a `Message`
|
2021-10-13 13:10:58 -07:00
|
|
|
fn get_fee_for_message(&self, message: &Message) -> Result<u64>;
|
2021-08-13 09:08:20 -07:00
|
|
|
|
|
|
|
/// Get a new blockhash after the one specified
|
|
|
|
fn get_new_latest_blockhash(&self, blockhash: &Hash) -> Result<Hash>;
|
2019-04-11 00:25:14 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
pub trait AsyncClient {
|
|
|
|
/// Send a signed transaction, but don't wait to see if the server accepted it.
|
2020-03-12 23:20:49 -07:00
|
|
|
fn async_send_transaction(&self, transaction: transaction::Transaction) -> Result<Signature>;
|
2019-04-11 00:25:14 -07:00
|
|
|
|
|
|
|
/// Create a transaction from the given message, and send it to the
|
|
|
|
/// server, but don't wait for to see if the server accepted it.
|
2020-02-20 12:13:23 -08:00
|
|
|
fn async_send_message<T: Signers>(
|
2019-04-11 00:25:14 -07:00
|
|
|
&self,
|
2020-02-20 12:13:23 -08:00
|
|
|
keypairs: &T,
|
2019-04-11 00:25:14 -07:00
|
|
|
message: Message,
|
|
|
|
recent_blockhash: Hash,
|
2020-03-12 23:20:49 -07:00
|
|
|
) -> Result<Signature>;
|
2019-04-11 00:25:14 -07:00
|
|
|
|
|
|
|
/// Create a transaction from a single instruction that only requires
|
|
|
|
/// a single signer. Then send it to the server, but don't wait for a reply.
|
|
|
|
fn async_send_instruction(
|
|
|
|
&self,
|
|
|
|
keypair: &Keypair,
|
|
|
|
instruction: Instruction,
|
|
|
|
recent_blockhash: Hash,
|
2020-03-12 23:20:49 -07:00
|
|
|
) -> Result<Signature>;
|
2019-04-11 00:25:14 -07:00
|
|
|
|
|
|
|
/// Attempt to transfer lamports from `keypair` to `pubkey`, but don't wait to confirm.
|
|
|
|
fn async_transfer(
|
|
|
|
&self,
|
|
|
|
lamports: u64,
|
|
|
|
keypair: &Keypair,
|
|
|
|
pubkey: &Pubkey,
|
|
|
|
recent_blockhash: Hash,
|
2020-03-12 23:20:49 -07:00
|
|
|
) -> Result<Signature>;
|
2019-04-11 00:25:14 -07:00
|
|
|
}
|