types: add unresolved transaction builder types

Author: bmwill

src/lib.rs

@@ -15,6 +15,9 @@ mod _serde {
     pub(crate) type ReadableDisplay =
         ::serde_with::As<::serde_with::IfIsHumanReadable<::serde_with::DisplayFromStr>>;
 
+    pub(crate) type OptionReadableDisplay =
+        ::serde_with::As<Option<::serde_with::IfIsHumanReadable<::serde_with::DisplayFromStr>>>;
+
     pub(crate) type ReadableBase64Encoded =
         ::serde_with::As<::serde_with::IfIsHumanReadable<Base64Encoded, ::serde_with::Bytes>>;
 

src/types/mod.rs

@@ -49,6 +49,8 @@ pub use transaction::{
     ConsensusCommitPrologue, ConsensusCommitPrologueV2, EndOfEpochTransactionKind, GasPayment,
     GenesisTransaction, InputArgument, MakeMoveVector, MergeCoins, MoveCall,
     ProgrammableTransaction, Publish, RandomnessStateUpdate, SignedTransaction, SplitCoins,
-    SystemPackage, Transaction, TransactionExpiration, TransactionKind, TransferObjects, Upgrade,
+    SystemPackage, Transaction, TransactionExpiration, TransactionKind, TransferObjects,
+    UnresolvedGasPayment, UnresolvedInputArgument, UnresolvedObjectReference,
+    UnresolvedProgrammableTransaction, UnresolvedTransaction, Upgrade,
 };
 pub use type_tag::{Identifier, StructTag, TypeParseError, TypeTag};

src/types/transaction/mod.rs

@@ -7,6 +7,12 @@ use super::{
 #[cfg_attr(doc_cfg, doc(cfg(feature = "serde")))]
 mod serialization;
 
+mod unresolved;
+pub use unresolved::{
+    UnresolvedGasPayment, UnresolvedInputArgument, UnresolvedObjectReference,
+    UnresolvedProgrammableTransaction, UnresolvedTransaction,
+};
+
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct Transaction {
     pub kind: TransactionKind,

src/types/transaction/unresolved.rs

@@ -0,0 +1,88 @@
+use crate::types::{object::Version, Address, ObjectDigest, ObjectId};
+
+use super::{Command, TransactionExpiration};
+
+// A potentially Unresolved user transaction
+#[cfg_attr(
+    feature = "serde",
+    derive(serde_derive::Serialize, serde_derive::Deserialize)
+)]
+pub struct UnresolvedTransaction {
+    #[cfg_attr(feature = "serde", serde(flatten))]
+    pub ptb: UnresolvedProgrammableTransaction,
+    pub sender: Address,
+    pub gas_payment: Option<UnresolvedGasPayment>,
+    pub expiration: TransactionExpiration,
+}
+
+#[cfg_attr(
+    feature = "serde",
+    derive(serde_derive::Serialize, serde_derive::Deserialize)
+)]
+pub struct UnresolvedProgrammableTransaction {
+    pub inputs: Vec<UnresolvedInputArgument>,
+    pub commands: Vec<Command>,
+}
+
+#[cfg_attr(
+    feature = "serde",
+    derive(serde_derive::Serialize, serde_derive::Deserialize)
+)]
+pub struct UnresolvedGasPayment {
+    pub objects: Vec<UnresolvedObjectReference>,
+    pub owner: Address,
+    #[cfg_attr(
+        feature = "serde",
+        serde(with = "crate::_serde::OptionReadableDisplay")
+    )]
+    pub price: Option<u64>,
+    #[cfg_attr(
+        feature = "serde",
+        serde(with = "crate::_serde::OptionReadableDisplay")
+    )]
+    pub budget: Option<u64>,
+}
+
+#[cfg_attr(
+    feature = "serde",
+    derive(serde_derive::Serialize, serde_derive::Deserialize)
+)]
+pub struct UnresolvedObjectReference {
+    pub object_id: ObjectId,
+    #[cfg_attr(
+        feature = "serde",
+        serde(with = "crate::_serde::OptionReadableDisplay")
+    )]
+    pub version: Option<Version>,
+    pub digest: Option<ObjectDigest>,
+}
+
+#[cfg_attr(
+    feature = "serde",
+    derive(serde_derive::Serialize, serde_derive::Deserialize)
+)]
+pub enum UnresolvedInputArgument {
+    // contains no structs or objects
+    Pure {
+        #[cfg_attr(
+            feature = "serde",
+            serde(with = "::serde_with::As::<::serde_with::Bytes>")
+        )]
+        value: Vec<u8>,
+    },
+    // A Move object, either immutable, or owned mutable.
+    ImmutableOrOwned(UnresolvedObjectReference),
+    // A Move object that's shared.
+    // SharedObject::mutable controls whether caller asks for a mutable reference to shared object.
+    Shared {
+        object_id: ObjectId,
+        #[cfg_attr(
+            feature = "serde",
+            serde(with = "crate::_serde::OptionReadableDisplay")
+        )]
+        initial_shared_version: Option<u64>,
+        mutable: Option<bool>,
+    },
+    // A Move object that can be received in this transaction.
+    Receiving(UnresolvedObjectReference),
+}