Transaction Structure Reference


                    
                    
                    script

A valid cadence script.

Declaration

Swift

public var script: Script

Show on GitHub


                    
                    
                    arguments

Any arguments to the script if needed should be supplied via a function that returns an array of arguments.

Declaration

Swift

public var arguments: [Argument]

Show on GitHub


                    
                    
                    referenceBlockId

The ID of the block to execute the interaction at.

Declaration

Swift

public var referenceBlockId: ID

Show on GitHub


                    
                    
                    gasLimit

Compute (Gas) limit for query. Read the documentation about computation cost for information about how computation cost is calculated on Flow. More detail here: https://docs.onflow.org/flow-go-sdk/building-transactions/#gas-limit

Declaration

Swift

public var gasLimit: BigUInt

Show on GitHub


                    
                    
                    proposalKey

The valid key of proposer role.

Declaration

Swift

public var proposalKey: TransactionProposalKey

Show on GitHub


                    
                    
                    payer

The address of payer

Declaration

Swift

public var payer: Address

Show on GitHub


                    
                    
                    authorizers

The list of authorizer’s address

Declaration

Swift

public var authorizers: [Address]

Show on GitHub


                    
                    
                    payloadSignatures

The list of payload signature

Declaration

Swift

public var payloadSignatures: [TransactionSignature]

Show on GitHub


                    
                    
                    envelopeSignatures

The list of envelope signature

Declaration

Swift

public var envelopeSignatures: [TransactionSignature]

Show on GitHub


                    
                    
                    init(script:arguments:referenceBlockId:gasLimit:proposalKey:payer:authorizers:payloadSignatures:envelopeSignatures:)

Declaration

Swift

public init(script: Flow.Script,
            arguments: [Flow.Argument],
            referenceBlockId: Flow.ID,
            gasLimit: BigUInt,
            proposalKey: Flow.TransactionProposalKey,
            payer: Flow.Address,
            authorizers: [Flow.Address],
            payloadSignatures: [Flow.TransactionSignature] = [],
            envelopeSignatures: [Flow.TransactionSignature] = [])

Show on GitHub


                    
                    
                    init(script:arguments:referenceBlockId:gasLimit:proposalKey:payer:authorizers:payloadSignatures:envelopeSignatures:)

Declaration

Swift

public init(script: Flow.Script,
            arguments: [Flow.Argument],
            referenceBlockId: Flow.ID,
            gasLimit: UInt64,
            proposalKey: Flow.TransactionProposalKey,
            payer: Flow.Address,
            authorizers: [Flow.Address],
            payloadSignatures: [Flow.TransactionSignature] = [],
            envelopeSignatures: [Flow.TransactionSignature] = [])

Show on GitHub


                    
                    
                    buildUpOn(script:arguments:referenceBlockId:gasLimit:proposalKey:payer:authorizers:payloadSignatures:envelopeSignatures:)

Declaration

Swift

public func buildUpOn(script: Flow.Script? = nil,
                      arguments: [Flow.Argument]? = nil,
                      referenceBlockId: Flow.ID? = nil,
                      gasLimit: BigUInt? = nil,
                      proposalKey: Flow.TransactionProposalKey? = nil,
                      payer: Flow.Address? = nil,
                      authorizers: [Flow.Address]? = nil,
                      payloadSignatures: [Flow.TransactionSignature]? = nil,
                      envelopeSignatures: [Flow.TransactionSignature]? = nil) -> Transaction

Show on GitHub


                    
                    
                    encodedEnvelope

RLP Encoded data of Envelope

Declaration

Swift

public var encodedEnvelope: Data? { get }

Show on GitHub


                    
                    
                    envelopeMessage

RLP Encoded data of Envelope in hex string

Declaration

Swift

public var envelopeMessage: String? { get }

Show on GitHub


                    
                    
                    signableEnvelope

RLP Encoded data of Envelope with DomainTag.transaction prefix

Declaration

Swift

public var signableEnvelope: Data? { get }

Show on GitHub


                    
                    
                    encodedPayload

RLP Encoded data of Payload

Declaration

Swift

public var encodedPayload: Data? { get }

Show on GitHub


                    
                    
                    payloadMessage

RLP Encoded data of Payload in hex string

Declaration

Swift

public var payloadMessage: String? { get }

Show on GitHub


                    
                    
                    signablePlayload

RLP Encoded data of Payload with DomainTag.transaction prefix

Declaration

Swift

public var signablePlayload: Data? { get }

Show on GitHub


                    
                    
                    addPayloadSignature(_:)

Declaration

Swift

public mutating func addPayloadSignature(_ signature: TransactionSignature)

Show on GitHub


                    
                    
                    addPayloadSignature(address:keyIndex:signature:)

Declaration

Swift

public mutating func addPayloadSignature(address: Address, keyIndex: Int, signature: Data)

Show on GitHub


                    
                    
                    addEnvelopeSignature(address:keyIndex:signature:)

Declaration

Swift

public mutating func addEnvelopeSignature(address: Address, keyIndex: Int, signature: Data)

Show on GitHub


                    
                    
                    addEnvelopeSignature(_:)

Declaration

Swift

public mutating func addEnvelopeSignature(_ signature: TransactionSignature)

Show on GitHub


                    
                    
                    encode(to:)

Declaration

Swift

public func encode(to encoder: Encoder) throws

Show on GitHub


                    
                    
                    init(from:)

Declaration

Swift

public init(from decoder: Decoder) throws

Show on GitHub


                    
                    
                    signPayload(signers:)

Asynchronous

Sign transaction payload with provided signers

Throws

Signing errors if validation fails

Declaration

Swift

@discardableResult
mutating func signPayload(signers: [FlowSigner]) async throws -> Flow.Transaction

Parameters


                                signers

List of accounts that will sign

Return Value

Transaction with payload signatures

Show on GitHub


                    
                    
                    signEnvelope(signers:)

Asynchronous

Sign transaction envelope with payer

Throws

Signing errors if validation fails

Declaration

Swift

@discardableResult
mutating func signEnvelope(signers: [FlowSigner]) async throws -> Flow.Transaction

Parameters


                                signers

List of accounts that will sign

Return Value

Transaction with envelope signatures

Show on GitHub


                    
                    
                    sign(signers:)

Asynchronous

Sign (Mutate) unsigned Flow Transaction with a list of FlowSigner

Declaration

Swift

@discardableResult
mutating func sign(signers: [FlowSigner]) async throws -> Flow.Transaction

Parameters


                                signers

A list of FlowSigner to sign the transaction

Return Value

The Flow.Transaction itself.

Show on GitHub


                    
                    
                    Status

The transaction status

Declaration

Swift

public enum Status : Int, CaseIterable, Comparable, Equatable, Codable

Show on GitHub