Struct OracleSourceDescriptor 

#[non_exhaustive]
pub struct OracleSourceDescriptor {
    pub adapter_id: OracleAdapterId,
    pub source_kind: Cow<'static, str>,
    pub user_facing_proxy: Address,
    pub read_proxy: Address,
    pub event_source: Address,
    pub transform: OracleTransformDescriptor,
    pub metadata: BTreeMap<String, String>,
}

Open descriptor for an adapter-owned oracle source.

Sources built from this descriptor (crate::FeedSource::custom) default to Chainlink-style proxy reconciliation: after every accepted event, and during crate::OracleTracker::reconcile, the tracker calls latestRoundData() on Self::read_proxy and treats the result as authoritative. There is no opt-out flag, so read_proxy must point at a contract that answers latestRoundData() — for non-Chainlink-shaped sources, point it at a Chainlink-compatible view wrapper.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

adapter_id: OracleAdapterId

Adapter that owns source-specific semantics.

source_kind: Cow<'static, str>

Adapter-local source kind.

user_facing_proxy: Address

User-facing oracle/proxy address.

read_proxy: Address

Address read for authoritative round data. Must answer Chainlink latestRoundData(); reconciliation reads it after every accepted event (see the struct-level docs).

event_source: Address

Address whose events should drive this feed.

transform: OracleTransformDescriptor

User-facing answer transform.

metadata: BTreeMap<String, String>

String metadata for adapter-owned source parameters.

Implementations

impl OracleSourceDescriptor

pub fn new( adapter_id: OracleAdapterId, source_kind: impl Into<Cow<'static, str>>, user_facing_proxy: Address, read_proxy: Address, event_source: Address, ) -> Self

Create a custom source descriptor with identity answer transform and no metadata.

pub fn transform(self, transform: OracleTransformDescriptor) -> Self

Set the source transform descriptor.

pub fn metadata(self, metadata: BTreeMap<String, String>) -> Self

Replace all adapter-owned source metadata.

pub fn metadata_entry( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add one adapter-owned metadata entry.

Trait Implementations

impl Clone for OracleSourceDescriptor

fn clone(&self) -> OracleSourceDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OracleSourceDescriptor

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

Formats the value using the given formatter.

impl Eq for OracleSourceDescriptor

impl PartialEq for OracleSourceDescriptor

fn eq(&self, other: &OracleSourceDescriptor) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for OracleSourceDescriptor