SwapInput class

Input for a swap between source and destination chains; for creating a TX on the source chain.

Inheritance
  • Object
  • GeneratedMessage
  • SwapInput
Available extensions

Constructors

SwapInput.new({Asset? fromAsset, String? fromAddress, Asset? toAsset, String? toAddress, String? vaultAddress, String? routerAddress, String? fromAmount, String? toAmountLimit, String? affiliateFeeAddress, String? affiliateFeeRateBp, String? extraMemo, Int64? expirationTime, StreamParams? streamParams})
factory
SwapInput.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
SwapInput.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

affiliateFeeAddress ↔ String
Optional affiliate fee destination address. A Rune address.
getter/setter pair
affiliateFeeRateBp ↔ String
Optional affiliate fee, percentage base points, e.g. 100 means 1%, 0 - 1000, as string. Empty means to ignore it.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
expirationTime ↔ Int64
Optional expirationTime, will be now() + 15 min if not set
getter/setter pair
extraMemo ↔ String
Optional extra custom memo, reserved for later use.
getter/setter pair
fromAddress ↔ String
Source address, on source chain
getter/setter pair
fromAmount ↔ String
The source amount, integer as string, in the smallest native unit of the chain
getter/setter pair
fromAsset ↔ Asset
Source chain
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
routerAddress ↔ String
ThorChain router, only in case of Ethereum source network
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
streamParams ↔ StreamParams
Optional streaming parameters. Use Streaming Swaps and Swap Optimisation strategy if set. https://docs.thorchain.org/thorchain-finance/continuous-liquidity-pools#streaming-swaps-and-swap-optimisation
getter/setter pair
toAddress ↔ String
Destination address, on destination chain
getter/setter pair
toAmountLimit ↔ String
Optional minimum accepted destination amount. Actual destination amount will depend on current rates, limit amount can be used to prevent using very unfavorable rates. The default is 0 - no price limit.
getter/setter pair
toAsset ↔ Asset
Destination chain+asset, on destination chain
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
vaultAddress ↔ String
ThorChainSwap vault, on the source chain. Should be queried afresh, as it may change
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
anyCompileWithSignatures({required TWCoinType coin, required List<Uint8List> signatures, required List<Uint8List> publicKeys, TWPublicKeyType? pubKeyType}) → Uint8List

Available on GeneratedMessage, provided by the TWPreImageHashesExtension extension

Compiles a complete transation with one or more external signatures. \param coin coin type. \param signatures signatures to compile. \param publicKeys public keys for signers to match private keys. \param pubKeyType public key type. \return serialized data of a proto object SigningOutput.
anyCompileWithSignaturesToOutput<T extends GeneratedMessage>({required TWCoinType coin, required List<Uint8List> signatures, required List<Uint8List> publicKeys, TWPublicKeyType? pubKeyType, required T output}) → T

Available on GeneratedMessage, provided by the TWPreImageHashesExtension extension

Compiles a complete transation with one or more external signatures. \param coin coin type. \param signatures signatures to compile. \param publicKeys public keys for signers to match private keys. \param publicKeys public keys for signers to match private keys. \param pubKeyType public key type. \param output Empty SigningOutput proto object. \return output after serialization data is filled.
anyPlan(TWCoinType coin) → Uint8List

Available on GeneratedMessage, provided by the TWAnySignExtension extension

Any plan. \param coin coin type. \return The serialized data of a TransactionPlan proto object.
anyPlanToOutput<T extends GeneratedMessage>(TWCoinType coin, T output) → T

Available on GeneratedMessage, provided by the TWAnySignExtension extension

Any plan to output. \param coin coin type. \param output Empty TransactionPlan proto object. \return output after serialization data is filled.
anyPreImageHashes(TWCoinType coin) → Uint8List

Available on GeneratedMessage, provided by the TWPreImageHashesExtension extension

Obtain pre-signing hashes of a transaction. \param coin coin type. \return serialized data of a proto object PreSigningOutput includes hash.
anyPreImageHashesToOutput<T extends GeneratedMessage>(TWCoinType coin, T output) → T

Available on GeneratedMessage, provided by the TWPreImageHashesExtension extension

Obtain pre-signing hashes of a transaction. \param coin coin type. \param output Empty PreSigningOutput proto object. \return output after serialization data is filled.
anySign(TWCoinType coin) → Uint8List

Available on GeneratedMessage, provided by the TWAnySignExtension extension

Any sign. \param coin The given coin type to sign the transaction for. \return The serialized data of a SigningOutput proto object. (e.g. TW.Bitcoin.Proto.SigningOutput).
anySignToOutput<T extends GeneratedMessage>(TWCoinType coin, T output) → T

Available on GeneratedMessage, provided by the TWAnySignExtension extension

Any sign to output. \param coin coin type. \param output Empty SigningOutput proto object. (e.g. TW.Bitcoin.Proto.SigningOutput). \return output after serialization data is filled.
check() → void
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearAffiliateFeeAddress() → void
clearAffiliateFeeRateBp() → void
clearExpirationTime() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearExtraMemo() → void
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearFromAddress() → void
clearFromAmount() → void
clearFromAsset() → void
clearRouterAddress() → void
clearStreamParams() → void
clearToAddress() → void
clearToAmountLimit() → void
clearToAsset() → void
clearVaultAddress() → void
clone() → SwapInput
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(SwapInput)) → SwapInput
Apply updates to a copy of this message.
override
createEmptyInstance() → SwapInput
Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>
Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>
Creates List implementing a mutable repeated field.
inherited
ensureFromAsset() → Asset
ensureStreamParams() → StreamParams
ensureToAsset() → Asset
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasAffiliateFeeAddress() → bool
hasAffiliateFeeRateBp() → bool
hasExpirationTime() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasExtraMemo() → bool
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasFromAddress() → bool
hasFromAmount() → bool
hasFromAsset() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasRouterAddress() → bool
hasStreamParams() → bool
hasToAddress() → bool
hasToAmountLimit() → bool
hasToAsset() → bool
hasVaultAddress() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

create() → SwapInput
createRepeated() → PbList<SwapInput>
getDefault() → SwapInput