SigningInput class

Input data necessary to create a signed transaction.

Inheritance
  • Object
  • GeneratedMessage
  • SigningInput
Available extensions

Constructors

SigningInput({List<int>? privateKey, String? recentBlockhash, bool? v0Msg, Transfer? transferTransaction, DelegateStake? delegateStakeTransaction, DeactivateStake? deactivateStakeTransaction, DeactivateAllStake? deactivateAllStakeTransaction, WithdrawStake? withdrawTransaction, WithdrawAllStake? withdrawAllTransaction, CreateTokenAccount? createTokenAccountTransaction, TokenTransfer? tokenTransferTransaction, CreateAndTransferToken? createAndTransferTokenTransaction, CreateNonceAccount? createNonceAccount, String? sender, String? nonceAccount, WithdrawNonceAccount? withdrawNonceAccount, List<int>? feePayerPrivateKey, String? feePayer, AdvanceNonceAccount? advanceNonceAccount, RawMessage? rawMessage, Encoding? txEncoding, PriorityFeePrice? priorityFeePrice, PriorityFeeLimit? priorityFeeLimit, TokenTransferToFeePayer? tokenTransferToFeePayer, Transfer? transferToFeePayer})
factory
SigningInput.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
SigningInput.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

advanceNonceAccount ↔ AdvanceNonceAccount
getter/setter pair
createAndTransferTokenTransaction ↔ CreateAndTransferToken
getter/setter pair
createNonceAccount ↔ CreateNonceAccount
getter/setter pair
createTokenAccountTransaction ↔ CreateTokenAccount
getter/setter pair
deactivateAllStakeTransaction ↔ DeactivateAllStake
getter/setter pair
deactivateStakeTransaction ↔ DeactivateStake
getter/setter pair
delegateStakeTransaction ↔ DelegateStake
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
feePayer ↔ String
Optional external fee payer. support: TokenTransfer, CreateAndTransferToken
getter/setter pair
feePayerPrivateKey ↔ List<int>
Optional external fee payer private key. support: TokenTransfer, CreateAndTransferToken
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
nonceAccount ↔ String
Required for using durable transaction nonce
getter/setter pair
priorityFeeLimit ↔ PriorityFeeLimit
Optional. Set a compute unit price in "micro-lamports" to pay a higher transaction fee for higher transaction prioritization. https://solana.com/docs/intro/transaction_fees#prioritization-fee
getter/setter pair
priorityFeePrice ↔ PriorityFeePrice
Optional. Set a specific compute unit limit that the transaction is allowed to consume. https://solana.com/docs/intro/transaction_fees#prioritization-fee
getter/setter pair
privateKey ↔ List<int>
The secret private key used for signing (32 bytes).
getter/setter pair
rawMessage ↔ RawMessage
Optional message plan. For signing an already prepared message.
getter/setter pair
recentBlockhash ↔ String
Relatively recent block hash
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sender ↔ String
Required for building pre-signing hash of a transaction
getter/setter pair
tokenTransferToFeePayer ↔ TokenTransferToFeePayer
Optional token transfer to fee payer.
getter/setter pair
tokenTransferTransaction ↔ TokenTransfer
getter/setter pair
transferToFeePayer ↔ Transfer
Optional SOL transfer to fee payer. This will be the last instruction in the transaction. https://docs.blinklabs.xyz/blink/solana/gas-sponsorship/api-reference#active-sponsorship
getter/setter pair
transferTransaction ↔ Transfer
getter/setter pair
txEncoding ↔ Encoding
Output transaction encoding.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
v0Msg ↔ bool
getter/setter pair
withdrawAllTransaction ↔ WithdrawAllStake
getter/setter pair
withdrawNonceAccount ↔ WithdrawNonceAccount
getter/setter pair
withdrawTransaction ↔ WithdrawStake
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
clearAdvanceNonceAccount() → void
clearCreateAndTransferTokenTransaction() → void
clearCreateNonceAccount() → void
clearCreateTokenAccountTransaction() → void
clearDeactivateAllStakeTransaction() → void
clearDeactivateStakeTransaction() → void
clearDelegateStakeTransaction() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearFeePayer() → void
clearFeePayerPrivateKey() → void
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearNonceAccount() → void
clearPriorityFeeLimit() → void
clearPriorityFeePrice() → void
clearPrivateKey() → void
clearRawMessage() → void
clearRecentBlockhash() → void
clearSender() → void
clearTokenTransferToFeePayer() → void
clearTokenTransferTransaction() → void
clearTransactionType() → void
clearTransferToFeePayer() → void
clearTransferTransaction() → void
clearTxEncoding() → void
clearV0Msg() → void
clearWithdrawAllTransaction() → void
clearWithdrawNonceAccount() → void
clearWithdrawTransaction() → void
clone() → SigningInput
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
compileWithSignatures({TWCoinType coin = TWCoinType.Solana, required List<Uint8List> signatures, required List<Uint8List> publicKeys, TWPublicKeyType? pubKeyType}) → SigningOutput

Available on SigningInput, provided by the TWSolanaExtension 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. \return Solana SigningOutput proto object.
copyWith(void updates(SigningInput)) → SigningInput
Apply updates to a copy of this message.
override
createEmptyInstance() → SigningInput
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
ensureAdvanceNonceAccount() → AdvanceNonceAccount
ensureCreateAndTransferTokenTransaction() → CreateAndTransferToken
ensureCreateNonceAccount() → CreateNonceAccount
ensureCreateTokenAccountTransaction() → CreateTokenAccount
ensureDeactivateAllStakeTransaction() → DeactivateAllStake
ensureDeactivateStakeTransaction() → DeactivateStake
ensureDelegateStakeTransaction() → DelegateStake
ensurePriorityFeeLimit() → PriorityFeeLimit
ensurePriorityFeePrice() → PriorityFeePrice
ensureRawMessage() → RawMessage
ensureTokenTransferToFeePayer() → TokenTransferToFeePayer
ensureTokenTransferTransaction() → TokenTransfer
ensureTransferToFeePayer() → Transfer
ensureTransferTransaction() → Transfer
ensureWithdrawAllTransaction() → WithdrawAllStake
ensureWithdrawNonceAccount() → WithdrawNonceAccount
ensureWithdrawTransaction() → WithdrawStake
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
hasAdvanceNonceAccount() → bool
hasCreateAndTransferTokenTransaction() → bool
hasCreateNonceAccount() → bool
hasCreateTokenAccountTransaction() → bool
hasDeactivateAllStakeTransaction() → bool
hasDeactivateStakeTransaction() → bool
hasDelegateStakeTransaction() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasFeePayer() → bool
hasFeePayerPrivateKey() → bool
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasNonceAccount() → bool
hasPriorityFeeLimit() → bool
hasPriorityFeePrice() → bool
hasPrivateKey() → bool
hasRawMessage() → bool
hasRecentBlockhash() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasSender() → bool
hasTokenTransferToFeePayer() → bool
hasTokenTransferTransaction() → bool
hasTransferToFeePayer() → bool
hasTransferTransaction() → bool
hasTxEncoding() → bool
hasV0Msg() → bool
hasWithdrawAllTransaction() → bool
hasWithdrawNonceAccount() → bool
hasWithdrawTransaction() → 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
preImageHashes([TWCoinType coin = TWCoinType.Solana]) → PreSigningOutput

Available on SigningInput, provided by the TWSolanaExtension extension

Obtain pre-signing hashes of a transaction. \param coin coin type \return Solana PreSigningOutput proto object.
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
sign([TWCoinType coin = TWCoinType.Solana]) → SigningOutput

Available on SigningInput, provided by the TWSolanaExtension extension

Sign \param coin coin type \return Solana SigningOutput proto object.
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
whichTransactionType() → SigningInput_TransactionType
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() → SigningInput
createRepeated() → PbList<SigningInput>
getDefault() → SigningInput