Flow Class Reference


                    
                    
                    configure(chainID:)

Config the chainID for Flow Swift SDK

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


                    
                    
                    createAccessAPI(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 createAccessAPI(chainID: ChainID) -> AccessAPI

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

public enum TransactionBuild

Show on GitHub


                    
                    
                    TransactionBuilder

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

Declaration

Swift

@resultBuilder
public class TransactionBuilder

Show on GitHub


                    
                    
                    asyncBuildTransaction(chainID:builder:)

Build flow transaction using TransactionBuilder with async way

Declaration

Swift

public func asyncBuildTransaction(chainID: Flow.ChainID = flow.chainID,
                                  @Flow .TransactionBuilder builder: () -> [Flow.TransactionBuild]) throws -> EventLoopFuture<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:builder:)

Build flow transaction using TransactionBuilder

Declaration

Swift

public func buildTransaction(chainID: Flow.ChainID = flow.chainID,
                             @Flow .TransactionBuilder builder: () -> [Flow.TransactionBuild]) 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 Flow.Transaction

Show on GitHub


                    
                    
                    sendTransaction(chainID:signedTransaction:)

Send signed Transaction to the network

Declaration

Swift

public func sendTransaction(chainID: ChainID = flow.chainID, signedTransaction: Transaction) throws -> EventLoopFuture<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


                    
                    
                    sendTransactionWithWait(chainID:signers:builder:)

Send signed Transaction to the network in sync way

Declaration

Swift

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

Parameters

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

Return Value

The transaction id

Show on GitHub


                    
                    
                    sendTransaction(chainID:signers:builder:)

Build, sign and send transaction to the network

Declaration

Swift

public func sendTransaction(chainID: Flow.ChainID = flow.chainID,
                            signers: [FlowSigner],
                            @Flow .TransactionBuilder builder: () -> [Flow.TransactionBuild]) throws -> EventLoopFuture<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:builder:completion:)

Build, sign and send transaction to the network with block

Declaration

Swift

public func sendTransaction(chainID: Flow.ChainID = flow.chainID,
                            signers: [FlowSigner],
                            @Flow .TransactionBuilder builder: () -> [Flow.TransactionBuild],
                            completion: @escaping (Result<Flow.ID, Error>) -> Void) throws

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`
`completion`	The block to handle the response

Show on GitHub


                    
                    
                    addKeyToAccount(address:accountKey:signers:)

Add public key to account

Declaration

Swift

public func addKeyToAccount(address: Flow.Address, accountKey: Flow.AccountKey, signers: [FlowSigner]) throws -> EventLoopFuture<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:)

Add cadence contract to account

Declaration

Swift

public func addContractToAccount(address: Flow.Address,
                                 contractName: String,
                                 code: String,
                                 signers: [FlowSigner]) throws -> EventLoopFuture<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:publicKeys:contracts:signers:)

Create a account in Flow blockchain

Declaration

Swift

public func createAccount(address: Flow.Address,
                          publicKeys: [Flow.AccountKey],
                          contracts: [String: String] = [:],
                          signers: [FlowSigner]) throws -> EventLoopFuture<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:)

Removing a public key from an account

Declaration

Swift

public func removeAccountKeyByIndex(address: Flow.Address,
                                    keyIndex: Int,
                                    signers: [FlowSigner]) throws -> EventLoopFuture<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


                    
                    
                    removeContractFromAccount(address:contractName:signers:)

Undocumented

Declaration

Swift

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

Show on GitHub


                    
                    
                    updateContractOfAccount(address:contractName:script:signers:)

Undocumented

Declaration

Swift

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

Show on GitHub


                    
                    
                    verifyUserSignature(message:signatures:)

Undocumented

Declaration

Swift

public func verifyUserSignature(message: String,
                                signatures: [Flow.TransactionSignature]) throws -> EventLoopFuture<Flow.ScriptResponse>

Show on GitHub


                    
                    
                    FError

List of common error in Flow Swift SDK

Declaration

Swift

public enum FError : String, Error

extension Flow.FError: LocalizedError

Show on GitHub


                    
                    
                    Account

The data structure of account in Flow blockchain

Declaration

Swift

public struct Account

Show on GitHub


                    
                    
                    AccountKey

The data structure of account key in flow account

Declaration

Swift

public struct AccountKey

Show on GitHub


                    
                    
                    Address

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

Declaration

Swift

public struct Address : FlowEntity, Equatable, Hashable, Codable

extension Flow.Address: CustomStringConvertible

Show on GitHub


                    
                    
                    SignatureAlgorithm

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

Declaration

Swift

public 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

public enum HashAlgorithm : String, CaseIterable, Codable

Show on GitHub


                    
                    
                    Argument

The argument for Cadence code for encoding and decoding

Declaration

Swift

public struct Argument : Codable, Equatable

Show on GitHub


                    
                    
                    BlockHeader

Brief information of Flow.Block

Declaration

Swift

public struct BlockHeader

Show on GitHub


                    
                    
                    BlockSeal

The data structure of Flow.Block which is sealed

Declaration

Swift

public struct BlockSeal

Show on GitHub


                    
                    
                    Block

The data structure for the block in Flow blockchain

Declaration

Swift

public struct Block

Show on GitHub


                    
                    
                    Cadence

Undocumented

Declaration

Swift

public class Cadence

Show on GitHub


                    
                    
                    ChainID

Identification the enviroment of flow

Declaration

Swift

public enum ChainID : CaseIterable, Hashable

Show on GitHub


                    
                    
                    Collection

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

Declaration

Swift

public struct Collection

Show on GitHub


                    
                    
                    CollectionGuarantee

Declaration

Swift

public struct CollectionGuarantee

Show on GitHub


                    
                    
                    DomainTag

The prefix when encoding transaction and user with RLP

Declaration

Swift

public enum DomainTag : String

Show on GitHub


                    
                    
                    Event

Declaration

Swift

public struct Event

Show on GitHub


                    
                    
                    Snapshot

Undocumented

Declaration

Swift

public struct Snapshot : FlowEntity, Equatable

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

public struct ID : FlowEntity, Equatable, Hashable

extension Flow.ID: CustomStringConvertible

Show on GitHub


                    
                    
                    Script

The model to handle Cadence code

Declaration

Swift

public struct Script : FlowEntity, Equatable

extension Flow.Script: CustomStringConvertible

Show on GitHub


                    
                    
                    ScriptResponse

The model to handle the Cadence code response

Declaration

Swift

public struct ScriptResponse : FlowEntity, Equatable

extension Flow.ScriptResponse: CustomStringConvertible

Show on GitHub


                    
                    
                    Signature

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

Declaration

Swift

public struct Signature : FlowEntity, Equatable

extension Flow.Signature: CustomStringConvertible

Show on GitHub


                    
                    
                    signTransaction(unsignedTransaction:signers:)

Sign the unsigned transaction with a list of FlowSigner

Declaration

Swift

public func signTransaction(unsignedTransaction: Flow.Transaction, signers: [FlowSigner]) 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


                    
                    
                    Transaction

The data structure of Transaction

Declaration

Swift

public struct Transaction

Show on GitHub


                    
                    
                    TransactionResult

The transaction result in the chain

Declaration

Swift

public struct TransactionResult

Show on GitHub


                    
                    
                    TransactionProposalKey

The class to represent the proposer key information in the transaction

Declaration

Swift

public struct TransactionProposalKey

Show on GitHub


                    
                    
                    TransactionSignature

Undocumented

Declaration

Swift

public struct TransactionSignature : Comparable

Show on GitHub


                    
                    
                    PublicKey

Undocumented

Declaration

Swift

public struct PublicKey : FlowEntity, Equatable

Show on GitHub


                    
                    
                    Code

Undocumented

Declaration

Swift

public struct Code : FlowEntity, Equatable

Show on GitHub


                    
                    
                    AccessAPI

The network client for access API More detail can be found here: https://docs.onflow.org/access-api

Declaration

Swift

public final class AccessAPI : FlowAccessProtocol

extension Flow.AccessAPI: FlowAccessBlockProtocol

Show on GitHub