Struct Ledger

pub struct Ledger(/* private fields */);

Ledger retrieves information about the current ledger.

For more details about the ledger and the ledger header that the values in the Ledger are derived from, see:

• https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers

Examples

use soroban_sdk::Env;

let ledger = env.ledger();

let protocol_version = ledger.protocol_version();
let sequence = ledger.sequence();
let timestamp = ledger.timestamp();
let network_id = ledger.network_id();

Implementations

impl Ledger

pub fn protocol_version(&self) -> u32

Returns the version of the protocol that the ledger created with.

pub fn sequence(&self) -> u32

Returns the sequence number of the ledger.

The sequence number is a unique number for each ledger that is sequential, incremented by one for each new ledger.

pub fn timestamp(&self) -> u64

Returns a unix timestamp for when the ledger was closed.

The timestamp is the number of seconds, excluding leap seconds, that have elapsed since unix epoch. Unix epoch is January 1st, 1970, at 00:00:00 UTC.

For more details see:

• https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#close-time

pub fn network_id(&self) -> BytesN<32>

Returns the network identifier.

This is SHA-256 hash of the network passphrase, for example for the Public Network this returns:

SHA256(Public Global Stellar Network ; September 2015)

Returns for the Test Network:

SHA256(Test SDF Network ; September 2015)

Trait Implementations

impl Clone for Ledger

fn clone(&self) -> Ledger

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ledger for Ledger

Available on crate feature testutils only.

fn set(&self, li: LedgerInfo)

Set ledger info.

fn set_protocol_version(&self, protocol_version: u32)

Sets the protocol version.

fn set_sequence_number(&self, sequence_number: u32)

Sets the sequence number.

fn set_timestamp(&self, timestamp: u64)

Sets the timestamp.

fn set_network_id(&self, network_id: [u8; 32])

Sets the network ID.

fn set_base_reserve(&self, base_reserve: u32)

Sets the base reserve.

fn set_min_temp_entry_ttl(&self, min_temp_entry_ttl: u32)

Sets the minimum temporary entry time-to-live.

fn set_min_persistent_entry_ttl(&self, min_persistent_entry_ttl: u32)

Sets the minimum persistent entry time-to-live.

fn set_max_entry_ttl(&self, max_entry_ttl: u32)

Sets the maximum entry time-to-live.

fn get(&self) -> LedgerInfo

Get ledger info.

fn with_mut<F>(&self, f: F)

where F: FnMut(&mut LedgerInfo),

Modify the ledger info.