Quick Start

Get started with QFC in 5 minutes.

Prerequisites

• Node.js 18+ or Bun
• npm, yarn, or pnpm

1. Install the SDK

npm

npm install @qfc/sdk

yarn

yarn add @qfc/sdk

pnpm

pnpm add @qfc/sdk

bun

bun add @qfc/sdk

2. Connect to the Network

import { QfcProvider, NETWORKS } from '@qfc/sdk';

// Connect to testnet
const provider = new QfcProvider(NETWORKS.testnet.rpcUrl);

// Get network info
const blockNumber = await provider.getBlockNumber();
console.log('Current block:', blockNumber);

// Get validators
const validators = await provider.getValidators();
console.log('Active validators:', validators.length);

3. Query Balances

import { formatQfc } from '@qfc/sdk';

const address = '0x742d35Cc6634C0532925a3b844Bc9e7595f...';
const balance = await provider.getBalance(address);

console.log('Balance:', formatQfc(balance), 'QFC');

4. Create a Wallet

import { QfcWallet, parseQfc } from '@qfc/sdk';

// From private key
const wallet = new QfcWallet(privateKey, provider);

// Or create a new wallet
const { wallet: newWallet, mnemonic } = QfcWallet.createRandomWithMnemonic(provider);
console.log('Save this mnemonic:', mnemonic);

// Check balance
const balance = await wallet.getBalance();

5. Send a Transaction

// Send QFC
const tx = await wallet.sendTransaction({
  to: '0xRecipientAddress...',
  value: parseQfc('10'), // 10 QFC
});

console.log('Transaction hash:', tx.hash);

// Wait for confirmation
const receipt = await tx.wait();
console.log('Confirmed in block:', receipt.blockNumber);

6. Interact with Smart Contracts

import { getERC20 } from '@qfc/sdk';

// Get token contract
const token = await getERC20('0xTokenAddress...', provider);

console.log('Token:', token.name, token.symbol);

// Check balance
const balance = await token.balanceOf(wallet.address);
console.log('Token balance:', balance);

// Transfer (with signer)
const tokenWithSigner = await getERC20('0xTokenAddress...', wallet);
const tx = await tokenWithSigner.transfer('0xRecipient...', 1000n);

7. Stake QFC

// Stake tokens
const stakeTx = await wallet.stake(parseQfc('1000'));
await stakeTx.wait();

// Check stake info
const stakeInfo = await wallet.getStakeInfo();
console.log('Staked:', formatQfc(stakeInfo.stakedAmount), 'QFC');
console.log('Pending rewards:', formatQfc(stakeInfo.pendingRewards), 'QFC');

// Claim rewards
const claimTx = await wallet.claimRewards();
await claimTx.wait();

Get Testnet Tokens

Visit the Testnet Faucet to get free testnet QFC tokens.

Next Steps

• Installation - Detailed installation guide
• JavaScript SDK - Full SDK documentation
• Deploy a Contract - Deploy your first smart contract
• Build a DApp - Step-by-step tutorial