Struct snarkvm_ledger::Ledger
source · pub struct Ledger<N: Network, C: ConsensusStorage<N>> { /* private fields */ }Implementations§
source§impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
sourcepub fn prepare_advance_to_next_block<R: Rng + CryptoRng>(
&self,
private_key: &PrivateKey<N>,
candidate_transactions: Vec<Transaction<N>>,
candidate_solutions: Option<Vec<ProverSolution<N>>>,
rng: &mut R
) -> Result<Block<N>>
pub fn prepare_advance_to_next_block<R: Rng + CryptoRng>( &self, private_key: &PrivateKey<N>, candidate_transactions: Vec<Transaction<N>>, candidate_solutions: Option<Vec<ProverSolution<N>>>, rng: &mut R ) -> Result<Block<N>>
Returns a candidate for the next block in the ledger.
sourcepub fn advance_to_next_block(&self, block: &Block<N>) -> Result<()>
pub fn advance_to_next_block(&self, block: &Block<N>) -> Result<()>
Adds the given block as the next block in the ledger.
source§impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
sourcepub fn check_transaction_basic(
&self,
transaction: &Transaction<N>,
rejected_id: Option<Field<N>>
) -> Result<()>
pub fn check_transaction_basic( &self, transaction: &Transaction<N>, rejected_id: Option<Field<N>> ) -> Result<()>
Checks the given transaction is well-formed and unique.
sourcepub fn check_next_block(&self, block: &Block<N>) -> Result<()>
pub fn check_next_block(&self, block: &Block<N>) -> Result<()>
Checks the given block is valid next block.
source§impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
sourcepub fn contains_state_root(&self, state_root: &N::StateRoot) -> Result<bool>
pub fn contains_state_root(&self, state_root: &N::StateRoot) -> Result<bool>
Returns true if the given state root exists.
sourcepub fn contains_block_height(&self, height: u32) -> Result<bool>
pub fn contains_block_height(&self, height: u32) -> Result<bool>
Returns true if the given block height exists.
sourcepub fn contains_block_hash(&self, block_hash: &N::BlockHash) -> Result<bool>
pub fn contains_block_hash(&self, block_hash: &N::BlockHash) -> Result<bool>
Returns true if the given block hash exists.
sourcepub fn contains_puzzle_commitment(
&self,
puzzle_commitment: &PuzzleCommitment<N>
) -> Result<bool>
pub fn contains_puzzle_commitment( &self, puzzle_commitment: &PuzzleCommitment<N> ) -> Result<bool>
Returns true if the given puzzle commitment exists.
sourcepub fn contains_program_id(&self, program_id: &ProgramID<N>) -> Result<bool>
pub fn contains_program_id(&self, program_id: &ProgramID<N>) -> Result<bool>
Returns true if the given program ID exists.
sourcepub fn contains_transaction_id(
&self,
transaction_id: &N::TransactionID
) -> Result<bool>
pub fn contains_transaction_id( &self, transaction_id: &N::TransactionID ) -> Result<bool>
Returns true if the given transaction ID exists.
sourcepub fn contains_transition_id(
&self,
transition_id: &N::TransitionID
) -> Result<bool>
pub fn contains_transition_id( &self, transition_id: &N::TransitionID ) -> Result<bool>
Returns true if the given transition ID exists.
sourcepub fn contains_input_id(&self, input_id: &Field<N>) -> Result<bool>
pub fn contains_input_id(&self, input_id: &Field<N>) -> Result<bool>
Returns true if the given input ID exists.
sourcepub fn contains_serial_number(&self, serial_number: &Field<N>) -> Result<bool>
pub fn contains_serial_number(&self, serial_number: &Field<N>) -> Result<bool>
Returns true if the given serial number exists.
sourcepub fn contains_tag(&self, tag: &Field<N>) -> Result<bool>
pub fn contains_tag(&self, tag: &Field<N>) -> Result<bool>
Returns true if the given tag exists.
sourcepub fn contains_output_id(&self, output_id: &Field<N>) -> Result<bool>
pub fn contains_output_id(&self, output_id: &Field<N>) -> Result<bool>
Returns true if the given output ID exists.
sourcepub fn contains_commitment(&self, commitment: &Field<N>) -> Result<bool>
pub fn contains_commitment(&self, commitment: &Field<N>) -> Result<bool>
Returns true if the given commitment exists.
sourcepub fn contains_checksum(&self, checksum: &Field<N>) -> bool
pub fn contains_checksum(&self, checksum: &Field<N>) -> bool
Returns true if the given checksum exists.
sourcepub fn contains_nonce(&self, nonce: &Group<N>) -> Result<bool>
pub fn contains_nonce(&self, nonce: &Group<N>) -> Result<bool>
Returns true if the given nonce exists.
sourcepub fn contains_tpk(&self, tpk: &Group<N>) -> Result<bool>
pub fn contains_tpk(&self, tpk: &Group<N>) -> Result<bool>
Returns true if the given transition public key exists.
sourcepub fn contains_tcm(&self, tcm: &Field<N>) -> Result<bool>
pub fn contains_tcm(&self, tcm: &Field<N>) -> Result<bool>
Returns true if the given transition commitment exists.
source§impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
sourcepub fn find_block_height_from_state_root(
&self,
state_root: N::StateRoot
) -> Result<Option<u32>>
pub fn find_block_height_from_state_root( &self, state_root: N::StateRoot ) -> Result<Option<u32>>
Returns the block height that contains the given state root.
sourcepub fn find_block_hash(
&self,
transaction_id: &N::TransactionID
) -> Result<Option<N::BlockHash>>
pub fn find_block_hash( &self, transaction_id: &N::TransactionID ) -> Result<Option<N::BlockHash>>
Returns the block hash that contains the given transaction ID.
sourcepub fn find_block_height_from_puzzle_commitment(
&self,
puzzle_commitment: &PuzzleCommitment<N>
) -> Result<Option<u32>>
pub fn find_block_height_from_puzzle_commitment( &self, puzzle_commitment: &PuzzleCommitment<N> ) -> Result<Option<u32>>
Returns the block height that contains the given puzzle commitment.
sourcepub fn find_transaction_id_from_program_id(
&self,
program_id: &ProgramID<N>
) -> Result<Option<N::TransactionID>>
pub fn find_transaction_id_from_program_id( &self, program_id: &ProgramID<N> ) -> Result<Option<N::TransactionID>>
Returns the transaction ID that contains the given program ID.
sourcepub fn find_transaction_id_from_transition_id(
&self,
transition_id: &N::TransitionID
) -> Result<Option<N::TransactionID>>
pub fn find_transaction_id_from_transition_id( &self, transition_id: &N::TransitionID ) -> Result<Option<N::TransactionID>>
Returns the transaction ID that contains the given transition ID.
sourcepub fn find_transition_id(&self, id: &Field<N>) -> Result<N::TransitionID>
pub fn find_transition_id(&self, id: &Field<N>) -> Result<N::TransitionID>
Returns the transition ID that contains the given input ID or output ID.
sourcepub fn find_record_ciphertexts<'a>(
&'a self,
view_key: &'a ViewKey<N>,
filter: RecordsFilter<N>
) -> Result<impl '_ + Iterator<Item = (Field<N>, Cow<'_, Record<N, Ciphertext<N>>>)>>
pub fn find_record_ciphertexts<'a>( &'a self, view_key: &'a ViewKey<N>, filter: RecordsFilter<N> ) -> Result<impl '_ + Iterator<Item = (Field<N>, Cow<'_, Record<N, Ciphertext<N>>>)>>
Returns the record ciphertexts that belong to the given view key.
sourcepub fn find_records<'a>(
&'a self,
view_key: &'a ViewKey<N>,
filter: RecordsFilter<N>
) -> Result<impl '_ + Iterator<Item = (Field<N>, Record<N, Plaintext<N>>)>>
pub fn find_records<'a>( &'a self, view_key: &'a ViewKey<N>, filter: RecordsFilter<N> ) -> Result<impl '_ + Iterator<Item = (Field<N>, Record<N, Plaintext<N>>)>>
Returns the records that belong to the given view key.
source§impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
sourcepub fn get_state_root(&self, block_height: u32) -> Result<Option<N::StateRoot>>
pub fn get_state_root(&self, block_height: u32) -> Result<Option<N::StateRoot>>
Returns the state root that contains the given block height.
sourcepub fn get_state_path_for_commitment(
&self,
commitment: &Field<N>
) -> Result<StatePath<N>>
pub fn get_state_path_for_commitment( &self, commitment: &Field<N> ) -> Result<StatePath<N>>
Returns a state path for the given commitment.
sourcepub fn get_epoch_challenge(
&self,
block_height: u32
) -> Result<EpochChallenge<N>>
pub fn get_epoch_challenge( &self, block_height: u32 ) -> Result<EpochChallenge<N>>
Returns the epoch challenge for the given block height.
sourcepub fn get_block(&self, height: u32) -> Result<Block<N>>
pub fn get_block(&self, height: u32) -> Result<Block<N>>
Returns the block for the given block height.
sourcepub fn get_blocks(&self, heights: Range<u32>) -> Result<Vec<Block<N>>>
pub fn get_blocks(&self, heights: Range<u32>) -> Result<Vec<Block<N>>>
Returns the blocks in the given block range. The range is inclusive of the start and exclusive of the end.
sourcepub fn get_block_by_hash(&self, block_hash: &N::BlockHash) -> Result<Block<N>>
pub fn get_block_by_hash(&self, block_hash: &N::BlockHash) -> Result<Block<N>>
Returns the block for the given block hash.
sourcepub fn get_height(&self, block_hash: &N::BlockHash) -> Result<u32>
pub fn get_height(&self, block_hash: &N::BlockHash) -> Result<u32>
Returns the block height for the given block hash.
sourcepub fn get_hash(&self, height: u32) -> Result<N::BlockHash>
pub fn get_hash(&self, height: u32) -> Result<N::BlockHash>
Returns the block hash for the given block height.
sourcepub fn get_previous_hash(&self, height: u32) -> Result<N::BlockHash>
pub fn get_previous_hash(&self, height: u32) -> Result<N::BlockHash>
Returns the previous block hash for the given block height.
sourcepub fn get_header(&self, height: u32) -> Result<Header<N>>
pub fn get_header(&self, height: u32) -> Result<Header<N>>
Returns the block header for the given block height.
sourcepub fn get_transactions(&self, height: u32) -> Result<Transactions<N>>
pub fn get_transactions(&self, height: u32) -> Result<Transactions<N>>
Returns the block transactions for the given block height.
sourcepub fn get_transaction(
&self,
transaction_id: N::TransactionID
) -> Result<Transaction<N>>
pub fn get_transaction( &self, transaction_id: N::TransactionID ) -> Result<Transaction<N>>
Returns the transaction for the given transaction ID.
sourcepub fn get_confirmed_transaction(
&self,
transaction_id: N::TransactionID
) -> Result<ConfirmedTransaction<N>>
pub fn get_confirmed_transaction( &self, transaction_id: N::TransactionID ) -> Result<ConfirmedTransaction<N>>
Returns the confirmed transaction for the given transaction ID.
sourcepub fn get_program(&self, program_id: ProgramID<N>) -> Result<Program<N>>
pub fn get_program(&self, program_id: ProgramID<N>) -> Result<Program<N>>
Returns the program for the given program ID.
sourcepub fn get_coinbase(&self, height: u32) -> Result<Option<CoinbaseSolution<N>>>
pub fn get_coinbase(&self, height: u32) -> Result<Option<CoinbaseSolution<N>>>
Returns the block coinbase solution for the given block height.
sourcepub fn get_signature(&self, height: u32) -> Result<Signature<N>>
pub fn get_signature(&self, height: u32) -> Result<Signature<N>>
Returns the block signature for the given block height.
source§impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
sourcepub fn state_roots(&self) -> impl '_ + Iterator<Item = Cow<'_, N::StateRoot>>
pub fn state_roots(&self) -> impl '_ + Iterator<Item = Cow<'_, N::StateRoot>>
Returns an iterator over the state roots, for all blocks in self.
sourcepub fn puzzle_commitments(
&self
) -> impl '_ + Iterator<Item = Cow<'_, PuzzleCommitment<N>>>
pub fn puzzle_commitments( &self ) -> impl '_ + Iterator<Item = Cow<'_, PuzzleCommitment<N>>>
Returns an iterator over the puzzle commitments, for all blocks in self.
sourcepub fn program_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, ProgramID<N>>>
pub fn program_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, ProgramID<N>>>
Returns an iterator over the program IDs, for all transactions in self.
sourcepub fn programs(&self) -> impl '_ + Iterator<Item = Cow<'_, Program<N>>>
pub fn programs(&self) -> impl '_ + Iterator<Item = Cow<'_, Program<N>>>
Returns an iterator over the programs, for all transactions in self.
sourcepub fn transaction_ids(
&self
) -> impl '_ + Iterator<Item = Cow<'_, N::TransactionID>>
pub fn transaction_ids( &self ) -> impl '_ + Iterator<Item = Cow<'_, N::TransactionID>>
Returns an iterator over the transaction IDs, for all transactions in self.
sourcepub fn transition_ids(
&self
) -> impl '_ + Iterator<Item = Cow<'_, N::TransitionID>>
pub fn transition_ids( &self ) -> impl '_ + Iterator<Item = Cow<'_, N::TransitionID>>
Returns an iterator over the transition IDs, for all transitions.
sourcepub fn input_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>
pub fn input_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>
Returns an iterator over the input IDs, for all transition inputs.
sourcepub fn serial_numbers(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>
pub fn serial_numbers(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>
Returns an iterator over the serial numbers, for all transition inputs that are records.
Returns an iterator over the tags, for all transition inputs that are records.
sourcepub fn output_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>
pub fn output_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>
Returns an iterator over the output IDs, for all transition outputs that are records.
sourcepub fn commitments(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>
pub fn commitments(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>
Returns an iterator over the commitments, for all transition outputs that are records.
sourcepub fn nonces(&self) -> impl '_ + Iterator<Item = Cow<'_, Group<N>>>
pub fn nonces(&self) -> impl '_ + Iterator<Item = Cow<'_, Group<N>>>
Returns an iterator over the nonces, for all transition outputs that are records.
sourcepub fn records(
&self
) -> impl '_ + Iterator<Item = (Cow<'_, Field<N>>, Cow<'_, Record<N, Ciphertext<N>>>)>
pub fn records( &self ) -> impl '_ + Iterator<Item = (Cow<'_, Field<N>>, Cow<'_, Record<N, Ciphertext<N>>>)>
Returns an iterator over the (commitment, record) pairs, for all transition outputs that are records.
sourcepub fn transition_public_keys(
&self
) -> impl '_ + Iterator<Item = Cow<'_, Group<N>>>
pub fn transition_public_keys( &self ) -> impl '_ + Iterator<Item = Cow<'_, Group<N>>>
Returns an iterator over the transition public keys, for all transactions.
source§impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
sourcepub fn load(genesis: Block<N>, dev: Option<u16>) -> Result<Self>
pub fn load(genesis: Block<N>, dev: Option<u16>) -> Result<Self>
Loads the ledger from storage.
sourcepub fn load_unchecked(genesis: Block<N>, dev: Option<u16>) -> Result<Self>
pub fn load_unchecked(genesis: Block<N>, dev: Option<u16>) -> Result<Self>
Loads the ledger from storage, without performing integrity checks.
sourcepub const fn coinbase_puzzle(&self) -> &CoinbasePuzzle<N>
pub const fn coinbase_puzzle(&self) -> &CoinbasePuzzle<N>
Returns the coinbase puzzle.
sourcepub fn latest_committee(&self) -> IndexSet<Address<N>>
pub fn latest_committee(&self) -> IndexSet<Address<N>>
Returns the latest committee.
sourcepub fn latest_state_root(&self) -> N::StateRoot
pub fn latest_state_root(&self) -> N::StateRoot
Returns the latest state root.
sourcepub fn latest_block(&self) -> Block<N>
pub fn latest_block(&self) -> Block<N>
Returns the latest block.
sourcepub fn latest_round(&self) -> u64
pub fn latest_round(&self) -> u64
Returns the latest round number.
sourcepub fn latest_height(&self) -> u32
pub fn latest_height(&self) -> u32
Returns the latest block height.
sourcepub fn latest_hash(&self) -> N::BlockHash
pub fn latest_hash(&self) -> N::BlockHash
Returns the latest block hash.
sourcepub fn latest_header(&self) -> Header<N>
pub fn latest_header(&self) -> Header<N>
Returns the latest block header.
sourcepub fn latest_total_supply_in_microcredits(&self) -> u64
pub fn latest_total_supply_in_microcredits(&self) -> u64
Returns the latest total supply in microcredits.
sourcepub fn latest_cumulative_weight(&self) -> u128
pub fn latest_cumulative_weight(&self) -> u128
Returns the latest latest cumulative weight.
sourcepub fn latest_coinbase_accumulator_point(&self) -> Field<N>
pub fn latest_coinbase_accumulator_point(&self) -> Field<N>
Returns the latest block coinbase accumulator point.
sourcepub fn latest_coinbase_target(&self) -> u64
pub fn latest_coinbase_target(&self) -> u64
Returns the latest block coinbase target.
sourcepub fn latest_proof_target(&self) -> u64
pub fn latest_proof_target(&self) -> u64
Returns the latest block proof target.
sourcepub fn last_coinbase_target(&self) -> u64
pub fn last_coinbase_target(&self) -> u64
Returns the last coinbase target.
sourcepub fn last_coinbase_timestamp(&self) -> i64
pub fn last_coinbase_timestamp(&self) -> i64
Returns the last coinbase timestamp.
sourcepub fn latest_timestamp(&self) -> i64
pub fn latest_timestamp(&self) -> i64
Returns the latest block timestamp.
sourcepub fn latest_transactions(&self) -> Transactions<N>
pub fn latest_transactions(&self) -> Transactions<N>
Returns the latest block transactions.
sourcepub fn latest_epoch_number(&self) -> u32
pub fn latest_epoch_number(&self) -> u32
Returns the latest epoch number.
sourcepub fn latest_epoch_challenge(&self) -> Result<EpochChallenge<N>>
pub fn latest_epoch_challenge(&self) -> Result<EpochChallenge<N>>
Returns the latest epoch challenge.
source§impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
impl<N: Network, C: ConsensusStorage<N>> Ledger<N, C>
sourcepub fn find_unspent_credits_records(
&self,
view_key: &ViewKey<N>
) -> Result<RecordMap<N>>
pub fn find_unspent_credits_records( &self, view_key: &ViewKey<N> ) -> Result<RecordMap<N>>
Returns the unspent credits.aleo records.
sourcepub fn create_deploy(
&self,
private_key: &PrivateKey<N>,
program: &Program<N>,
priority_fee_in_microcredits: u64,
query: Option<Query<N, C::BlockStorage>>
) -> Result<Transaction<N>>
pub fn create_deploy( &self, private_key: &PrivateKey<N>, program: &Program<N>, priority_fee_in_microcredits: u64, query: Option<Query<N, C::BlockStorage>> ) -> Result<Transaction<N>>
Creates a deploy transaction.
The priority_fee_in_microcredits is an additional fee on top of the deployment fee.
sourcepub fn create_transfer(
&self,
private_key: &PrivateKey<N>,
to: Address<N>,
amount_in_microcredits: u64,
priority_fee_in_microcredits: u64,
query: Option<Query<N, C::BlockStorage>>
) -> Result<Transaction<N>>
pub fn create_transfer( &self, private_key: &PrivateKey<N>, to: Address<N>, amount_in_microcredits: u64, priority_fee_in_microcredits: u64, query: Option<Query<N, C::BlockStorage>> ) -> Result<Transaction<N>>
Creates a transfer transaction.
The priority_fee_in_microcredits is an additional fee on top of the execution fee.