Struct Config 

pub struct Config { /* private fields */ }

Global configuration to interact with the different components of the Protocol.

Used by Authenticators and RPs.

Implementations

impl Config

pub fn new( rpc_url: Option<String>, chain_id: u64, registry_address: Address, indexer_url: String, gateway_url: String, nullifier_oracle_urls: Vec<String>, nullifier_oracle_threshold: usize, ) -> Result<Config, PrimitiveError>

Instantiates a new configuration.

Errors

Returns an error if the rpc_url is invalid.

pub fn from_json(json_str: &str) -> Result<Config, PrimitiveError>

Loads a configuration from JSON.

Errors

Will error if the JSON is not valid.

pub const fn rpc_url(&self) -> Option<&Url>

The RPC endpoint to perform RPC calls.

pub const fn chain_id(&self) -> u64

The chain ID of the network where the WorldIDRegistry contract is deployed.

pub const fn registry_address(&self) -> &Address

The address of the WorldIDRegistry contract.

pub const fn indexer_url(&self) -> &String

The URL of the world-id-indexer service to use. The indexer is used to fetch inclusion proofs from the WorldIDRegistry contract.

pub const fn gateway_url(&self) -> &String

The URL of the world-id-gateway service to use. The gateway is used to perform operations on the WorldIDRegistry contract without leaking a wallet address.

pub const fn nullifier_oracle_urls(&self) -> &Vec<String>

The list of URLs of all and each node of the Nullifier Oracle.

pub const fn nullifier_oracle_threshold(&self) -> usize

The minimum number of Nullifier Oracle responses required to build a nullifier.

pub fn zkey_cache_dir(&self) -> Option<&Path>

Optional directory to cache uncompressed circuit zkeys.

pub fn with_zkey_cache_dir(self, zkey_cache_dir: impl Into<PathBuf>) -> Config

Sets the directory used to cache uncompressed circuit zkeys.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Config, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.