send-transactions.md

title	sidebar_title	description
Send Transactions	Send Transactions	How to send transactions

Another common case is interactions that mutate network state - sending tokens from one account to another, minting new NFT, etc. Framework provides sendTransaction method to achieve this. This method have 2 different signatures.

⚠️ Required: Your project must follow the required structure it must be initialized to use the following functions.

sendTransaction(props)

Send transaction to network. Provides explicit control over how you pass values.

Arguments

props object accepts following fields:

Name	Type	Optional	Description
code	string	✅	string representation of Cadence transaction
name	string	✅	name of the file in transaction folder to use (sans .cdc extension)
args	[any]	✅	an array of arguments to pass to transaction. Optional if transaction does not expect any arguments.
signers	[Address or SignerInfo]	✅	an array of Address or SignerInfo objects representing transaction autorizers
addressMap	AddressMap	✅	name/address map to use as lookup table for addresses in import statements
transformers	[CadenceTransformer]	✅	an array of operators to modify the code, before submitting it to network

⚠️ Required: Either code or name field shall be specified. Method will throw an error if both of them are empty. If name field provided, framework will source code from file and override value passed via code field.

📣 if signers field not provided, service account will be used to authorize the transaction.

📣 Pass addressMap only in cases, when you would want to override deployed contract. Otherwide imports can be resolved automatically without explicitly passing them via addressMap field

Usage

import path from "path"
import {
  init,
  emulator,
  sendTransaction,
  getAccountAddress,
} from "@onflow/flow-js-testing"

const main = async () => {
  const basePath = path.resolve(__dirname, "../cadence")

  // Init framework
  await init(basePath)
  // Start emulator
  await emulator.start()

  // Define code and arguments we want to pass
  const code = `
    transaction(message: String){
      prepare(signer: AuthAccount){
        log(message)
      }
    }
  `
  const args = ["Hello, from Cadence"]
  const Alice = await getAccountAddress("Alice")
  const signers = [Alice]

  const [result, error] = await sendTransaction({code, args, signers})
  console.log({result}, {error})

  // Stop emulator instance
  await emulator.stop()
}

main()

sendTransaction(name, signers, args)

This signature provides simplified way to send a transaction, since most of the time you will utilize existing Cadence files.

Name	Type	Optional	Description
name	string	✅	name of the file in transaction folder to use (sans .cdc extension)
args	[any]	✅	an array of arguments to pass to transaction. Optional if transaction does not expect any arguments.
signers	[Address or SignerInfoObject]	✅	an array of Address or array of SignerInfoObject representing transaction autorizers

Usage

import path from "path"
import {
  init,
  emulator,
  sendTransaction,
  shallPass,
} from "@onflow/flow-js-testing"

const main = async () => {
  const basePath = path.resolve(__dirname, "../cadence")

  // Init framework
  await init(basePath)
  // Start emulator
  await emulator.start()

  // Define arguments we want to pass
  const args = ["Hello, Cadence"]

  const [result, error, logs] = await shallPass(
    sendTransaction("log-message", [], args)
  )
  console.log({result}, {error}, {logs})

  // Stop the emulator instance
  await emulator.stop()
}

main()