View on GitHub »

Documentation · Report a Bug

Overview

This reference documents all the methods available in the SDK, and explains in detail how these methods work.

This SDK is dual-licensed under MIT or Apache 2.0, at your option.

The library client specifications can be found here:

Note: All examples in this document are tested to compile successfully. Examples that do not send transactions to the network will run on every push.

Getting Started

Installing

To install Rust, refer to rustup.rs for instructions.

Importing the Library

Add the following to your project's Cargo.toml:

[dependencies]
flow-sdk = "1.0.0"

Connect

The library uses gRPC to communicate with the access nodes and it must be configured with correct access node API URL.

📖 Access API URLs can be found here. An error will be returned if the host is unreachable. The Access Nodes APIs hosted by Dapper Labs are accessible at:

Testnet access.devnet.nodes.onflow.org:9000
Mainnet access.mainnet.nodes.onflow.org:9000
Local Emulator 127.0.0.1:3569

Example:

use std::error::Error;
use flow_sdk::client::TonicHyperFlowClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    let mut client = TonicHyperFlowClient::mainnet().await?;
    client.ping().await?;
    Ok(())
}

Querying the Flow Network

After you have established a connection with an access node, you can query the Flow network to retrieve data about blocks, accounts, events and transactions. We will explore how to retrieve each of these entities in the sections below.

Get Blocks

Query the network for block by id, height or get the latest block.

📖 Block ID is SHA3-256 hash of the entire block payload. This hash is stored as an ID field on any block response object (i.e. response from GetLatestBlock).

📖 Block height expresses the height of the block on the chain. The latest block height increases by one for every valid block produced.

Examples

This example depicts ways to get the latest block as well as any other block by height or ID:

use std::error::Error;

use flow_sdk::prelude::*;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    let mut client = TonicHyperFlowClient::testnet().await?;
    client.ping().await?;

    let latest_block = client.latest_block(Seal::Sealed).await?;

    println!("OK: {:#?}", latest_block);

    Ok(())
}

Result output:

OK: Block {
    id: 1ad194977bef2c8ee364daffda73c81efa26f9e03c58f15966e38008115c3739,
    parent_id: 1cddc076c5976ee2235fe838fa4d0d724a7668186d5f87992b1d497b6f6a3f34,
    height: 2,
    timestamp: Timestamp {
        seconds: 1635524459,
        nanos: 315510230,
    },
    collection_guarantees: [
        CollectionGuarantee {
            collection_id: 758ba9c5e78c520ccdc9bc849298063a6d1aeccc0dcd7c70b9bc47989cc44588,
            signatures: [
                ,
            ],
        },
    ],
    block_seals: [],
    signatures: [
        ,
    ],
}

Get Account

Retrieve any account from Flow network's latest block or from a specified block height.

📖 Account address is a unique account identifier. Be mindful about the 0x prefix, you should use the prefix as a default representation but be careful and safely handle user inputs without the prefix.

An account includes the following data:

Address: the account address.
Balance: balance of the account.
Contracts: list of contracts deployed to the account.
Keys: list of keys associated with the account.

Examples

Example depicts ways to get an account at the latest block and at a specific block height:

use std::error::Error;

use flow_sdk::prelude::cadence_json as cjson;
use cjson::AddressOwned;

use flow_sdk::prelude::*;

async fn run(address: &str) -> Result<(), Box<dyn Error + Send + Sync>> {
    let address: AddressOwned = address.parse()?;
    let mut net = TonicHyperFlowClient::mainnet().await?;

    let account = net.account_at_latest_block(&address.data).await?;

    let latest_block_height = net.latest_block_header(Seal::Sealed).await?.height;
    let account1 = net.account_at_block_height(&address.data, latest_block_height).await?;

    println!("{:#?}", account);

    assert_eq!(account, account1);

    Ok(())
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    run("0x9e06eebf494e2d78").await
}

Result output:

Account {
    address: 0x9e06eebf494e2d78,
    balance: 9411868000,
    code: [],
    keys: [
        AccountKey {
            index: 0,
            public_key: d5932abf2a4d22fe9fbf312ce44e984b0c6486cd221e9ea42d1fed48e8b685bdb7daf61f20ad560e2b5938958d48b9daf3fd9ae05608e012dd64f47453cb9ca2,
            sign_algo: 2,
            hash_algo: 3,
            weight: 1000,
            sequence_number: 35875,
            revoked: false,
        },
    ],
    contracts: {},
}

Get Transactions

Retrieve transactions from the network by providing a transaction ID. After a transaction has been submitted, you can also get the transaction result to check the status.

📖 Transaction ID is a hash of the encoded transaction payload and can be calculated before submitting the transaction to the network.

⚠️ The transaction ID provided must be from the current spork.

📖 Transaction status represents the state of transaction in the blockchain. Status can change until is finalized.

Status	Final	Description
UNKNOWN	❌	The transaction has not yet been seen by the network
PENDING	❌	The transaction has not yet been included in a block
FINALIZED	❌	The transaction has been included in a block
EXECUTED	❌	The transaction has been executed but the result has not yet been sealed
SEALED	✅	The transaction has been executed and the result is sealed in a block
EXPIRED	✅	The transaction reference block is outdated before being executed

use std::error::Error;

use flow_sdk::prelude::*;

async fn run(tx_id: &str) -> Result<(), Box<dyn Error + Send + Sync>> {
    let mut client = TonicHyperFlowClient::mainnet().await?;
    client.ping().await?;

    let decoded_tx_id = hex::decode(tx_id)?;

    let txn = client.transaction_by_id(&decoded_tx_id).await?;
    println!("{:#?}", txn);
    Ok(())
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    run("97ff408cbcd6622ac1bf42a185b5cd36a2c6e0f86913649abcd35013581b771c").await
}

Example output:

Transaction {
    script: "import FungibleToken from 0xf233dcee88fe0abe\nimport DapperUtilityCoin from 0xead892083b3e2c6c\nimport TopShot from 0x0b2a3299cc857e29\nimport Market from 0xc1e4f4f4c4257510\nimport TopShotMarketV3 from 0xc1e4f4f4c4257510\n\n// This transaction purchases a moment from the v3 sale collection\n// The v3 sale collection will also check the v1 collection for for sale moments as part of the purchase\n// If there is no v3 sale collection, the transaction will just purchase it from v1 anyway\n\ntransaction() {\n\n\tlet purchaseTokens: @DapperUtilityCoin.Vault\n\n\tprepare(acct: AuthAccount) {\n\n\t\t// Borrow a provider reference to the buyers vault\n\t\tlet provider = acct.borrow<&DapperUtilityCoin.Vault{FungibleToken.Provider}>(from: /storage/dapperUtilityCoinVault)\n\t\t\t?? panic(\"Could not borrow a reference to the buyers FlowToken Vault\")\n\t\t\n\t\t// withdraw the purchase tokens from the vault\n\t\tself.purchaseTokens <- provider.withdraw(amount: UFix64(8)) as! @DapperUtilityCoin.Vault\n\t\t\n\t}\n\n\texecute {\n\n\t\t// get the accounts for the seller and recipient\n\t\tlet seller = getAccount(0x942e29b7b46ee571)\n\t\tlet recipient = getAccount(0x23eafaf413144b65)\n\n\t\t// Get the reference for the recipient's nft receiver\n\t\tlet receiverRef = recipient.getCapability(/public/MomentCollection)!.borrow<&{TopShot.MomentCollectionPublic}>()\n\t\t\t?? panic(\"Could not borrow a reference to the recipients moment collection\")\n\n\t\tif let marketV3CollectionRef = seller.getCapability(/public/topshotSalev3Collection)\n\t\t\t\t.borrow<&{Market.SalePublic}>() {\n\n\t\t\tlet purchasedToken <- marketV3CollectionRef.purchase(tokenID: 11224606, buyTokens: <-self.purchaseTokens)\n\t\t\treceiverRef.deposit(token: <-purchasedToken)\n\n\t\t} else if let marketV1CollectionRef = seller.getCapability(/public/topshotSaleCollection)\n\t\t\t.borrow<&{Market.SalePublic}>() {\n\t\t\t// purchase the moment\n\t\t\tlet purchasedToken <- marketV1CollectionRef.purchase(tokenID: 11224606, buyTokens: <-self.purchaseTokens)\n\n\t\t\t// deposit the purchased moment into the signer's collection\n\t\t\treceiverRef.deposit(token: <-purchasedToken)\n\n\t\t} else {\n\t\t\tpanic(\"Could not borrow reference to either Sale collection\")\n\t\t}\n\t}\n}",
    arguments: [],
    reference_block_id: 6a0d194c0ca06ca77c0e8f3d070ca8caf09dffa6045d5cc40542abb223e8e97b,
    gas_limit: 9999,
    proposal_key: ProposalKey {
        address: 0xead892083b3e2c6c,
        key_id: 121,
        sequence_number: 26905,
    },
    payer: 0x18eb4ee6b3c026d2,
    authorizers: [
        0xead892083b3e2c6c,
    ],
    payload_signatures: [
        Signature {
            address: 0xead892083b3e2c6c,
            key_id: 2,
            signature: 5c3b07f6a0ec97155c610c87e34ca299e58ee65f5efc68d2e7176158e8cbeb8201073bf1c04b93abd44620b39e720eefae9092cdf6d4fd2769ca64acd8f6f2a0,
        },
        Signature {
            address: 0xead892083b3e2c6c,
            key_id: 121,
            signature: 2fc230f1f2b201ce798fd7dbe2c637cc57c78fe35cebd6519d8843eecb6a6e960ed336a79852ee56baf9deae8c56fdb7166be6991f654afd16c9bf1589ffeaca,
        },
    ],
    envelope_signatures: [
        Signature {
            address: 0x18eb4ee6b3c026d2,
            key_id: 0,
            signature: 2fa8859eebf2fe03c5af69611c49914f99462ce05cf9dcdf7541446624b4ac8b25c6e72cebb6cf8d464fbf7845cc897c426ebabce10fab4ef10c797ec17e77e4,
        },
    ],
}

Get Events

Retrieve events by a given type in a specified block height range or through a list of block IDs.

📖 Event type is a string that follow a standard format:

A.{contract address}.{contract name}.{event name}

Please read more about events in the documentation. The exception to this standard are core events, and you should read more about them in this document.

📖 Block height range expresses the height of the start and end block in the chain.

Examples

Example depicts ways to get events within block range or by block IDs:

use std::error::Error;

use flow_sdk::prelude::*;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    let mut client = TonicHyperFlowClient::mainnet().await?;
    client.ping().await?;

    let latest_block_height = client.latest_block_header(Seal::Sealed).await?.height;
    let start_height = latest_block_height - 20;

    println!(
        "Searching for accounts created within the last 20 blocks ({}-{})...",
        start_height, latest_block_height
    );

    for events in client
        .events_for_height_range("flow.AccountCreated", start_height, latest_block_height)
        .await?
        .results
    {
        if events.events.is_empty() {
            continue;
        }
        println!(
            "\nBlock #{} ({}):",
            events.block_height,
            hex::encode(&events.block_id)
        );
        for event in events.events {
            let val: cadence_json::ValueOwned = serde_json::from_slice(&event.payload)?;

            println!(" - {:#?}", val);
        }
    }

    Ok(())
}

Example output:

Searching for accounts created within the last 20 blocks (19495374-19495394)...

Block #19495378 (6d9d4315127cc9f26fde6ca7429d1d6718d35cd4a8ef2a7804d3e1ae6d2b9bbe):
  - Event {
    id: "flow.AccountCreated",
    address: 0x5231653750457b87,
}
  - Event {
    id: "flow.AccountCreated",
    address: 0x44650004c94171e6,
}

Block #19495380 (aaecc42eceebc0c626f43515c56a4e2ca18736b70cc7f9bdcc51e0acbb0adc7b):
  - Event {
    id: "flow.AccountCreated",
    address: 0xa002b9d9d8bb7139,
}

Block #19495386 (1140190de576c9d6ec7da897b5cf6aa92a246b33505be9d05285941bf5878be7):
  - Event {
    id: "flow.AccountCreated",
    address: 0x4f4f329d05c40fcf,
}

Block #19495390 (daab11c3b29f44426f647748ab32db081b34eb38f8f237cd9a0d3d53b4cd9a93):
  - Event {
    id: "flow.AccountCreated",
    address: 0xab288b40143e0f10,
}

Block #19495391 (9abfed42ac1e79ab91dfcb4192d802c1db251a28493cf4d8cceb0addb319cb0c):
  - Event {
    id: "flow.AccountCreated",
    address: 0xbd7cee738d3a0571,
}

Block #19495392 (e3c457b6fc92d04c4087ce0ae3e647e76f4da8e10a12c456b9e0a888a161cc31):
  - Event {
    id: "flow.AccountCreated",
    address: 0x591b57ae9cc005ae,
}

Get Collections

Retrieve a batch of transactions that have been included in the same block, known as collections. Collections are used to improve consensus throughput by increasing the number of transactions per block and they act as a link between a block and a transaction.

📖 Collection ID is SHA3-256 hash of the collection payload.

Example retrieving a collection:

use std::error::Error;

use flow_sdk::prelude::*;

async fn run(collection_id: &str) -> Result<(), Box<dyn Error + Send + Sync>> {
    let mut client = TonicHyperFlowClient::mainnet().await?;
    let collection = client
            .collection_by_id(&hex::decode(collection_id).unwrap())
            .await?;

    println!("OK: {:#?}", collection);
    Ok(())
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    run("e77a56556aadcc2f2b6e4ef853983a2be3dc8ff72873a8e1a1ae13651ec779ed").await
}

Example output:

OK: Collection {
    id: e77a56556aadcc2f2b6e4ef853983a2be3dc8ff72873a8e1a1ae13651ec779ed,
    transactions: [
        bcb7a41ffa990fd09f4285eebdf31a69d3fce23cf23c39ac86753c1cbd3207ed,
    ],
}

Execute Scripts

Scripts allow you to write arbitrary non-mutating Cadence code on the Flow blockchain and return data. You can learn more about Cadence and scripts here, but we are now only interested in executing the script code and getting back the data.

We can execute a script using the latest state of the Flow blockchain or we can choose to execute the script at a specific time in history defined by a block height or block ID.

📖 Block ID is SHA3-256 hash of the entire block payload, but you can get that value from the block response properties.

📖 Block height expresses the height of the block in the chain.

use std::error::Error;

use flow_sdk::prelude::cadence_json as cjson;
use cjson::{BigInt, ValueRef};

use flow_sdk::access::ExecuteScriptAtLatestBlockRequest;
use flow_sdk::prelude::*;

const SIMPLE_SCRIPT: &str = "
    pub fun main(a: Int): Int {
        return a + 10
    }
";

const COMPLEX_SCRIPT: &str = "
    pub struct User {
        pub var balance: UFix64
        pub var address: Address
        pub var name: String

        init(name: String, address: Address, balance: UFix64) {
            self.name = name
            self.address = address
            self.balance = balance
        }
    }

    pub fun main(name: String): User {
        return User(
            name: name,
            address: 0x1,
            balance: 10.0
        )
    }
";

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    let mut client = TonicHyperFlowClient::mainnet().await?;
    client.ping().await?;

    let ret = client
        .execute_script_at_latest_block(
            SIMPLE_SCRIPT,
            [ValueRef::Int(cadence_json::BigInt::from(32))],
        )
        .await?
        .parse()?;

    println!("{:#?}", ret);

    let ret = client
        .execute_script_at_latest_block(
            COMPLEX_SCRIPT,
            [ValueRef::String("John Doe")],
        )
        .await?
        .parse()?;

    println!("{:#?}", ret);

    Ok(())
}

Example output:

42
Struct {
    id: "s.ccbac9e72ee36be8881671e8939b970bb8bc81fb8cfd695c6fd848cf75248802.User",
    balance: 10.00000000,
    address: 0x0000000000000001,
    name: "John Doe",
}

Mutate Flow Network

Flow, like most blockchains, allows anybody to submit a transaction that mutates the shared global chain state. A transaction is an object that holds a payload, which describes the state mutation, and one or more authorizations that permit the transaction to mutate the state owned by specific accounts.

Transaction data is composed and signed with help of the SDK. The signed payload of transaction then gets submitted to the access node API. If a transaction is invalid or the correct number of authorizing signatures are not provided, it gets rejected.

Executing a transaction requires couple of steps:

Building a transaction.
Signing a transaction.
Sending a transaction.

Transactions

A transaction is nothing more than a signed set of data that includes script code which are instructions on how to mutate the network state and properties that define and limit it's execution. All these properties are explained bellow.

📖 Script field is the portion of the transaction that describes the state mutation logic. On Flow, transaction logic is written in Cadence. Here is an example transaction script:

transaction(greeting: String) {
  execute {
    log(greeting.concat(", World!"))
  }
}

📖 Arguments. A transaction can accept zero or more arguments that are passed into the Cadence script. The arguments on the transaction must match the number and order declared in the Cadence script. Sample script from above accepts a single String argument.

📖 Proposal key must be provided to act as a sequence number and prevent reply and other potential attacks.

Each account key maintains a separate transaction sequence counter; the key that lends its sequence number to a transaction is called the proposal key.

A proposal key contains three fields:

Account address
Key index
Sequence number

A transaction is only valid if its declared sequence number matches the current on-chain sequence number for that key. The sequence number increments by one after the transaction is executed.

📖 Payer is the account that pays the fees for the transaction. A transaction must specify exactly one payer. The payer is only responsible for paying the network and gas fees; the transaction is not authorized to access resources or code stored in the payer account.

📖 Authorizers are accounts that authorize a transaction to read and mutate their resources. A transaction can specify zero or more authorizers, depending on how many accounts the transaction needs to access.

The number of authorizers on the transaction must match the number of AuthAccount parameters declared in the prepare statement of the Cadence script.

Example transaction with multiple authorizers:

transaction {
  prepare(authorizer1: AuthAccount, authorizer2: AuthAccount) { }
}

📖 Gas limit is the limit on the amount of computation a transaction requires, and it will abort if it exceeds its gas limit. Cadence uses metering to measure the number of operations per transaction. You can read more about it in the Cadence documentation.

The gas limit depends on the complexity of the transaction script. Until dedicated gas estimation tooling exists, it's best to use the emulator to test complex transactions and determine a safe limit.

📖 Reference block specifies an expiration window (measured in blocks) during which a transaction is considered valid by the network. A transaction will be rejected if it is submitted past its expiry block. Flow calculates transaction expiry using the reference block field on a transaction. A transaction expires after 600 blocks are committed on top of the reference block, which takes about 10 minutes at average Mainnet block rates.

Build Transactions

Building a transaction involves setting the required properties explained above and producing a transaction object.

Here we define a simple transaction script that will be used to execute on the network and serve as a good learning example.

transaction(greeting: String) {

  let guest: Address

  prepare(authorizer: AuthAccount) {
    self.guest = authorizer.address
  }

  execute {
    log(greeting.concat(",").concat(guest.toString()))
  }
}

use cadence_json::ValueRef;
use flow_sdk::transaction::TransactionHeaderBuilder;


const SCRIPT: &str = r#"
    transaction(greeting: String) {
       let guest: Address

       prepare(authorizer: AuthAccount) {
           self.guest = authorizer.address
       }

       execute {
           log(greeting.concat(",").concat(guest.toString()))
       }
    }
"#;

let argument = ValueRef::String("Hello");

let header = TransactionHeaderBuilder::new().script_static(SCRIPT).argument(&argument).build();

After you have successfully built a transaction the next step in the process is to sign it.

Sign Transactions

Flow introduces new concepts that allow for more flexibility when creating and signing transactions. Before trying the examples below, we recommend that you read through the transaction signature documentation.

After you have successfully built a transaction the next step in the process is to sign it. Flow transactions have envelope and payload signatures, and you should learn about each in the signature documentation.

Quick example of building a transaction:

use std::error::Error;

use flow_sdk::prelude::*;
use secp256k1::{PublicKey, Secp256k1, SecretKey};

const MY_SECRET_KEY: &str = "74cd94fc21e264811c97bb87f1061edc93aaeedb6885ff8307608a9f2bcebec5";

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    let client = TonicHyperFlowClient::testnet().await?;
        
    let secp256k1 = Secp256k1::signing_only();
    let secret_key_raw = hex::decode(MY_SECRET_KEY).unwrap();
    let secret_key = SecretKey::from_slice(&secret_key_raw).unwrap();
    let public_key = PublicKey::from_secret_key(&secp256k1, &secret_key);

    let txn = CreateAccountTransaction {
        public_keys: &[
            public_key
        ],
    };
    let txn = txn.to_header::<_, DefaultHasher>(&secp256k1);

    Ok(())
}

Signatures can be generated more securely using keys stored in a hardware device such as an HSM. The FlowSigner interface is intended to be flexible enough to support a variety of signer implementations and is not limited to in-memory implementations.

Simple signature example:

use std::error::Error;

use crate::cadence_json::AddressOwned;
// ^ this example tests with cadence_json crate imported, which introduces an ambiguity if you remove `crate::`.
// | in your own crate, you can remove `crate::` if you don't have `cadence_json` in your `Cargo.toml`.
use flow_sdk::prelude::*;
use secp256k1::{PublicKey, Secp256k1, SecretKey};

const MY_ADDRESS: &str = "0x41c60c9bacab2a3d";
const MY_SECRET_KEY: &str = "74cd94fc21e264811c97bb87f1061edc93aaeedb6885ff8307608a9f2bcebec5";

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    let client = TonicHyperFlowClient::testnet().await?;
        
    let secp256k1 = Secp256k1::signing_only();
    let secret_key_raw = hex::decode(MY_SECRET_KEY).unwrap();
    let secret_key = SecretKey::from_slice(&secret_key_raw).unwrap();

    let address: AddressOwned = MY_ADDRESS.parse().unwrap();
    let mut account = Account::<_, _>::new(client, &address.data, secret_key).await?;

    for signature in account.sign_data("Hello, world!") {
        println!("{:?}", signature.serialize_compact());
    }
    Ok(())
}

Flow supports great flexibility when it comes to transaction signing, we can define multiple authorizers (multi-sig transactions) and have different payer account than proposer. We will explore advanced signing scenarios bellow.

Single party, single signature

Proposer, payer and authorizer are the same account (0x01).
Only the envelope must be signed.
Proposal key must have full signing weight.

Account	Key ID	Weight
`0x41c60c9bacab2a3d`	1	1.0

use std::error::Error;

use flow_sdk::prelude::cadence_json as cjson;
use cjson::AddressOwned;

use flow_sdk::prelude::*;
use secp256k1::{PublicKey, Secp256k1, SecretKey};

const MY_ADDRESS: &str = "0x41c60c9bacab2a3d";
const MY_SECRET_KEY: &str = "74cd94fc21e264811c97bb87f1061edc93aaeedb6885ff8307608a9f2bcebec5";

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    let client = TonicHyperFlowClient::testnet().await?;
        
    let secp256k1 = Secp256k1::signing_only();
    let secret_key_raw = hex::decode(MY_SECRET_KEY).unwrap();
    let secret_key = SecretKey::from_slice(&secret_key_raw).unwrap();
    let public_key = PublicKey::from_secret_key(&secp256k1, &secret_key);

    let txn = CreateAccountTransaction {
        public_keys: &[
            public_key
        ],
    };
    let txn = txn.to_header::<_, DefaultHasher>(&secp256k1);

    let address: AddressOwned = MY_ADDRESS.parse().unwrap();
    let mut account = Account::<_, _>::new(client, &address.data, secret_key).await?;

    let latest_block_id = account.client().latest_block_header(Seal::Sealed).await?.id;
    let sequence_number = account.primary_key_sequence_number().await?;

    account.sign_transaction_header(&txn, latest_block_id, sequence_number as u64, 1000);

    Ok(())
}

Single party, multiple signatures

Proposer, payer and authorizer are the same account (0x01).
Only the envelope must be signed.
Each key has weight 0.5, so two signatures are required.

Account	Key ID	Weight
`0x750859bbbd3fe597`	1	0.5
`0x750859bbbd3fe597`	2	0.5

use std::error::Error;

use secp256k1::{PublicKey, Secp256k1, SecretKey};

use flow_sdk::prelude::cadence_json as cjson;
use cjson::AddressOwned;

use flow_sdk::prelude::*;

const MULTISIG_1_ADDRESS: &str = "0x750859bbbd3fe597";
const MULTISIG_1_SK_1: &str = "db8b853c24795cba465b7d70a7ebeb8eed06f1c18307e58885dd54db478f17fd";
const MULTISIG_1_SK_2: &str = "ec4917f95c5d59a7b3967ba67f0a43e2bbf619f3119837429ec6efe05d11ed12";

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
    let client = TonicHyperFlowClient::testnet().await?;
    
    let secp256k1 = Secp256k1::signing_only();
    let sk1 = hex::decode(MULTISIG_1_SK_1).unwrap();
    let sk2 = hex::decode(MULTISIG_1_SK_2).unwrap();
    let sk1 = SecretKey::from_slice(&sk1).unwrap();
    let sk2 = SecretKey::from_slice(&sk2).unwrap();

    let pk1 = PublicKey::from_secret_key(&secp256k1, &sk1);

    let txn = CreateAccountTransaction {
        public_keys: &[
            pk1
        ],
    };
    let txn = txn.to_header::<_, DefaultHasher>(&secp256k1);

    let address: AddressOwned = MULTISIG_1_ADDRESS.parse().unwrap();

    let mut account = Account::<_, _>::new_multisign(client, &address.data, 0, &[sk1, sk2]).await?;

    let latest_block = account.client().latest_block_header(Seal::Sealed).await?.id;
    let sequence_number = account.primary_key_sequence_number().await?;

    account.sign_transaction_header(&txn, latest_block, sequence_number as u64, 1000);

    Ok(())
}

Multiple parties

Proposer and authorizer are the same account (0x01).
Payer is a separate account (0x02).
Account 0x01 signs the payload.
Account 0x02 signs the envelope.
- Account 0x02 must sign last since it is the payer.

Account	Key ID	Weight
`0x01`	1	1.0
`0x02`	3	1.0

use std::error::Error;

use secp256k1::{PublicKey, Secp256k1, SecretKey};

use flow_sdk::prelude::cadence_json as cjson;
use cjson::AddressOwned;

use flow_sdk::access::SendTransactionRequest;
use flow_sdk::prelude::*;

const ONEKEY_1_ADDRESS: &str = "0x41c60c9bacab2a3d";
const ONEKEY_1_SK: &str = "74cd94fc21e264811c97bb87f1061edc93aaeedb6885ff8307608a9f2bcebec5";

const ONEKEY_2_ADDRESS: &str = "0x6abc82b79b9a5573";
const ONEKEY_2_SK: &str = "10d5ba77219d1074c8fd7b2a8990e0873e70183e2388300eeb4d332495f5d636";

async fn signing_transactions_one_multi() -> Result<(), Box<dyn Error + Send + Sync>> {
    let client = TonicHyperFlowClient::testnet().await?;
    let client2 = client.clone();

    let secp256k1 = Secp256k1::signing_only();
    let sk1 = hex::decode(ONEKEY_1_SK).unwrap();
    let sk1 = SecretKey::from_slice(&sk1).unwrap();
    let sk2 = hex::decode(ONEKEY_2_SK).unwrap();
    let sk2 = SecretKey::from_slice(&sk2).unwrap();
    let pk = PublicKey::from_secret_key(&secp256k1, &sk1);
    let address1: AddressOwned = ONEKEY_1_ADDRESS.parse().unwrap();
    let address2: AddressOwned = ONEKEY_2_ADDRESS.parse().unwrap();

    let txn = CreateAccountTransaction { public_keys: &[pk] };
    let txn = txn.to_header::<_, DefaultHasher>(&secp256k1);

    let mut account1 = Account::<_, _>::new(client, &address1.data, sk1).await?;
    let account2 = Account::<_, _>::new(client2, &address2.data, sk2).await?;

    let mut party = txn
        .into_party_builder()
        .authorizer_account(&account1)
        .proposer_account(&mut account1)
        .await?
        .payer_account(&account2)
        .latest_block_as_reference(account1.client())
        .await?
        .build_prehashed::<DefaultHasher>();

    account1.sign_party(&mut party);

    let txn = account2.sign_party_as_payer(party);

    println!("{:?}", txn);

    account1.client().send_transaction(txn).await?;

    Ok(())
}

Multiple parties, two authorizers

Proposer and authorizer are the same account (0x01).
Payer is a separate account (0x02).
Account 0x01 signs the payload.
Account 0x02 signs the envelope.
- Account 0x02 must sign last since it is the payer.
Account 0x02 is also an authorizer to show how to include two AuthAccounts into an transaction

Account	Key ID	Weight
`0x01`	1	1.0
`0x02`	3	1.0

use std::error::Error;

use secp256k1::SecretKey;

use flow_sdk::prelude::cadence_json as cjson;
use cjson::AddressOwned;

use flow_sdk::access::SendTransactionRequest;
use flow_sdk::prelude::*;

const ONEKEY_1_ADDRESS: &str = "0x41c60c9bacab2a3d";
const ONEKEY_1_SK: &str = "74cd94fc21e264811c97bb87f1061edc93aaeedb6885ff8307608a9f2bcebec5";

const ONEKEY_2_ADDRESS: &str = "0x6abc82b79b9a5573";
const ONEKEY_2_SK: &str = "10d5ba77219d1074c8fd7b2a8990e0873e70183e2388300eeb4d332495f5d636";

#[tokio::test]
async fn signing_transactions_one_multi_authorizers() -> Result<(), Box<dyn Error + Send + Sync>> {
    const SCRIPT: &str = "
    transaction {
        prepare(acct1: AuthAccount, acct2: AuthAccount) {
            log([acct1, acct2])
        }
    }";
    let client = TonicHyperFlowClient::testnet().await?;
    let client2 = client.clone();

    let sk1 = hex::decode(ONEKEY_1_SK).unwrap();
    let sk1 = SecretKey::from_slice(&sk1).unwrap();
    let sk2 = hex::decode(ONEKEY_2_SK).unwrap();
    let sk2 = SecretKey::from_slice(&sk2).unwrap();
    let address1: AddressOwned = ONEKEY_1_ADDRESS.parse().unwrap();
    let address2: AddressOwned = ONEKEY_2_ADDRESS.parse().unwrap();

    let txn = TransactionHeaderBuilder::new().script_static(SCRIPT).build();

    let mut account1 = Account::<_, _>::new(client, &address1.data, sk1).await?;
    let account2 = Account::<_, _>::new(client2, &address2.data, sk2).await?;

    let mut party = txn
        .into_party_builder()
        .authorizer_accounts([&account1, &account2])
        .proposer_account(&mut account1)
        .await?
        .payer_account(&account2)
        .latest_block_as_reference(account1.client())
        .await?
        .build_prehashed::<DefaultHasher>();

    account1.sign_party(&mut party);

    let txn = account2.sign_party_as_payer(party);

    println!("{:?}", txn);

    account1.client().send_transaction(txn).await?;

    Ok(())
}

Multiple parties, multiple signatures

Proposer and authorizer are the same account (0x01).
Payer is a separate account (0x02).
Account 0x01 signs the payload.
Account 0x02 signs the envelope.
- Account 0x02 must sign last since it is the payer.
Both accounts must sign twice (once with each of their keys).

Account	Key ID	Weight
`0x01`	1	0.5
`0x01`	2	0.5
`0x02`	3	0.5
`0x02`	4	0.5

use std::error::Error;

use secp256k1::{PublicKey, Secp256k1, SecretKey};

use flow_sdk::prelude::cadence_json as cjson;
use cjson::AddressOwned;

use flow_sdk::access::SendTransactionRequest;
use flow_sdk::prelude::*;

const MULTISIG_1_ADDRESS: &str = "0x750859bbbd3fe597";
const MULTISIG_1_SK_1: &str = "db8b853c24795cba465b7d70a7ebeb8eed06f1c18307e58885dd54db478f17fd";
const MULTISIG_1_SK_2: &str = "ec4917f95c5d59a7b3967ba67f0a43e2bbf619f3119837429ec6efe05d11ed12";

const MULTISIG_2_ADDRESS: &str = "0x214e531d64c8151a";
const MULTISIG_2_SK_1: &str = "fdf68c79fb7234b15b3cad54e2d6f424e831c7c09dadd277f8cbe27b74a30dcb";
const MULTISIG_2_SK_2: &str = "145f3687501494168f85457f8e7fcd02b8251a5ca10cfe9b73395a7f9aaaee85";

async fn signing_transactions_multisig_multi() -> Result<(), Box<dyn Error + Send + Sync>> {
    let client = TonicHyperFlowClient::testnet().await?;
    let client2 = client.clone();

    let secp = Secp256k1::signing_only();
    let sk1_1 = hex::decode(MULTISIG_1_SK_1).unwrap();
    let sk1_1 = SecretKey::from_slice(&sk1_1).unwrap();
    let sk1_2 = hex::decode(MULTISIG_1_SK_2).unwrap();
    let sk1_2 = SecretKey::from_slice(&sk1_2).unwrap();
    let sk2_1 = hex::decode(MULTISIG_2_SK_1).unwrap();
    let sk2_1 = SecretKey::from_slice(&sk2_1).unwrap();
    let sk2_2 = hex::decode(MULTISIG_2_SK_2).unwrap();
    let sk2_2 = SecretKey::from_slice(&sk2_2).unwrap();
    let pk = PublicKey::from_secret_key(&secp, &sk1_1);
    let address1: AddressOwned = MULTISIG_1_ADDRESS.parse().unwrap();
    let address2: AddressOwned = MULTISIG_2_ADDRESS.parse().unwrap();

    let txn = CreateAccountTransaction { public_keys: &[pk] };

    let txn = txn.to_header::<_, DefaultHasher>(&secp);

    let mut account1 =
        Account::<_, _>::new_multisign(client, &address1.data, 0, &[sk1_1, sk1_2]).await?;
    let account2 =
        Account::<_, _>::new_multisign(client2, &address2.data, 0, &[sk2_1, sk2_2]).await?;

    let mut party = txn
        .into_party_builder()
        .authorizer_account(&account1)
        .proposer_account(&mut account1)
        .await?
        .payer_account(&account2)
        .latest_block_as_reference(account1.client())
        .await?
        .build_prehashed::<DefaultHasher>();

    account1.sign_party(&mut party);

    let txn = account2.sign_party_as_payer(party);

    println!("{:?}", txn);

    account1
        .client()
        .send_transaction(txn)
        .await?;

    Ok(())
}

Send Transactions

After a transaction has been built and signed, it can be sent to the Flow blockchain where it will be executed. If sending was successful you can then retrieve the transaction result.

use std::error::Error;

use flow_sdk::access::SendTransactionRequest;
use flow_sdk::prelude::*;
use flow_sdk::transaction::TransactionHeader;
use flow_sdk::multi::PartyTransaction;

// The type parameters used here may not match what you actually use here.
// Feel free to change them if you like! (they are specified to pass tests)
async fn example() -> Result<(), Box<dyn Error + Send + Sync>> {
    let mut account: Account<TonicHyperFlowClient> = todo!("login to the account here");

    let txn_header: TransactionHeader<Vec<Box<[u8]>>> = todo!("Build one from TransactionHeaderBuilder or use one of the templates");

    let txn_from_party: PartyTransaction<Box<[u8]>, [u8; 64]> = todo!("Make a party, let people sign it, and call `sign_party_as_payer`");

    // do this if you only have a header and you just want to send this with one account.
    let res = account.send_transaction_header(&txn_header).await?;

    // do this when you have a party and multiple accounts need to sign it.
    let res2 = account.client().send_transaction(txn_from_party).await?;

    // We can use `finalize` to wait until the transaction has been sealed.
    if let Some(txn_result) = res.finalize(account.client()).await? {
        // Do stuff with the result here.
    } else {
        // Timeout has reached.
        // You can customize delay between retries and timeout by constructing `Finalize` yourself:
        // `Finalize::new(&res.id, account.client(), /* delay */, /* timeout */)`
    }
    Ok(())
}

Create Accounts

On Flow, account creation happens inside a transaction. Because the network allows for a many-to-many relationship between public keys and accounts, it's not possible to derive a new account address from a public key offline.

The Flow VM uses a deterministic address generation algorithm to assign account addresses on chain. You can find more details about address generation in the accounts & keys documentation.

Public Key

Flow uses ECDSA key pairs to control access to user accounts. Each key pair can be used in combination with the SHA2-256 or SHA3-256 hashing algorithms.

⚠️ You'll need to authorize at least one public key to control your new account.

Flow represents ECDSA public keys in raw form without additional metadata. Each key is a single byte slice containing a concatenation of its X and Y components in big-endian byte form.

A Flow account can contain zero (not possible to control) or more public keys, referred to as account keys. Read more about accounts in the documentation.

An account key contains the following data:

Raw public key (described above)
Signature algorithm
Hash algorithm
Weight (integer between 0-1000)

Account creation happens inside a transaction, which means that somebody must pay to submit that transaction to the network. We'll call this person the account creator. Make sure you have read sending a transaction section first.

use std::error::Error;

use flow_sdk::prelude::cadence_json as cjson;
use cjson::AddressOwned;

use flow_sdk::prelude::*;

use secp256k1::{PublicKey, Secp256k1, SecretKey};

const MY_ADDRESS: &str = "0x41c60c9bacab2a3d";
const MY_SECRET_KEY: &str = "74cd94fc21e264811c97bb87f1061edc93aaeedb6885ff8307608a9f2bcebec5";

async fn create_account() -> Result<(), Box<dyn Error + Send + Sync>> {
    let secp = Secp256k1::signing_only();
    let secret_key = hex::decode(MY_SECRET_KEY).unwrap();
    let secret_key = SecretKey::from_slice(&secret_key).unwrap();
    let public_key = PublicKey::from_secret_key(&secp, &secret_key);

    let address: AddressOwned = MY_ADDRESS.parse().unwrap();
    let net = TonicHyperFlowClient::testnet().await?;

    let mut account = Account::<_, _>::new(net, &address.data, secret_key).await?;

    let create_account = CreateAccountTransaction {
        public_keys: &[public_key],
    };

    let create_account_header = create_account.to_header::<_, tiny_keccak::Sha3>(account.signer());
    let res = account
        .send_transaction_header(&create_account_header)
        .await?;

    println!(
        "Just made {} to create another account :p",
        hex::encode(&res.id)
    );

    Ok(())
}

After the account creation transaction has been submitted you can retrieve the new account address by getting the transaction result.

The new account address will be emitted in a system-level flow.AccountCreated event.

use std::error::Error;

use flow_sdk::prelude::cadence_json as cjson;
use cjson::AddressOwned;

use flow_sdk::prelude::*;

use secp256k1::{PublicKey, Secp256k1, SecretKey};

const MY_ADDRESS: &str = "0x41c60c9bacab2a3d";
const MY_SECRET_KEY: &str = "74cd94fc21e264811c97bb87f1061edc93aaeedb6885ff8307608a9f2bcebec5";

// reusing the example above...
async fn create_account() -> Result<(), Box<dyn Error + Send + Sync>> {
    let secp = Secp256k1::signing_only();
    let secret_key = hex::decode(MY_SECRET_KEY).unwrap();
    let secret_key = SecretKey::from_slice(&secret_key).unwrap();
    let public_key = PublicKey::from_secret_key(&secp, &secret_key);

    let address: AddressOwned = MY_ADDRESS.parse().unwrap();
    let net = TonicHyperFlowClient::testnet().await?;

    let mut account = Account::<_, _>::new(net, &address.data, secret_key).await?;

    let create_account = CreateAccountTransaction {
        public_keys: &[public_key],
    };

    let create_account_header = create_account.to_header::<_, tiny_keccak::Sha3>(account.signer());
    let res = account
        .send_transaction_header(&create_account_header)
        .await?;

    println!(
        "Just made {} to create another account :p",
        hex::encode(&res.id)
    );

    // Add:
    let response = res.finalize(account.client()).await?;

    match response {
        Some(res) => {
            for event in res.events {
                if event.ty == "flow.AccountCreated" {
                    let payload = event.parse_payload()?;
                    let address = payload.find_field("address").unwrap().expect_address();
                    println!("Address of created account: {}", address);
                }
            }
        }
        None => {
            panic!("The transaction did not get sealed within timeout... Perhaps the network is malfunctioning?")
        }
    }

    Ok(())
}

Generate Keys

Flow uses ECDSA signatures to control access to user accounts. Each key pair can be used in combination with the SHA2-256 or SHA3-256 hashing algorithms.

Here's how to generate an ECDSA private key for the secp256k1 curve used by Bitcoin and Ethereum.

use secp256k1::{rand::rngs::EntropyRng, PublicKey, Secp256k1, SecretKey};

fn main() {
    let secp = Secp256k1::signing_only();

    // `EntropyRng` is a secure random number generator.
    let mut rng = EntropyRng::new();
    let secret_key = SecretKey::new(&mut rng);
    let public_key = PublicKey::from_secret_key(&secp, &secret_key);

    println!("Secret key: {}", hex::encode(secret_key.as_ref()));

    // https://bitcoin.stackexchange.com/a/3043
    //
    // Flow faucet only accepts hex encoded public key of length 128
    // which means the leading byte of 0x04 must be discarded.
    println!(
        "Public key: {}",
        hex::encode(&public_key.serialize_uncompressed()[1..])
    )
}

The example above uses an ECDSA key pair on the secp256k1 elliptic curve. Flow also supports the P-256 (secp256r1) curve. Read more about supported algorithms here.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Overview

Getting Started

Installing

Importing the Library

Connect

Querying the Flow Network

Get Blocks

Examples

Get Account

Examples

Get Transactions

Get Events

Examples

Get Collections

Execute Scripts

Mutate Flow Network

Transactions

Build Transactions

Sign Transactions

Single party, single signature

Single party, multiple signatures

Multiple parties

Multiple parties, two authorizers

Multiple parties, multiple signatures

Send Transactions

Create Accounts

Public Key

Generate Keys

Files

README.md

Latest commit

History

README.md

File metadata and controls

Overview

Getting Started

Installing

Importing the Library

Connect

Querying the Flow Network

Get Blocks

Examples

Get Account

Examples

Get Transactions

Get Events

Examples

Get Collections

Execute Scripts

Mutate Flow Network

Transactions

Build Transactions

Sign Transactions

Single party, single signature

Single party, multiple signatures

Multiple parties

Multiple parties, two authorizers

Multiple parties, multiple signatures

Send Transactions

Create Accounts

Public Key

Generate Keys