[−][src]Struct grin_wallet_libwallet::api_impl::types::InitTxArgs
V2 Init / Send TX API Args
Fields
src_acct_name: Option<String>
The human readable account name from which to draw outputs
for the transaction, overriding whatever the active account is as set via the
set_active_account
method.
amount: u64
The amount to send, in nanogrins. (1 G = 1_000_000_000nG
)
minimum_confirmations: u64
The minimum number of confirmations an output should have in order to be included in the transaction.
max_outputs: u32
By default, the wallet selects as many inputs as possible in a
transaction, to reduce the Output set and the fees. The wallet will attempt to spend
include up to max_outputs
in a transaction, however if this is not enough to cover
the whole amount, the wallet will include more outputs. This parameter should be considered
a soft limit.
num_change_outputs: u32
The target number of change outputs to create in the transaction.
The actual number created will be num_change_outputs
+ whatever remainder is needed.
selection_strategy_is_use_all: bool
If true
, attempt to use up as many outputs as
possible to create the transaction, up the 'soft limit' of max_outputs
. This helps
to reduce the size of the UTXO set and the amount of data stored in the wallet, and
minimizes fees. This will generally result in many inputs and a large change output(s),
usually much larger than the amount being sent. If false
, the transaction will include
as many outputs as are needed to meet the amount, (and no more) starting with the smallest
value outputs.
message: Option<String>
An optional participant message to include alongside the sender's public ParticipantData within the slate. This message will include a signature created with the sender's private excess value, and will be publically verifiable. Note this message is for the convenience of the participants during the exchange; it is not included in the final transaction sent to the chain. The message will be truncated to 256 characters.
target_slate_version: Option<u16>
Optionally set the output target slate version (acceptable
down to the minimum slate version compatible with the current. If None
the slate
is generated with the latest version.
ttl_blocks: Option<u64>
Number of blocks from current after which TX should be ignored
payment_proof_recipient_address: Option<OnionV3Address>
If set, require a payment proof for the particular recipient
estimate_only: Option<bool>
If true, just return an estimate of the resulting slate, containing fees and amounts locked without actually locking outputs or creating the transaction. Note if this is set to 'true', the amount field in the slate will contain the total amount locked, not the provided transaction amount
send_args: Option<InitTxSendArgs>
Sender arguments. If present, the underlying function will also attempt to send the transaction to a destination and optionally finalize the result
Trait Implementations
impl Clone for InitTxArgs
[src]
fn clone(&self) -> InitTxArgs
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Default for InitTxArgs
[src]
fn default() -> InitTxArgs
[src]
impl<'de> Deserialize<'de> for InitTxArgs
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Serialize for InitTxArgs
[src]
Auto Trait Implementations
impl RefUnwindSafe for InitTxArgs
impl Send for InitTxArgs
impl Sync for InitTxArgs
impl Unpin for InitTxArgs
impl UnwindSafe for InitTxArgs
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Clear for T where
T: InitializableFromZeroed + ?Sized,
T: InitializableFromZeroed + ?Sized,
fn clear(&mut self)
impl<T> CloneAny for T where
T: Clone + Any,
T: Clone + Any,
fn clone_any(&self) -> Box<dyn CloneAny + 'static>
fn clone_any_send(&self) -> Box<dyn CloneAny + 'static + Send> where
T: Send,
T: Send,
fn clone_any_sync(&self) -> Box<dyn CloneAny + 'static + Sync> where
T: Sync,
T: Sync,
fn clone_any_send_sync(&self) -> Box<dyn CloneAny + 'static + Sync + Send> where
T: Send + Sync,
T: Send + Sync,
impl<'a, T> DefaultFeatures<'a> for T where
T: 'a + Clone + Send + Sync,
T: 'a + Clone + Send + Sync,
fn clone_boxed(&self) -> Box<dyn DefaultFeatures<'a> + 'a>
fn self_address_mut(&mut self) -> *mut ()
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> Erased for T
impl<T> From<T> for T
[src]
impl<T> InitializableFromZeroed for T where
T: Default,
T: Default,
unsafe fn initialize(place: *mut T)
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<'a, T> NonSyncFeatures<'a> for T where
T: 'a + Clone,
T: 'a + Clone,
fn clone_boxed(&self) -> Box<dyn NonSyncFeatures<'a> + 'a>
fn self_address_mut(&mut self) -> *mut ()
impl<T> SafeBorrow<T> for T where
T: ?Sized,
T: ?Sized,
fn borrow_replacement(ptr: &T) -> &T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> UnsafeAny for T where
T: Any,
T: Any,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,