Add more types to api-types

Cargo.toml

@@ -22,6 +22,7 @@ solana-sdk = "2.0.13"
 solana-rpc-client = "2.0.13"
 solana-transaction-status = "2.0.13"
 solana-client = "2.0.13"
+email_address = "0.2.4"
 
 # The curve25519-dalek crate is a dependency of solana-sdk.
 # This crate relies on a specific version of zeroize that is incompatible with many other packages.

auction-server/Cargo.toml

@@ -30,7 +30,7 @@ axum-macros = "0.4.0"
 sqlx = { version = "0.7.4", features = [ "runtime-tokio", "tls-native-tls", "postgres", "time", "uuid", "bigdecimal", "json" ] }
 tokio-util = { version = "0.7.10", features = ["rt"] }
 axum-extra = { version = "0.9.3", features = ["typed-header"] }
-email_address = "0.2.4"
+email_address = { workspace = true }
 rand = "0.8.5"
 base64 = { workspace = true }
 time = { workspace = true, features = ["serde"] }

auction-server/api-types/Cargo.toml

@@ -17,3 +17,5 @@ ethers = { workspace = true }
 time = { workspace = true, features = ["serde"] }
 base64 = { workspace = true }
 bincode = { workspace = true }
+email_address = { workspace = true }
+http = "1.2.0"

auction-server/api-types/src/bid.rs

@@ -0,0 +1,301 @@
+use {
+    crate::{
+        profile::ProfileId,
+        ChainId,
+        PermissionKeyEvm,
+        PermissionKeySvm,
+    },
+    ethers::types::{
+        Address,
+        Bytes,
+        H256,
+        U256,
+    },
+    serde::{
+        Deserialize,
+        Serialize,
+    },
+    serde_with::{
+        serde_as,
+        DisplayFromStr,
+    },
+    solana_sdk::{
+        signature::Signature,
+        transaction::VersionedTransaction,
+    },
+    time::OffsetDateTime,
+    utoipa::{
+        IntoParams,
+        ToResponse,
+        ToSchema,
+    },
+    uuid::Uuid,
+};
+
+pub type BidId = Uuid;
+pub type BidAmountSvm = u64;
+pub type BidAmountEvm = U256;
+
+#[derive(Serialize, Deserialize, ToSchema, Clone, PartialEq, Debug)]
+#[serde(tag = "type", rename_all = "snake_case")]
+pub enum BidStatusEvm {
+    /// The temporary state which means the auction for this bid is pending.
+    #[schema(title = "Pending")]
+    Pending,
+    /// The bid is submitted to the chain, which is placed at the given index of the transaction with the given hash.
+    /// This state is temporary and will be updated to either lost or won after conclusion of the auction.
+    #[schema(title = "Submitted")]
+    Submitted {
+        #[schema(example = "0x103d4fbd777a36311b5161f2062490f761f25b67406badb2bace62bb170aa4e3", value_type = String)]
+        result: H256,
+        #[schema(example = 1, value_type = u32)]
+        index:  u32,
+    },
+    /// The bid lost the auction, which is concluded with the transaction with the given hash and index.
+    /// The result will be None if the auction was concluded off-chain and no auction was submitted to the chain.
+    /// The index will be None if the bid was not submitted to the chain and lost the auction by off-chain calculation.
+    /// There are cases where the result is not None and the index is None.
+    /// It is because other bids were selected for submission to the chain, but not this one.
+    #[schema(title = "Lost")]
+    Lost {
+        #[schema(example = "0x103d4fbd777a36311b5161f2062490f761f25b67406badb2bace62bb170aa4e3", value_type = Option<String>)]
+        result: Option<H256>,
+        #[schema(example = 1, value_type = Option<u32>)]
+        index:  Option<u32>,
+    },
+    /// The bid won the auction, which is concluded with the transaction with the given hash and index.
+    #[schema(title = "Won")]
+    Won {
+        #[schema(example = "0x103d4fbd777a36311b5161f2062490f761f25b67406badb2bace62bb170aa4e3", value_type = String)]
+        result: H256,
+        #[schema(example = 1, value_type = u32)]
+        index:  u32,
+    },
+}
+
+#[serde_as]
+#[derive(Serialize, Deserialize, ToSchema, Clone, PartialEq, Debug)]
+#[serde(tag = "type", rename_all = "snake_case")]
+pub enum BidStatusSvm {
+    /// The temporary state which means the auction for this bid is pending.
+    #[schema(title = "Pending")]
+    Pending,
+    /// The bid lost the auction.
+    /// The result will be None if the auction does not result in a transaction being submitted to the chain.
+    /// The result will be Some if this bid lost to another bid and the winning bid was submitted to the chain.
+    /// The signature of the transaction for the submitted bid is the result value.
+    #[schema(title = "Lost")]
+    Lost {
+        #[schema(example = "Jb2urXPyEh4xiBgzYvwEFe4q1iMxG1DNxWGGQg94AmKgqFTwLAiTiHrYiYxwHUB4DV8u5ahNEVtMMDm3sNSRdTg", value_type = Option<String>)]
+        #[serde(with = "crate::serde::nullable_signature_svm")]
+        result: Option<Signature>,
+    },
+    /// The bid won the auction and was submitted to the chain, with the transaction with the signature.
+    /// This state is temporary and will be updated to either Won or Failed after the transaction is included in a block, or Expired if the transaction expires before it is included.
+    #[schema(title = "Submitted")]
+    Submitted {
+        #[schema(example = "Jb2urXPyEh4xiBgzYvwEFe4q1iMxG1DNxWGGQg94AmKgqFTwLAiTiHrYiYxwHUB4DV8u5ahNEVtMMDm3sNSRdTg", value_type = String)]
+        #[serde_as(as = "DisplayFromStr")]
+        result: Signature,
+    },
+    /// The bid won the auction and was included in a block successfully.
+    #[schema(title = "Won")]
+    Won {
+        #[schema(example = "Jb2urXPyEh4xiBgzYvwEFe4q1iMxG1DNxWGGQg94AmKgqFTwLAiTiHrYiYxwHUB4DV8u5ahNEVtMMDm3sNSRdTg", value_type = String)]
+        #[serde_as(as = "DisplayFromStr")]
+        result: Signature,
+    },
+    /// The bid was submitted on-chain, was included in a block, but resulted in a failed transaction.
+    #[schema(title = "Failed")]
+    Failed {
+        #[schema(example = "Jb2urXPyEh4xiBgzYvwEFe4q1iMxG1DNxWGGQg94AmKgqFTwLAiTiHrYiYxwHUB4DV8u5ahNEVtMMDm3sNSRdTg", value_type = String)]
+        #[serde_as(as = "DisplayFromStr")]
+        result: Signature,
+    },
+    /// The bid was submitted on-chain but expired before it was included in a block.
+    #[schema(title = "Expired")]
+    Expired {
+        #[schema(example = "Jb2urXPyEh4xiBgzYvwEFe4q1iMxG1DNxWGGQg94AmKgqFTwLAiTiHrYiYxwHUB4DV8u5ahNEVtMMDm3sNSRdTg", value_type = String)]
+        #[serde_as(as = "DisplayFromStr")]
+        result: Signature,
+    },
+}
+
+#[derive(Serialize, Deserialize, ToSchema, Clone, PartialEq, Debug)]
+#[serde(untagged)]
+pub enum BidStatus {
+    Evm(BidStatusEvm),
+    Svm(BidStatusSvm),
+}
+
+#[derive(Serialize, Deserialize, ToResponse, ToSchema, Clone)]
+pub struct BidResult {
+    /// The status of the request. If the bid was placed successfully, the status will be "OK".
+    #[schema(example = "OK")]
+    pub status: String,
+    /// The unique id created to identify the bid. This id can be used to query the status of the bid.
+    #[schema(example = "beedbeed-58cc-4372-a567-0e02b2c3d479", value_type=String)]
+    pub id:     BidId,
+}
+
+#[derive(Clone, Debug, ToSchema, Serialize, Deserialize)]
+pub struct BidCoreFields {
+    /// The unique id for bid.
+    #[schema(example = "obo3ee3e-58cc-4372-a567-0e02b2c3d479", value_type = String)]
+    pub id:              BidId,
+    /// The chain id for bid.
+    #[schema(example = "op_sepolia", value_type = String)]
+    pub chain_id:        ChainId,
+    /// The time server received the bid formatted in rfc3339.
+    #[schema(example = "2024-05-23T21:26:57.329954Z", value_type = String)]
+    #[serde(with = "time::serde::rfc3339")]
+    pub initiation_time: OffsetDateTime,
+    /// The profile id for the bid owner.
+    #[schema(example = "obo3ee3e-58cc-4372-a567-0e02b2c3d479", value_type = String)]
+    pub profile_id:      Option<ProfileId>,
+}
+
+#[derive(Clone, Debug, ToSchema, Serialize, Deserialize)]
+pub struct BidSvm {
+    #[serde(flatten)]
+    #[schema(inline)]
+    pub core_fields:    BidCoreFields,
+    /// The latest status for bid.
+    pub status:         BidStatusSvm,
+    /// The transaction of the bid.
+    #[schema(example = "SGVsbG8sIFdvcmxkIQ==", value_type = String)]
+    #[serde(with = "crate::serde::transaction_svm")]
+    pub transaction:    VersionedTransaction,
+    /// Amount of bid in lamports.
+    #[schema(example = "1000", value_type = u64)]
+    pub bid_amount:     BidAmountSvm,
+    /// The permission key for bid in base64 format.
+    /// This is the concatenation of the permission account and the router account.
+    #[schema(example = "DUcTi3rDyS5QEmZ4BNRBejtArmDCWaPYGfN44vBJXKL5", value_type = String)]
+    pub permission_key: PermissionKeySvm,
+}
+
+#[derive(Clone, Debug, ToSchema, Serialize, Deserialize)]
+pub struct BidEvm {
+    #[serde(flatten)]
+    #[schema(inline)]
+    pub core_fields:     BidCoreFields,
+    /// The latest status for bid.
+    pub status:          BidStatusEvm,
+    /// The contract address to call.
+    #[schema(example = "0xcA11bde05977b3631167028862bE2a173976CA11", value_type = String)]
+    pub target_contract: Address,
+    /// Calldata for the contract call.
+    #[schema(example = "0xdeadbeef", value_type = String)]
+    pub target_calldata: Bytes,
+    /// The gas limit for the contract call.
+    #[schema(example = "2000000", value_type = String)]
+    #[serde(with = "crate::serde::u256")]
+    pub gas_limit:       U256,
+    /// Amount of bid in wei.
+    #[schema(example = "10", value_type = String)]
+    #[serde(with = "crate::serde::u256")]
+    pub bid_amount:      BidAmountEvm,
+    /// The permission key for bid.
+    #[schema(example = "0xdeadbeef", value_type = String)]
+    pub permission_key:  PermissionKeyEvm,
+}
+
+#[derive(Clone, Debug, ToSchema, Serialize, Deserialize)]
+#[serde(untagged)]
+#[allow(clippy::large_enum_variant)]
+pub enum Bid {
+    Evm(BidEvm),
+    Svm(BidSvm),
+}
+
+impl Bid {
+    pub fn get_initiation_time(&self) -> OffsetDateTime {
+        match self {
+            Bid::Evm(bid) => bid.core_fields.initiation_time,
+            Bid::Svm(bid) => bid.core_fields.initiation_time,
+        }
+    }
+
+    pub fn get_status(&self) -> BidStatus {
+        match self {
+            Bid::Evm(bid) => BidStatus::Evm(bid.status.clone()),
+            Bid::Svm(bid) => BidStatus::Svm(bid.status.clone()),
+        }
+    }
+}
+
+#[derive(Serialize, Deserialize, ToSchema, Clone, Debug)]
+pub struct BidCreateEvm {
+    /// The permission key to bid on.
+    #[schema(example = "0xdeadbeef", value_type = String)]
+    pub permission_key:  PermissionKeyEvm,
+    /// The chain id to bid on.
+    #[schema(example = "op_sepolia", value_type = String)]
+    pub chain_id:        ChainId,
+    /// The contract address to call.
+    #[schema(example = "0xcA11bde05977b3631167028862bE2a173976CA11", value_type = String)]
+    pub target_contract: Address,
+    /// Calldata for the contract call.
+    #[schema(example = "0xdeadbeef", value_type = String)]
+    pub target_calldata: Bytes,
+    /// Amount of bid in wei.
+    #[schema(example = "10", value_type = String)]
+    #[serde(with = "crate::serde::u256")]
+    pub amount:          BidAmountEvm,
+}
+
+#[derive(Serialize, Deserialize, ToSchema, Clone, Debug)]
+pub struct BidCreateSvm {
+    /// The chain id to bid on.
+    #[schema(example = "solana", value_type = String)]
+    pub chain_id:    ChainId,
+    /// The transaction for bid.
+    #[schema(example = "SGVsbG8sIFdvcmxkIQ==", value_type = String)]
+    #[serde(with = "crate::serde::transaction_svm")]
+    pub transaction: VersionedTransaction,
+}
+
+#[derive(Serialize, Deserialize, ToSchema, Debug, Clone)]
+#[serde(untagged)] // Remove tags to avoid key-value wrapping
+pub enum BidCreate {
+    Evm(BidCreateEvm),
+    Svm(BidCreateSvm),
+}
+
+#[derive(Serialize, Clone, ToSchema, ToResponse)]
+pub struct BidStatusWithId {
+    #[schema(value_type = String)]
+    pub id:         BidId,
+    pub bid_status: BidStatus,
+}
+
+#[derive(Serialize, Deserialize, IntoParams, Clone)]
+pub struct GetBidStatusParams {
+    #[param(example="op_sepolia", value_type = String)]
+    pub chain_id: ChainId,
+
+    #[param(example="obo3ee3e-58cc-4372-a567-0e02b2c3d479", value_type = String)]
+    pub bid_id: BidId,
+}
+
+#[derive(Serialize, Deserialize, ToResponse, ToSchema, Clone)]
+pub struct Bids {
+    pub items: Vec<Bid>,
+}
+
+#[derive(Serialize, Deserialize, IntoParams)]
+pub struct GetBidsByTimeQueryParams {
+    #[param(example="2024-05-23T21:26:57.329954Z", value_type = Option<String>)]
+    #[serde(default, with = "crate::serde::nullable_datetime")]
+    pub from_time: Option<OffsetDateTime>,
+}
+
+impl BidCreate {
+    pub fn get_chain_id(&self) -> ChainId {
+        match self {
+            BidCreate::Evm(bid_create_evm) => bid_create_evm.chain_id.clone(),
+            BidCreate::Svm(bid_create_svm) => bid_create_svm.chain_id.clone(),
+        }
+    }
+}