SigningInput class

Input data necessary to create a signed transaction.

Inheritance
  • Object
  • GeneratedMessage
  • SigningInput
Available extensions

Constructors

SigningInput({List<int>? chainId, List<int>? referenceBlockId, int? referenceBlockTime, String? currency, String? sender, String? recipient, String? memo, Asset? asset, List<int>? privateKey, KeyType? privateKeyType, int? expiration})
factory
SigningInput.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
SigningInput.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

asset Asset
Asset details and amount
getter/setter pair
chainId List<int>
Chain id (uint256, serialized big endian)
getter/setter pair
currency String
Currency (e.g. "eosio.token")
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
expiration int
Expiration of the transaction, if not set, default is reference_block_time + 3600 seconds
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
memo String
Memo attached to the transaction
getter/setter pair
privateKey List<int>
Sender's secret private key used for signing (32 bytes).
getter/setter pair
privateKeyType KeyType
Type of the private key
getter/setter pair
recipient String
Recipient's username
getter/setter pair
referenceBlockId List<int>
Reference Block Id (uint256, serialized big endian)
getter/setter pair
referenceBlockTime int
Timestamp on the reference block
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sender String
Sender's username
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited

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
clearAsset() → void
clearChainId() → void
clearCurrency() → void
clearExpiration() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearMemo() → void
clearPrivateKey() → void
clearPrivateKeyType() → void
clearRecipient() → void
clearReferenceBlockId() → void
clearReferenceBlockTime() → void
clearSender() → void
clone() SigningInput
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
compileWithSignatures({TWCoinType coin = TWCoinType.EOS, required List<Uint8List> signatures, required List<Uint8List> publicKeys, TWPublicKeyType? pubKeyType}) SigningOutput

Available on SigningInput, provided by the TWEOSExtension 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 EOS 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
ensureAsset() 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
hasAsset() bool
hasChainId() bool
hasCurrency() bool
hasExpiration() bool
hasExtension(Extension extension) bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) bool
Whether this message has a field associated with tagNumber.
inherited
hasMemo() bool
hasPrivateKey() bool
hasPrivateKeyType() bool
hasRecipient() bool
hasReferenceBlockId() bool
hasReferenceBlockTime() bool
hasRequiredFields() bool
Whether the message has required fields.
inherited
hasSender() 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.EOS]) PreSigningOutput

Available on SigningInput, provided by the TWEOSExtension extension

Obtain pre-signing hashes of a transaction. \param coin coin type \return TransactionCompiler 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.EOS]) SigningOutput

Available on SigningInput, provided by the TWEOSExtension extension

Sign \param coin coin type \return EOS 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
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