Gear-JS

---

Overview

A comprehensive collection of TypeScript/JavaScript libraries, tools, and services powering the Gear Protocol ecosystem. This monorepo contains everything developers need to build, test, and deploy applications on Gear.

📦 Core Packages

@gear-js/api

The main TypeScript library for interacting with Gear nodes. Features include:

• 📤 Program creating
• 🔄 Message sending and state querying
• 🔐 Account management and transaction signing
• 📡 WebSocket subscriptions for real-time updates
• 🔍 Payloads encoding

@gear-js/ui

React components for Gear applications:

• 🎨 Pre-built UI components
• 📱 Responsive and accessible design
• 🔌 Easy integration with Gear API

@gear-js/txwrapper

Offline transaction generation for the Gear Protocol:

• 🔒 Secure offline transaction creation
• 🔗 Integration with @substrate/txwrapper-core
• 📝 Support for all Gear pallet extrinsics

🛠 Tools & Services

Gear IDEA

A development portal for Gear programs - idea.gear-tech.io

Features:

• 🔧 Gear program deployment and testing environment
• 🔄 Program interaction and testing tools
• 👛 Account and balance management
• 📊 Network monitoring

Supporting Services

Service	Description
Explorer	Node.js backend for indexed blockchain data
Squid	Data indexing service using Squid SDK
Faucet	Testnet token distribution service
Meta Storage	Program metadata management service

🚀 Getting Started

1. Clone the repository:

1git clone https://github.com/gear-tech/gear-js.git
2cd gear-js

2. Install dependencies:

1yarn install

3. Build all packages:

1yarn build

📚 Documentation

• API Documentation
• TxWrapper Guide
• UI Components

🤝 Contributing

We welcome contributions! Please create an issue or open a pull request on GitHub.

📄 License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.