LightClient

Struct LightClient 

Source
pub struct LightClient {
    pub client: RpcClient,
    pub payer: Keypair,
    pub retry_config: RetryConfig,
    pub indexer: Option<PhotonIndexer>,
    pub state_merkle_trees: Vec<TreeInfo>,
}

Fields§

§client: RpcClient§payer: Keypair§retry_config: RetryConfig§indexer: Option<PhotonIndexer>§state_merkle_trees: Vec<TreeInfo>

Implementations§

Source§

impl LightClient

Source

pub async fn new_with_retry( config: LightClientConfig, retry_config: Option<RetryConfig>, ) -> Result<Self, RpcError>

Source

pub fn add_indexer(&mut self, path: String, api_key: Option<String>)

Trait Implementations§

Source§

impl Debug for LightClient

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Indexer for LightClient

Source§

fn get_validity_proof<'life0, 'async_trait>( &'life0 self, hashes: Vec<Hash>, new_addresses_with_trees: Vec<AddressWithTree>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<ValidityProofWithContext>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns a single ZK Proof used by the compression program to verify that the given accounts are valid and that the new addresses can be created.
Source§

fn get_indexer_slot<'life0, 'async_trait>( &'life0 self, config: Option<RetryConfig>, ) -> Pin<Box<dyn Future<Output = Result<u64, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the slot of the last block indexed by the indexer.
Source§

fn get_multiple_compressed_account_proofs<'life0, 'async_trait>( &'life0 self, hashes: Vec<[u8; 32]>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<Items<MerkleProof>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns multiple proofs used by the compression program to verify the accounts’ validity.
Source§

fn get_compressed_accounts_by_owner<'life0, 'life1, 'async_trait>( &'life0 self, owner: &'life1 Pubkey, options: Option<GetCompressedAccountsByOwnerConfig>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<ItemsWithCursor<CompressedAccount>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the owner’s compressed accounts.
Source§

fn get_compressed_account<'life0, 'async_trait>( &'life0 self, address: Address, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<Option<CompressedAccount>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the compressed account with the given address or hash.
Source§

fn get_compressed_account_by_hash<'life0, 'async_trait>( &'life0 self, hash: Hash, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<Option<CompressedAccount>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the compressed account with the given address or hash.
Source§

fn get_compressed_token_accounts_by_owner<'life0, 'life1, 'async_trait>( &'life0 self, owner: &'life1 Pubkey, options: Option<GetCompressedTokenAccountsByOwnerOrDelegateOptions>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<ItemsWithCursor<CompressedTokenAccount>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn get_compressed_balance<'life0, 'async_trait>( &'life0 self, address: Option<Address>, hash: Option<Hash>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<u64>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the balance for the compressed account with the given address or hash.
Source§

fn get_compressed_token_account_balance<'life0, 'async_trait>( &'life0 self, address: Option<Address>, hash: Option<Hash>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<u64>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the balance for a given token account.
Source§

fn get_multiple_compressed_accounts<'life0, 'async_trait>( &'life0 self, addresses: Option<Vec<Address>>, hashes: Option<Vec<Hash>>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<Items<Option<CompressedAccount>>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns multiple compressed accounts with the given addresses or hashes.
Source§

fn get_compressed_token_balances_by_owner_v2<'life0, 'life1, 'async_trait>( &'life0 self, owner: &'life1 Pubkey, options: Option<GetCompressedTokenAccountsByOwnerOrDelegateOptions>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<ItemsWithCursor<TokenBalance>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the token balances for a given owner.
Source§

fn get_compression_signatures_for_account<'life0, 'async_trait>( &'life0 self, hash: Hash, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<Items<SignatureWithMetadata>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the token balances for a given owner.
Source§

fn get_multiple_new_address_proofs<'life0, 'async_trait>( &'life0 self, merkle_tree_pubkey: [u8; 32], addresses: Vec<[u8; 32]>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<Items<NewAddressProofWithContext>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns proofs that the new addresses are not taken already and can be created.
Source§

fn get_address_queue_with_proofs<'life0, 'life1, 'async_trait>( &'life0 mut self, merkle_tree_pubkey: &'life1 Pubkey, zkp_batch_size: u16, start_offset: Option<u64>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<BatchAddressUpdateIndexerResponse>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn get_queue_elements<'life0, 'async_trait>( &'life0 mut self, merkle_tree_pubkey: [u8; 32], queue_type: QueueType, num_elements: u16, start_queue_index: Option<u64>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<QueueElementsResult>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns queue elements from the queue with the given merkle tree pubkey. For input queues account compression program does not store queue elements in the account data but only emits these in the public transaction event. The indexer needs the queue elements to create batch update proofs.
Source§

fn get_subtrees<'life0, 'async_trait>( &'life0 self, merkle_tree_pubkey: [u8; 32], config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<Items<[u8; 32]>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn get_compressed_balance_by_owner<'life0, 'life1, 'async_trait>( &'life0 self, owner: &'life1 Pubkey, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<u64>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the total balance of the owner’s compressed accounts.
Source§

fn get_compressed_mint_token_holders<'life0, 'life1, 'async_trait>( &'life0 self, mint: &'life1 Pubkey, options: Option<PaginatedOptions>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<ItemsWithCursor<OwnerBalance>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the owner balances for a given mint in descending order.
Source§

fn get_compressed_token_accounts_by_delegate<'life0, 'life1, 'async_trait>( &'life0 self, delegate: &'life1 Pubkey, options: Option<GetCompressedTokenAccountsByOwnerOrDelegateOptions>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<ItemsWithCursor<CompressedTokenAccount>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the compressed token accounts that are partially or fully delegated to the given delegate.
Source§

fn get_compression_signatures_for_address<'life0, 'life1, 'async_trait>( &'life0 self, address: &'life1 [u8; 32], options: Option<PaginatedOptions>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<ItemsWithCursor<SignatureWithMetadata>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Return the signatures of the transactions that closed or opened a compressed account with the given address.
Source§

fn get_compression_signatures_for_owner<'life0, 'life1, 'async_trait>( &'life0 self, owner: &'life1 Pubkey, options: Option<PaginatedOptions>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<ItemsWithCursor<SignatureWithMetadata>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the signatures of the transactions that have modified an owner’s compressed accounts.
Source§

fn get_compression_signatures_for_token_owner<'life0, 'life1, 'async_trait>( &'life0 self, owner: &'life1 Pubkey, options: Option<PaginatedOptions>, config: Option<IndexerRpcConfig>, ) -> Pin<Box<dyn Future<Output = Result<Response<ItemsWithCursor<SignatureWithMetadata>>, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns the signatures of the transactions that have modified an owner’s compressed token accounts.
Source§

fn get_indexer_health<'life0, 'async_trait>( &'life0 self, config: Option<RetryConfig>, ) -> Pin<Box<dyn Future<Output = Result<bool, IndexerError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns an error if the indexer is stale by more than a configurable number of blocks. Otherwise, it returns ok.
Source§

impl MerkleTreeExt for LightClient

Source§

fn get_state_merkle_tree_account<'life0, 'async_trait>( &'life0 mut self, pubkey: Pubkey, ) -> Pin<Box<dyn Future<Output = Result<ConcurrentMerkleTreeCopy<Poseidon, 26>, MerkleTreeExtError>> + Send + 'async_trait>>
where Self: Send + 'async_trait, 'life0: 'async_trait,

Source§

fn get_address_merkle_tree_account<'life0, 'async_trait>( &'life0 mut self, pubkey: Pubkey, ) -> Pin<Box<dyn Future<Output = Result<IndexedMerkleTreeCopy<Poseidon, usize, 26, 16>, MerkleTreeExtError>> + Send + 'async_trait>>
where Self: Send + 'async_trait, 'life0: 'async_trait,

Source§

impl Rpc for LightClient

Source§

fn get_latest_active_state_trees<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Vec<TreeInfo>, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Fetch the latest state tree addresses from the cluster.

Source§

fn get_state_tree_infos(&self) -> Vec<TreeInfo>

Fetch the latest state tree addresses from the cluster.

Source§

fn get_random_state_tree_info(&self) -> Result<TreeInfo, RpcError>

Gets a random active state tree. State trees are cached and have to be fetched or set. Returns v1 state trees by default, v2 state trees when v2 feature is enabled.

Source§

fn get_random_state_tree_info_v1(&self) -> Result<TreeInfo, RpcError>

Gets a random v1 state tree. State trees are cached and have to be fetched or set.

Source§

fn new<'async_trait>( config: LightClientConfig, ) -> Pin<Box<dyn Future<Output = Result<Self, RpcError>> + Send + 'async_trait>>
where Self: Sized + 'async_trait,

Source§

fn get_payer(&self) -> &Keypair

Source§

fn get_url(&self) -> String

Source§

fn health<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn get_program_accounts<'life0, 'life1, 'async_trait>( &'life0 self, program_id: &'life1 Pubkey, ) -> Pin<Box<dyn Future<Output = Result<Vec<(Pubkey, Account)>, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn process_transaction<'life0, 'async_trait>( &'life0 mut self, transaction: Transaction, ) -> Pin<Box<dyn Future<Output = Result<Signature, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn process_transaction_with_context<'life0, 'async_trait>( &'life0 mut self, transaction: Transaction, ) -> Pin<Box<dyn Future<Output = Result<(Signature, Slot), RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn confirm_transaction<'life0, 'async_trait>( &'life0 self, signature: Signature, ) -> Pin<Box<dyn Future<Output = Result<bool, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn get_account<'life0, 'async_trait>( &'life0 self, address: Pubkey, ) -> Pin<Box<dyn Future<Output = Result<Option<Account>, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns an account struct.
Source§

fn get_minimum_balance_for_rent_exemption<'life0, 'async_trait>( &'life0 self, data_len: usize, ) -> Pin<Box<dyn Future<Output = Result<u64, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn airdrop_lamports<'life0, 'life1, 'async_trait>( &'life0 mut self, to: &'life1 Pubkey, lamports: u64, ) -> Pin<Box<dyn Future<Output = Result<Signature, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn get_balance<'life0, 'life1, 'async_trait>( &'life0 self, pubkey: &'life1 Pubkey, ) -> Pin<Box<dyn Future<Output = Result<u64, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn get_latest_blockhash<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(Hash, u64), RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn get_slot<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u64, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn send_transaction<'life0, 'life1, 'async_trait>( &'life0 self, transaction: &'life1 Transaction, ) -> Pin<Box<dyn Future<Output = Result<Signature, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn send_transaction_with_config<'life0, 'life1, 'async_trait>( &'life0 self, transaction: &'life1 Transaction, config: RpcSendTransactionConfig, ) -> Pin<Box<dyn Future<Output = Result<Signature, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn get_transaction_slot<'life0, 'life1, 'async_trait>( &'life0 self, signature: &'life1 Signature, ) -> Pin<Box<dyn Future<Output = Result<u64, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn get_signature_statuses<'life0, 'life1, 'async_trait>( &'life0 self, signatures: &'life1 [Signature], ) -> Pin<Box<dyn Future<Output = Result<Vec<Option<TransactionStatus>>, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn create_and_send_transaction_with_event<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait, T>( &'life0 mut self, instructions: &'life1 [Instruction], payer: &'life2 Pubkey, signers: &'life3 [&'life4 Keypair], ) -> Pin<Box<dyn Future<Output = Result<Option<(T, Signature, u64)>, RpcError>> + Send + 'async_trait>>
where T: BorshDeserialize + Send + Debug + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Source§

fn create_and_send_transaction_with_public_event<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 mut self, instructions: &'life1 [Instruction], payer: &'life2 Pubkey, signers: &'life3 [&'life4 Keypair], ) -> Pin<Box<dyn Future<Output = Result<Option<(PublicTransactionEvent, Signature, Slot)>, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Source§

fn create_and_send_transaction_with_batched_event<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 mut self, instructions: &'life1 [Instruction], payer: &'life2 Pubkey, signers: &'life3 [&'life4 Keypair], ) -> Pin<Box<dyn Future<Output = Result<Option<(Vec<BatchPublicTransactionEvent>, Signature, Slot)>, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Source§

fn indexer(&self) -> Result<&impl Indexer, RpcError>

Source§

fn indexer_mut(&mut self) -> Result<&mut impl Indexer, RpcError>

Source§

fn get_address_tree_v1(&self) -> TreeInfo

Source§

fn get_address_tree_v2(&self) -> TreeInfo

Source§

fn should_retry(&self, error: &RpcError) -> bool

Source§

fn get_anchor_account<'life0, 'life1, 'async_trait, T>( &'life0 self, pubkey: &'life1 Pubkey, ) -> Pin<Box<dyn Future<Output = Result<Option<T>, RpcError>> + Send + 'async_trait>>
where T: 'async_trait + BorshDeserialize, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns an a borsh deserialized account. Deserialization skips the discriminator.
Source§

fn create_and_send_transaction<'a, 'async_trait>( &'a mut self, instructions: &'a [Instruction], payer: &'a Pubkey, signers: &'a [&'a Keypair], ) -> Pin<Box<dyn Future<Output = Result<Signature, RpcError>> + Send + 'async_trait>>
where Self: 'async_trait, 'a: 'async_trait,

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,