Getting Started

Overview

@growae/reactive is the framework-agnostic foundation for interacting with the Aeternity blockchain. It provides type-safe actions for sending transactions, reading balances, working with Sophia contracts, AENS names, oracles, and state channels.

Quick Start

1. Install

npm

npm install @growae/reactive

yarn

yarn add @growae/reactive

pnpm

pnpm add @growae/reactive

2. Create a Config

import { createConfig } from '@growae/reactive'
import { testnet } from '@growae/reactive/networks'
import { superhero } from '@growae/reactive/connectors'

const config = createConfig({
  networks: [testnet],
  connectors: [superhero()],
})

3. Use Actions

import { getBalance, spend } from '@growae/reactive/actions'

// Read balance
const balance = await getBalance(config, {
  address: 'ak_2dA...',
})
console.log(balance) // { aettos: 1000000000000000000n, ae: '1.0' }

// Send AE (TTL defaults to 300 blocks)
const result = await spend(config, {
  recipient: 'ak_2dA...',
  amount: '1.5', // in AE
})

Default TTL

All transactions in Reactive default to a TTL of 300 blocks (~15 hours) above the current height. This prevents stale transactions from lingering in the mempool indefinitely.

You can override this per-action:

await spend(config, {
  recipient: 'ak_2dA...',
  amount: '1.0',
  ttl: 0, // no expiration
})

Or set a custom TTL:

await spend(config, {
  recipient: 'ak_2dA...',
  amount: '1.0',
  ttl: 100, // 100 blocks (~5 hours)
})

Next Steps

• Installation — detailed install guide
• Configuration — learn about createConfig options
• Connectors — all available wallet connectors (Superhero, Ledger, MetaMask Snap, and more)
• Networks — configure mainnet, testnet, or custom networks
• AENS Guide — register and manage .chain names
• Contracts Guide — deploy and call Sophia contracts