Flow Class Reference


                    
                    
                    configure(chainID:)

Config the chainID for Flow Swift SDK Default access client will be HTTP Client

For using default node:

    flow.configure(chainID: .testnet)

For custom node:

    let endpoint = Flow.ChainID.Endpoint(node: "flow-testnet.g.alchemy.com", port: 443)
    let chainID = Flow.ChainID.custom(name: "Alchemy-Testnet", endpoint:endpoint)
    flow.configure(chainID: chainID)

Declaration

Swift

public func configure(chainID: ChainID)

Parameters


                                chainID

The chain id to be configured.

Show on GitHub


                    
                    
                    configure(chainID:accessAPI:)

Config the chainID and accessNode for Flow Swift SDK

For using default node:

    flow.configure(chainID: .testnet)

For custom node:

    let accessAPI = Flow.GRPCAccessAPI(chainID: .mainnet)!
    let chainID = Flow.ChainID.mainnet
    flow.configure(chainID: chainID, accessAPI: accessAPI)

Declaration

Swift

public func configure(chainID: ChainID, accessAPI: FlowAccessProtocol)

Parameters


                                chainID

The chain id to be configured.

Show on GitHub


                    
                    
                    createHTTPAccessAPI(chainID:)

Create an access API client of Access by chainID

For using default node:

    let client = flow.createAccessAPI(chainID: .testnet)

For custom node:

    let endpoint = Flow.ChainID.Endpoint(node: "flow-testnet.g.alchemy.com", port: 443)
    let chainID = Flow.ChainID.custom(name: "Alchemy-Testnet", endpoint:endpoint)
    let client = flow.createAccessAPI(chainID: chainID)

Declaration

Swift

public func createHTTPAccessAPI(chainID: ChainID) -> FlowAccessProtocol

Parameters


                                chainID

The chain id to determine which gRPC node to connect.

Return Value

An AccessAPI client

Show on GitHub


                    
                    
                    TransactionBuild

The list of all the acceptable property

Declaration

Swift

enum TransactionBuild

Show on GitHub


                    
                    
                    TransactionBuilder

Use domain-specific language (DSL) to construct Flow.Transaction

Declaration

Swift

@resultBuilder
enum TransactionBuilder

Show on GitHub


                    
                    
                    buildTransaction(chainID:builder:)

Asynchronous

Build flow transaction using TransactionBuilder with async way

Declaration

Swift

func buildTransaction(chainID: Flow.ChainID = flow.chainID,
                      @Flow.TransactionBuilder builder: () -> [Flow.TransactionBuild]) async throws -> Flow.Transaction

Parameters

`chainID`	The chain id for the transaction, the default value is `flow.chainID`
`builder`	The list of `Flow.TransactionBuild`

Return Value

The type of EventLoopFuture<Flow.Transaction>

Show on GitHub


                    
                    
                    buildTransaction(chainID:script:agrument:authorizer:payerAddress:proposerKey:limit:blockID:)

Asynchronous

Build flow transaction using standard Flow.Transaction with async way

Declaration

Swift

func buildTransaction(chainID: Flow.ChainID = flow.chainID,
                      script: String,
                      agrument: [Flow.Argument] = [],
                      authorizer: [Flow.Address] = [],
                      payerAddress: Flow.Address,
                      proposerKey: Flow.TransactionProposalKey,
                      limit: BigUInt = BigUInt(9999),
                      blockID: Flow.ID?) async throws -> Flow.Transaction

Parameters


                                chainID

The chain id for the transaction, the default value is flow.chainID

Return Value

The type of EventLoopFuture<Flow.Transaction>

Show on GitHub


                    
                    
                    sendTransaction(chainID:signedTransaction:)

Asynchronous

Send signed Transaction to the network

Declaration

Swift

func sendTransaction(chainID _: ChainID = flow.chainID, signedTransaction: Transaction) async throws -> Flow.ID

Parameters

`chainID`	The chain id for the transaction, the default value is `flow.chainID`
`signedTransaction`	The signed Flow transaction

Return Value

A future value of transaction id

Show on GitHub


                    
                    
                    sendTransaction(chainID:signers:builder:)

Asynchronous

Build, sign and send transaction to the network

Declaration

Swift

func sendTransaction(chainID: Flow.ChainID = flow.chainID,
                     signers: [FlowSigner],
                     @Flow.TransactionBuilder builder: () -> [Flow.TransactionBuild]) async throws -> Flow.ID

Parameters

`chainID`	The chain id for the transaction, the default value is `flow.chainID`
`signers`	A list of `FlowSigner`, which will sign the transaction
`builder`	The list of `Flow.TransactionBuild`

Return Value

The transaction id

Show on GitHub


                    
                    
                    sendTransaction(chainID:signers:script:agrument:authorizer:payerAddress:proposerKey:limit:blockID:)

Asynchronous

Build, sign and send transaction to the network

Declaration

Swift

func sendTransaction(chainID: Flow.ChainID = flow.chainID,
                     signers: [FlowSigner],
                     script: String,
                     agrument: [Flow.Argument] = [],
                     authorizer: [Flow.Address] = [],
                     payerAddress: Flow.Address,
                     proposerKey: Flow.TransactionProposalKey,
                     limit: BigUInt = BigUInt(9999),
                     blockID: Flow.ID?) async throws -> Flow.ID

Parameters

`chainID`	The chain id for the transaction, the default value is `flow.chainID`
`signers`	A list of `FlowSigner`, which will sign the transaction

Return Value

The transaction id

Show on GitHub


                    
                    
                    addKeyToAccount(address:accountKey:signers:)

Asynchronous

Add public key to account

Declaration

Swift

func addKeyToAccount(address: Flow.Address, accountKey: Flow.AccountKey, signers: [FlowSigner]) async throws -> Flow.ID

Parameters

`address`	The address of Account in `Flow.Address` type.
`accountKey`	The public key to be added in `Flow.AccountKey` type.
`signers`	A list of `FlowSigner` will sign the transaction.

Return Value

A future value will receive transaction id in Flow.ID value.

Show on GitHub


                    
                    
                    addContractToAccount(address:contractName:code:signers:)

Asynchronous

Add cadence contract to account

Declaration

Swift

func addContractToAccount(address: Flow.Address,
                          contractName: String,
                          code: String,
                          signers: [FlowSigner]) async throws -> Flow.ID

Parameters

`address`	The address of Account in `Flow.Address` type.
`contractName`	The name of the cadence script.
`code`	Cadence code of the contract.
`signers`	A list of `FlowSigner` will sign the transaction.

Return Value

A future value will receive transaction id in Flow.ID value.

Show on GitHub


                    
                    
                    createAccount(address:accountKey:contracts:signers:)

Asynchronous

Create a account in Flow blockchain

Declaration

Swift

func createAccount(address: Flow.Address,
                   accountKey: Flow.AccountKey,
                   contracts: [String: String] = [:],
                   signers: [FlowSigner]) async throws -> Flow.ID

Parameters

`address`	The proposer address of Account in `Flow.Address` type.
`publicKeys`	A list of publicKeys to be added in the new account.
`contracts`	A collection of cadence contracts, contract name is the `key`, cadence code is the `value`.
`signers`	A list of `FlowSigner` will sign the transaction.

Return Value

A future value will receive transaction id in Flow.ID value.

Show on GitHub


                    
                    
                    removeAccountKeyByIndex(address:keyIndex:signers:)

Asynchronous

Removing a public key from an account

Declaration

Swift

func removeAccountKeyByIndex(address: Flow.Address,
                             keyIndex: Int,
                             signers: [FlowSigner]) async throws -> Flow.ID

Parameters

`address`	The proposer address of Account in `Flow.Address` type.
`publicKeys`	A list of publicKeys to be added in the new account.
`contracts`	A collection of cadence contracts, contract name is the `key`, cadence code is the `value`.
`signers`	A list of `FlowSigner` will sign the transaction.

Return Value

A future value will receive transaction id in Flow.ID value.

Show on GitHub


                    
                    
                    isAddressVaildate(address:network:)

Asynchronous

Undocumented

Declaration

Swift

func isAddressVaildate(address: Flow.Address, network: Flow.ChainID = .mainnet) async -> Bool

Show on GitHub


                    
                    
                    isAddressVaildate(address:network:)

Asynchronous

Undocumented

Declaration

Swift

func isAddressVaildate(address: String, network: Flow.ChainID = .mainnet) async -> Bool

Show on GitHub


                    
                    
                    removeContractFromAccount(address:contractName:signers:)

Asynchronous

Undocumented

Declaration

Swift

func removeContractFromAccount(address: Flow.Address,
                               contractName: String,
                               signers: [FlowSigner]) async throws -> Flow.ID

Show on GitHub


                    
                    
                    updateContractOfAccount(address:contractName:script:signers:)

Asynchronous

Undocumented

Declaration

Swift

func updateContractOfAccount(address: Flow.Address,
                             contractName: String,
                             script: String,
                             signers: [FlowSigner]) async throws -> Flow.ID

Show on GitHub


                    
                    
                    StorageInfo

Undocumented

Declaration

Swift

struct StorageInfo : Codable

Show on GitHub


                    
                    
                    checkStorageInfo(address:)

Asynchronous

Undocumented

Declaration

Swift

func checkStorageInfo(address: Flow.Address) async throws -> StorageInfo

Show on GitHub


                    
                    
                    verifyUserSignature(message:signatures:)

Asynchronous

Undocumented

Declaration

Swift

func verifyUserSignature(message: String,
                         signatures: [Flow.TransactionSignature]) async throws -> Bool

Show on GitHub


                    
                    
                    Argument

The argument for Cadence code for encoding and decoding

Declaration

Swift

struct Argument : Codable, Equatable

extension Flow.Argument: CustomStringConvertible

Show on GitHub


                    
                    
                    FError

List of common error in Flow Swift SDK

Declaration

Swift

enum FError : Error

extension Flow.FError: LocalizedError

Show on GitHub


                    
                    
                    Account

The data structure of account in Flow blockchain

Declaration

Swift

struct Account : Codable

Show on GitHub


                    
                    
                    AccountKey

The data structure of account key in flow account

Declaration

Swift

struct AccountKey : Codable

Show on GitHub


                    
                    
                    Address

The data structure of address in Flow blockchain At the most time, it represents account address

Declaration

Swift

struct Address : FlowEntity, Equatable, Hashable

extension Flow.Address: Codable

extension Flow.Address: CustomStringConvertible

Show on GitHub


                    
                    
                    SignatureAlgorithm

The signature algorithm supported by flow which include .ECDSA_P256 and .ECDSA_SECP256k1

Declaration

Swift

enum SignatureAlgorithm : String, CaseIterable, Codable

Show on GitHub


                    
                    
                    HashAlgorithm

The hash algorithm supported by flow which include .SHA2_256, .SHA2_384, .SHA3_256 and .SHA3_384

Declaration

Swift

enum HashAlgorithm : String, CaseIterable, Codable

Show on GitHub


                    
                    
                    BlockHeader

Brief information of Flow.Block

Declaration

Swift

struct BlockHeader : Codable

Show on GitHub


                    
                    
                    BlockSeal

The data structure of Flow.Block which is sealed

Declaration

Swift

struct BlockSeal : Codable

Show on GitHub


                    
                    
                    Block

The data structure for the block in Flow blockchain

Declaration

Swift

struct Block : Codable

Show on GitHub


                    
                    
                    decimal

Undocumented

Declaration

Swift

static let decimal: Int

Show on GitHub


                    
                    
                    Cadence

Undocumented

Declaration

Swift

class Cadence

Show on GitHub


                    
                    
                    ChainID

Identification the enviroment of flow

Declaration

Swift

enum ChainID : CaseIterable, Hashable, Codable

Show on GitHub


                    
                    
                    Collection

A batch of transactions that have been included in the same block

Declaration

Swift

struct Collection : Codable

Show on GitHub


                    
                    
                    CollectionGuarantee

Declaration

Swift

struct CollectionGuarantee : Codable

Show on GitHub


                    
                    
                    DomainTag

The prefix when encoding transaction and user with RLP

Declaration

Swift

enum DomainTag

Show on GitHub


                    
                    
                    Event

Declaration

Swift

struct Event : Codable

Show on GitHub


                    
                    
                    Snapshot

Undocumented

Declaration

Swift

struct Snapshot : FlowEntity, Equatable, Codable

extension Flow.Snapshot: CustomStringConvertible

Show on GitHub

ID

The ID in Flow chain, which can represent as transaction id, block id and collection id etc.

Declaration

Swift

struct ID : FlowEntity, Equatable, Hashable

extension Flow.ID: Codable

extension Flow.ID: CustomStringConvertible

Show on GitHub


                    
                    
                    Script

The model to handle Cadence code

Declaration

Swift

struct Script : FlowEntity, Equatable

extension Flow.Script: CustomStringConvertible

extension Flow.Script: Codable

Show on GitHub


                    
                    
                    ScriptResponse

The model to handle the Cadence code response

Declaration

Swift

struct ScriptResponse : FlowEntity, Equatable, Codable

extension Flow.ScriptResponse: CustomStringConvertible

Show on GitHub


                    
                    
                    Signature

The model to handle the signature data, which can present as a hex string

Declaration

Swift

struct Signature : FlowEntity, Equatable, Codable

extension Flow.Signature: CustomStringConvertible

Show on GitHub


                    
                    
                    Transaction

The data structure of Transaction

Declaration

Swift

struct Transaction

extension Flow.Transaction: Codable

Show on GitHub


                    
                    
                    signTransaction(unsignedTransaction:signers:)

Asynchronous

Sign the unsigned transaction with a list of FlowSigner

Declaration

Swift

func signTransaction(unsignedTransaction: Flow.Transaction, signers: [FlowSigner]) async throws -> Flow.Transaction

Parameters

`unsignedTransaction`	The transaction to be signed
`signers`	A list of `FlowSigner` to sign the transaction

Return Value

The signed transaction

Show on GitHub


                    
                    
                    TransactionResult

The transaction result in the chain

Declaration

Swift

struct TransactionResult : Codable

Show on GitHub


                    
                    
                    TransactionProposalKey

The class to represent the proposer key information in the transaction

Declaration

Swift

struct TransactionProposalKey

extension Flow.TransactionProposalKey: Codable

Show on GitHub


                    
                    
                    TransactionSignature

Undocumented

Declaration

Swift

struct TransactionSignature : Comparable

extension Flow.TransactionSignature: Codable

Show on GitHub


                    
                    
                    PublicKey

Undocumented

Declaration

Swift

struct PublicKey : FlowEntity, Equatable, Codable

extension Flow.PublicKey: CustomStringConvertible

Show on GitHub


                    
                    
                    Code

Undocumented

Declaration

Swift

struct Code : FlowEntity, Equatable, Codable

extension Flow.Code: CustomStringConvertible

Show on GitHub


                    
                    
                    ping()

Asynchronous

Undocumented

Declaration

Swift

public func ping() async throws -> Bool

Show on GitHub


                    
                    
                    getLatestBlockHeader()

Asynchronous

Undocumented

Declaration

Swift

public func getLatestBlockHeader() async throws -> BlockHeader

Show on GitHub


                    
                    
                    getBlockHeaderById(id:)

Asynchronous

Undocumented

Declaration

Swift

public func getBlockHeaderById(id: ID) async throws -> BlockHeader

Show on GitHub


                    
                    
                    getBlockHeaderByHeight(height:)

Asynchronous

Undocumented

Declaration

Swift

public func getBlockHeaderByHeight(height: UInt64) async throws -> BlockHeader

Show on GitHub


                    
                    
                    getLatestBlock(sealed:)

Asynchronous

Undocumented

Declaration

Swift

public func getLatestBlock(sealed: Bool) async throws -> Block

Show on GitHub


                    
                    
                    getBlockById(id:)

Asynchronous

Undocumented

Declaration

Swift

public func getBlockById(id: ID) async throws -> Block

Show on GitHub


                    
                    
                    getBlockByHeight(height:)

Asynchronous

Undocumented

Declaration

Swift

public func getBlockByHeight(height: UInt64) async throws -> Block

Show on GitHub


                    
                    
                    getCollectionById(id:)

Asynchronous

Undocumented

Declaration

Swift

public func getCollectionById(id: ID) async throws -> Collection

Show on GitHub


                    
                    
                    sendTransaction(transaction:)

Asynchronous

Undocumented

Declaration

Swift

public func sendTransaction(transaction: Transaction) async throws -> ID

Show on GitHub


                    
                    
                    getTransactionById(id:)

Asynchronous

Undocumented

Declaration

Swift

public func getTransactionById(id: ID) async throws -> Transaction

Show on GitHub


                    
                    
                    getTransactionResultById(id:)

Asynchronous

Undocumented

Declaration

Swift

public func getTransactionResultById(id: ID) async throws -> TransactionResult

Show on GitHub


                    
                    
                    getAccountAtLatestBlock(address:)

Asynchronous

Undocumented

Declaration

Swift

public func getAccountAtLatestBlock(address: Address) async throws -> Account

Show on GitHub


                    
                    
                    getAccountByBlockHeight(address:height:)

Asynchronous

Undocumented

Declaration

Swift

public func getAccountByBlockHeight(address: Address, height: UInt64) async throws -> Account

Show on GitHub


                    
                    
                    getEventsForHeightRange(type:range:)

Asynchronous

Undocumented

Declaration

Swift

public func getEventsForHeightRange(type: String, range: ClosedRange<UInt64>) async throws -> [Event.Result]

Show on GitHub


                    
                    
                    getEventsForBlockIds(type:ids:)

Asynchronous

Undocumented

Declaration

Swift

public func getEventsForBlockIds(type: String, ids: Set<ID>) async throws -> [Event.Result]

Show on GitHub


                    
                    
                    executeScriptAtLatestBlock(script:arguments:)

Asynchronous

Undocumented

Declaration

Swift

public func executeScriptAtLatestBlock(script: Script, arguments: [Argument]) async throws -> ScriptResponse

Show on GitHub


                    
                    
                    getNetworkParameters()

Asynchronous

Undocumented

Declaration

Swift

public func getNetworkParameters() async throws -> ChainID

Show on GitHub


                    
                    
                    Transport

Undocumented

Declaration

Swift

enum Transport : Equatable, Hashable

Show on GitHub