noie-nds-api 3.0.3

NDS Protocol Buffers types for Rust (generated from nds-api/spec).
Documentation
// @generated
// This file is @generated by prost-build.
// ============================================================================
// \[Index\] NDS-PROTO-TRANSACTION-030 NdsTransaction
// ============================================================================

/// \[Semantic\] Economic event representing an asset delta or transfer.
/// \[Behavior\] All economic mutations SHOULD be expressed as transactions.
/// \[SearchTag\] transaction, delta, transfer, consistency
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct NdsTransaction {
    /// Base event information.
    #[prost(message, optional, tag="1")]
    pub id: ::core::option::Option<super::event::EventId>,
    /// Occurrence time (UTC).
    #[prost(message, optional, tag="2")]
    pub occurred_at: ::core::option::Option<::prost_types::Timestamp>,
    /// Actor identity.
    #[prost(message, optional, tag="3")]
    pub actor: ::core::option::Option<super::identity::NdsIdentity>,
    /// Event payload (optional extra data).
    #[prost(message, optional, tag="4")]
    pub payload: ::core::option::Option<super::event::NdsPayload>,
    /// Schema version.
    #[prost(int32, tag="5")]
    pub schema_version: i32,
    /// Metadata.
    #[prost(map="string, string", tag="6")]
    pub metadata: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
    /// Context (optional).
    #[prost(message, optional, tag="7")]
    pub context: ::core::option::Option<super::context::NdsContext>,
    // ===== Transaction-specific fields =====

    /// Asset ID.
    #[prost(message, optional, tag="10")]
    pub asset: ::core::option::Option<super::asset::AssetId>,
    /// Delta (positive=credit, negative=debit).
    #[prost(message, optional, tag="11")]
    pub delta: ::core::option::Option<super::common::Decimal>,
    /// Consistency mode.
    #[prost(enumeration="ConsistencyMode", tag="12")]
    pub consistency: i32,
    /// Source identity (optional; for transfers).
    #[prost(message, optional, tag="13")]
    pub source: ::core::option::Option<super::identity::NdsIdentity>,
    /// Target identity (optional; for transfers).
    #[prost(message, optional, tag="14")]
    pub target: ::core::option::Option<super::identity::NdsIdentity>,
    /// Reason (optional).
    #[prost(string, optional, tag="15")]
    pub reason: ::core::option::Option<::prost::alloc::string::String>,
    /// Transaction status.
    #[prost(enumeration="TransactionStatus", tag="16")]
    pub status: i32,
    /// Effective enforcement policy id (optional; implementation-defined).
    /// \[Since\] 2.2.0
    #[prost(string, optional, tag="17")]
    pub enforcement_policy_id: ::core::option::Option<::prost::alloc::string::String>,
    /// Lightweight structured rationale (optional).
    /// \[Since\] 2.2.0
    #[prost(message, optional, tag="18")]
    pub rationale: ::core::option::Option<super::audit::NdsRationale>,
    /// External rationale reference for heavy payloads (optional).
    /// \[Since\] 2.2.0
    #[prost(message, optional, tag="19")]
    pub rationale_ref: ::core::option::Option<super::audit::NdsRationaleRef>,
}
// ============================================================================
// \[Index\] NDS-PROTO-TRANSACTION-100 Request/Response Messages
// ============================================================================

/// \[Index\] NDS-PROTO-TRANSACTION-110 CreateTransactionRequest
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTransactionRequest {
    /// Asset ID.
    #[prost(message, optional, tag="1")]
    pub asset: ::core::option::Option<super::asset::AssetId>,
    /// Delta.
    #[prost(message, optional, tag="2")]
    pub delta: ::core::option::Option<super::common::Decimal>,
    /// Actor.
    #[prost(message, optional, tag="3")]
    pub actor: ::core::option::Option<super::identity::NdsIdentity>,
    /// Consistency mode (defaults to STRONG).
    #[prost(enumeration="ConsistencyMode", tag="4")]
    pub consistency: i32,
    /// Source identity (optional).
    #[prost(message, optional, tag="5")]
    pub source: ::core::option::Option<super::identity::NdsIdentity>,
    /// Target identity (optional).
    #[prost(message, optional, tag="6")]
    pub target: ::core::option::Option<super::identity::NdsIdentity>,
    /// Reason (optional).
    #[prost(string, optional, tag="7")]
    pub reason: ::core::option::Option<::prost::alloc::string::String>,
    /// Context (optional).
    #[prost(message, optional, tag="8")]
    pub context: ::core::option::Option<super::context::NdsContext>,
    /// Extra metadata.
    #[prost(map="string, string", tag="9")]
    pub metadata: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
}
/// \[Index\] NDS-PROTO-TRANSACTION-120 CreateTransactionResponse
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTransactionResponse {
    /// Result.
    #[prost(message, optional, tag="1")]
    pub result: ::core::option::Option<super::common::NdsResult>,
    /// Transaction (valid only on success).
    #[prost(message, optional, tag="2")]
    pub transaction: ::core::option::Option<NdsTransaction>,
}
// ============================================================================
// \[Index\] NDS-PROTO-TRANSACTION-130 PreviewTransactionResponse
// ============================================================================

#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PreviewTransactionResponse {
    #[prost(message, optional, tag="1")]
    pub result: ::core::option::Option<super::common::NdsResult>,
}
// ============================================================================
// \[Index\] NDS-PROTO-TRANSACTION-140 BatchCreateTransactionsRequest/Response
// ============================================================================

#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCreateTransactionsRequest {
    #[prost(message, repeated, tag="1")]
    pub requests: ::prost::alloc::vec::Vec<CreateTransactionRequest>,
    /// Optional: client-provided correlation id.
    /// Implementations MAY ignore atomicity semantics; this field MUST NOT imply a required atomic guarantee.
    #[prost(string, optional, tag="2")]
    pub batch_id: ::core::option::Option<::prost::alloc::string::String>,
    /// Optional: metadata.
    #[prost(map="string, string", tag="3")]
    pub metadata: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchCreateTransactionsResponse {
    #[prost(message, optional, tag="1")]
    pub result: ::core::option::Option<super::common::NdsResult>,
    #[prost(message, repeated, tag="2")]
    pub responses: ::prost::alloc::vec::Vec<CreateTransactionResponse>,
}
// ============================================================================
// \[Index\] NDS-PROTO-TRANSACTION-150 StreamTransactionsRequest
// ============================================================================

#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamTransactionsRequest {
    /// Optional filters (implementation MAY support subset).
    #[prost(message, optional, tag="1")]
    pub asset: ::core::option::Option<super::asset::AssetId>,
    #[prost(message, optional, tag="2")]
    pub actor: ::core::option::Option<super::identity::NdsIdentity>,
    #[prost(message, optional, tag="3")]
    pub source: ::core::option::Option<super::identity::NdsIdentity>,
    #[prost(message, optional, tag="4")]
    pub target: ::core::option::Option<super::identity::NdsIdentity>,
    /// Start streaming from a given time (UTC).
    #[prost(message, optional, tag="5")]
    pub since: ::core::option::Option<::prost_types::Timestamp>,
    /// Optional status filter.
    #[prost(enumeration="TransactionStatus", repeated, tag="6")]
    pub statuses: ::prost::alloc::vec::Vec<i32>,
    /// Extra metadata for implementations.
    #[prost(map="string, string", tag="7")]
    pub metadata: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
}
// ============================================================================
// \[Index\] NDS-PROTO-TRANSACTION-010 ConsistencyMode
// ============================================================================

/// \[Semantic\] Consistency requirements for applying a transaction.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ConsistencyMode {
    /// Unspecified (defaults to STRONG).
    Unspecified = 0,
    /// Strong consistency.
    /// Applies immediately; prioritizes correctness.
    /// Suitable for critical economic operations (payments, transfers).
    Strong = 1,
    /// Eventual consistency.
    /// May apply with delay; converges over time.
    /// Suitable for non-critical operations (stats, logs).
    Eventual = 2,
    /// Optimistic consistency.
    /// Based on optimistic concurrency; may fail.
    /// Suitable for high-concurrency scenarios.
    Optimistic = 3,
}
impl ConsistencyMode {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            Self::Unspecified => "CONSISTENCY_MODE_UNSPECIFIED",
            Self::Strong => "CONSISTENCY_MODE_STRONG",
            Self::Eventual => "CONSISTENCY_MODE_EVENTUAL",
            Self::Optimistic => "CONSISTENCY_MODE_OPTIMISTIC",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "CONSISTENCY_MODE_UNSPECIFIED" => Some(Self::Unspecified),
            "CONSISTENCY_MODE_STRONG" => Some(Self::Strong),
            "CONSISTENCY_MODE_EVENTUAL" => Some(Self::Eventual),
            "CONSISTENCY_MODE_OPTIMISTIC" => Some(Self::Optimistic),
            _ => None,
        }
    }
}
// ============================================================================
// \[Index\] NDS-PROTO-TRANSACTION-020 TransactionStatus
// ============================================================================

/// \[Semantic\] Transaction lifecycle status.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum TransactionStatus {
    /// Unspecified.
    Unspecified = 0,
    /// Pending.
    Pending = 1,
    /// Committed.
    Committed = 2,
    /// Rolled back.
    RolledBack = 3,
    /// Failed.
    Failed = 4,
}
impl TransactionStatus {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            Self::Unspecified => "TRANSACTION_STATUS_UNSPECIFIED",
            Self::Pending => "TRANSACTION_STATUS_PENDING",
            Self::Committed => "TRANSACTION_STATUS_COMMITTED",
            Self::RolledBack => "TRANSACTION_STATUS_ROLLED_BACK",
            Self::Failed => "TRANSACTION_STATUS_FAILED",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "TRANSACTION_STATUS_UNSPECIFIED" => Some(Self::Unspecified),
            "TRANSACTION_STATUS_PENDING" => Some(Self::Pending),
            "TRANSACTION_STATUS_COMMITTED" => Some(Self::Committed),
            "TRANSACTION_STATUS_ROLLED_BACK" => Some(Self::RolledBack),
            "TRANSACTION_STATUS_FAILED" => Some(Self::Failed),
            _ => None,
        }
    }
}
// @@protoc_insertion_point(module)