Skip to content

Commit 803fd19

Browse files
authored
feat: update bid status text to match docs (#282)
* go * improve
1 parent 69eb2ba commit 803fd19

File tree

1 file changed

+4
-4
lines changed
  • auction-server/src/auction

1 file changed

+4
-4
lines changed

auction-server/src/auction/api.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,19 +139,19 @@ pub enum BidStatusEvm {
139139
#[serde(tag = "type", rename_all = "snake_case")]
140140
pub enum BidStatusSvm {
141141
/// The temporary state which means the auction for this bid is pending.
142+
/// It will be updated to Lost or Submitted after the auction takes place.
142143
#[schema(title = "Pending")]
143144
Pending,
144145
/// The bid lost the auction.
145-
/// The result will be None if the auction does not result in a transaction being submitted to the chain.
146-
/// The result will be Some if this bid lost to another bid and the winning bid was submitted to the chain.
147-
/// The signature of the transaction for the submitted bid is the result value.
146+
/// This bid status will have a result field containing the signature of the transaction corresponding to the winning bid,
147+
/// unless the auction had no winner (because all bids were found to be invalid).
148148
#[schema(title = "Lost")]
149149
Lost {
150150
#[schema(example = "Jb2urXPyEh4xiBgzYvwEFe4q1iMxG1DNxWGGQg94AmKgqFTwLAiTiHrYiYxwHUB4DV8u5ahNEVtMMDm3sNSRdTg", value_type = Option<String>)]
151151
#[serde(with = "crate::serde::nullable_signature_svm")]
152152
result: Option<Signature>,
153153
},
154-
/// The bid won the auction and was submitted to the chain, with the transaction with the signature.
154+
/// The bid won the auction and was submitted to the chain, with the signature of the corresponding transaction provided in the result field.
155155
/// 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.
156156
#[schema(title = "Submitted")]
157157
Submitted {

0 commit comments

Comments
 (0)