@flarestudio/flare-sdk
v0.1.8
Published
Official TypeScript/JavaScript SDK for Flare blockchain - Access FTSO, FDC, fAssets, Staking, and more
Maintainers
Readme
@flarestudio/flare-sdk
Official TypeScript/JavaScript SDK for Flare blockchain
🚀 Features
- FTSO (Price Feeds): Access real-time and historical price data
- FDC (Attestations): Verify cross-chain events and data
- fAssets (Bridging): Mint and redeem synthetic assets
- Wallet: Connect and interact with wallets
- Staking: Delegate and claim rewards
- State Connector: Verify blockchain state
- Utils: Helper functions for common operations
📦 Installation
npm install @flarestudio/flare-sdkor
yarn add @flarestudio/flare-sdk🎯 Quick Start
import { FlareSDK } from '@flarestudio/flare-sdk';
// Initialize SDK
const sdk = new FlareSDK({
network: 'flare', // or 'coston2', 'songbird', 'coston'
});
// Coming soon: Module examples
// const price = await sdk.ftso.getPrice('BTC/USD');
// const balance = await sdk.wallet.getBalance();🏗️ Development Status
Current Version: 0.1.0 (Alpha)
This SDK is currently under active development. Core infrastructure is complete:
- ✅ Core SDK class
- ✅ Error handling system
- ✅ Network management
- ✅ TypeScript types
- 🚧 FTSO Module (Coming soon)
- 🚧 FDC Module (Coming soon)
- 🚧 fAssets Module (Coming soon)
- 🚧 Wallet Module (Coming soon)
- 🚧 Staking Module (Coming soon)
- 🚧 State Connector Module (Coming soon)
- 🚧 Utils Module (Coming soon)
📚 Documentation
Full documentation will be available at: https://flarestudio.xyz/sdk
🤝 Contributing
Contributions are welcome! Please read our contributing guidelines before submitting PRs.
📄 License
MIT © FlareStudio
🔗 Links
Note: This SDK is in early development. APIs may change before v1.0.0 release.
