Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ton-connect/sdk
SDK for TON Connect 2.0 — a comprehensive communication protocol between wallets and apps in TON ecosystem
https://github.com/ton-connect/sdk
connect javascript sdk ton ton-connect tonconnect tonkeeper typescript wallet
Last synced: 3 months ago
JSON representation
SDK for TON Connect 2.0 — a comprehensive communication protocol between wallets and apps in TON ecosystem
- Host: GitHub
- URL: https://github.com/ton-connect/sdk
- Owner: ton-connect
- License: apache-2.0
- Created: 2022-09-26T12:28:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T15:52:25.000Z (3 months ago)
- Last Synced: 2024-08-15T14:10:09.057Z (3 months ago)
- Topics: connect, javascript, sdk, ton, ton-connect, tonconnect, tonkeeper, typescript, wallet
- Language: TypeScript
- Homepage:
- Size: 6.72 MB
- Stars: 231
- Watchers: 7
- Forks: 62
- Open Issues: 78
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 TON Connect
Welcome to the implementation of the TonConnect protocol! Before diving in, here's where to start:
- Easily connect users to your Dapp and start blockchain interactions:
- [TON Connect UI React](https://www.npmjs.com/package/@tonconnect/ui-react): Seamlessly integrate wallet connection components into your React app.
- [TON Connect UI](https://www.npmjs.com/package/@tonconnect/ui): Quickly add wallet connection components to your Dapp.
- For detailed information about the TonConnect protocol, visit the [official documentation](https://docs.ton.org/develop/dapps/ton-connect/overview).
- [📚 Latest API documentation](https://ton-connect.github.io/sdk/)
## 📦 Packages
The repository contains the following packages:
- [**@tonconnect/sdk**](https://www.npmjs.com/package/@tonconnect/sdk)
- [**@tonconnect/protocol**](https://www.npmjs.com/package/@tonconnect/protocol)
- [**@tonconnect/ui**](https://www.npmjs.com/package/@tonconnect/ui)
- [**@tonconnect/ui-react**](https://www.npmjs.com/package/@tonconnect/ui-react)
---
## 📘 TON Connect SDK
- **GitHub**: [link](https://github.com/ton-connect/sdk/tree/main/packages/sdk)
- **npm**: [link](https://www.npmjs.com/package/@tonconnect/sdk)
- **API Documentation**: [link](https://ton-connect.github.io/sdk/modules/_tonconnect_sdk.html)
Use this package to connect your app to TON wallets via the TonConnect protocol.
A full description can be found in the link above.
---
## 📗 TON Connect Protocol Models
- **GitHub**: [link](https://github.com/ton-connect/sdk/tree/main/packages/protocol)
- **npm**: [link](https://www.npmjs.com/package/@tonconnect/protocol)
- **API Documentation**: [link](https://ton-connect.github.io/sdk/modules/_tonconnect_protocol.html)
This package contains protocol requests, responses, and event models, along with encoding and decoding functions. Use it to integrate TonConnect into your wallet app (written with TypeScript). For integrating TonConnect into your dApp, use [@tonconnect/sdk](https://www.npmjs.com/package/@tonconnect/sdk).
---
## 📙 TON Connect UI
- **GitHub**: [link](https://github.com/ton-connect/sdk/tree/main/packages/ui)
- **npm**: [link](https://www.npmjs.com/package/@tonconnect/ui)
- **API Documentation**: [link](https://ton-connect.github.io/sdk/modules/_tonconnect_ui.html)
TonConnect UI is a UI kit for TonConnect SDK. Use it to connect your app to TON wallets via the TonConnect protocol. It simplifies integration using UI elements like the "connect wallet button," "select wallet dialog," and confirmation modals.
---
## 📕 TON Connect UI React
- **GitHub**: [link](https://github.com/ton-connect/sdk/tree/main/packages/ui-react)
- **npm**: [link](https://www.npmjs.com/package/@tonconnect/ui-react)
- **API Documentation**: [link](https://ton-connect.github.io/sdk/modules/_tonconnect_ui_react.html)
TonConnect UI React is a React UI kit for TonConnect SDK. Use it to connect your app to TON wallets via the TonConnect protocol in React apps.
---
## 🛠️ Development
Follow the instructions in [DEVELOPERS.md](./DEVELOPERS.md) to set up the development environment.