Struct ic_btc_interface::Config

pub struct Config {
    pub stability_threshold: u128,
    pub network: Network,
    pub blocks_source: Principal,
    pub syncing: Flag,
    pub fees: Fees,
    pub api_access: Flag,
    pub disable_api_if_not_fully_synced: Flag,
    pub watchdog_canister: Option<Principal>,
    pub burn_cycles: Flag,
    pub lazily_evaluate_fee_percentiles: Flag,
}

The config of the canister.

Fields

stability_threshold: u128

network: Network

blocks_source: Principal

The principal from which blocks are retrieved.

Setting this source to the management canister means that the blocks will be fetched directly from the replica, and that’s what is used in production.

syncing: Flag

fees: Fees

api_access: Flag

Flag to control access to the apis provided by the canister.

disable_api_if_not_fully_synced: Flag

Flag to determine if the API should be automatically disabled if the canister isn’t fully synced.

watchdog_canister: Option<Principal>

The principal of the watchdog canister. The watchdog canister has the authority to disable the Bitcoin canister’s API if it suspects that there is a problem.

burn_cycles: Flag

If enabled, continuously burns all cycles in its balance (to count towards the IC’s burn rate).

lazily_evaluate_fee_percentiles: Flag

If enabled, fee percentiles are only computed when requested. Otherwise, they are computed whenever we receive a new block.

Trait Implementations

impl CandidType for Config

fn _ty() -> Type

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>

where __S: Serializer,

fn ty() -> Type

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<InitConfig> for Config

fn from(init_config: InitConfig) -> Self

Converts to this type from the input type.