Quick Start
Get up and running with Omne in under 5 minutes. This guide will walk you through installing the SDK, connecting to the network, and making your first transaction.
Prerequisites
- Node.js 18+ or Python 3.8+ or Go 1.19+
- Basic knowledge of blockchain concepts
- A text editor or IDE
Step 1: Install the SDK
Choose your preferred programming language and install the corresponding Omne SDK:
TypeScript/JavaScript
npm install @omne/sdk
# or
yarn add @omne/sdkPython
pip install omne-sdkGo
go get github.com/omne-foundation/omne-go-sdkStep 2: Connect to the Network
Initialize a client and connect to the Omne testnet:
TypeScript
import { OmneClient } from '@omne/sdk'
const client = new OmneClient({
network: 'testnet',
endpoint: 'https://testnet-rpc.omne.foundation'
})
// Check connection
const status = await client.getNetworkStatus()
console.log('Connected to Omne testnet:', status.networkId)Python
from omne_sdk import OmneClient
client = OmneClient(
network='testnet',
endpoint='https://testnet-rpc.omne.foundation'
)
# Check connection
status = client.get_network_status()
print(f'Connected to Omne testnet: {status.network_id}')Go
package main
import (
"fmt"
"log"
"github.com/omne-foundation/omne-go-sdk/client"
)
func main() {
client, err := client.NewOmneClient(&client.Config{
Network: "testnet",
Endpoint: "https://testnet-rpc.omne.foundation",
})
if err != nil {
log.Fatal(err)
}
status, err := client.GetNetworkStatus()
if err != nil {
log.Fatal(err)
}
fmt.Printf("Connected to Omne testnet: %s\n", status.NetworkID)
}Step 3: Create an Account
Generate a new account or import an existing one:
// Generate a new account
const account = await client.createAccount()
console.log('Address:', account.address)
console.log('Private key:', account.privateKey) // Store securely!
// Or import an existing account
const importedAccount = await client.importAccount('your-private-key-here')
// Get account balance
const balance = await client.getBalance(account.address)
console.log('Balance:', balance.toString(), 'OMNE')!
Security Note
Never share your private key or store it in plain text. In production, use secure key management solutions.
Step 4: Make Your First Transaction
Send a transaction on the Omne network:
// Send OMNE tokens
const transaction = await client.transfer({
from: account.address,
to: 'omne1recipient-address-here',
amount: '1000000', // 1 OMNE (in micro-OMNE)
fee: '1000' // Optional: specify custom fee
})
console.log('Transaction hash:', transaction.hash)
// Wait for confirmation
const receipt = await client.waitForTransaction(transaction.hash)
console.log('Transaction confirmed in block:', receipt.blockNumber)
console.log('Gas used:', receipt.gasUsed)Step 5: Monitor Transactions
Track transaction status and account activity:
// Get transaction details
const txDetails = await client.getTransaction(transaction.hash)
console.log('Status:', txDetails.status)
console.log('Block:', txDetails.blockNumber)
console.log('Confirmations:', txDetails.confirmations)
// Get account transaction history
const history = await client.getTransactionHistory(account.address, {
limit: 10,
offset: 0
})
history.transactions.forEach(tx => {
console.log(`${tx.hash}: ${tx.amount} OMNE to ${tx.to}`)
})
// Subscribe to real-time updates
client.onTransaction(account.address, (tx) => {
console.log('New transaction:', tx)
})Next Steps
Fast & Efficient
Your transactions will typically confirm within 3 seconds with microscopic fees. Omne's dual-layer consensus ensures both speed and security for commerce applications.