https://github.com/circular-protocol/circular-js
https://github.com/circular-protocol/circular-js
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/circular-protocol/circular-js
- Owner: circular-protocol
- Created: 2024-09-27T13:27:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-28T18:48:19.000Z (over 1 year ago)
- Last Synced: 2025-01-28T19:36:23.382Z (over 1 year ago)
- Language: JavaScript
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Circular Layer 1 Blockchain Protocol Interface Library
The **Circular Layer 1 Blockchain Protocol Interface Library** is a powerful JavaScript library developed by Circular Global Ledgers, Inc. for seamless integration with the Circular blockchain ecosystem. This open-source library offers a comprehensive suite of tools designed for efficient and secure interaction with blockchain networks, managing wallets, assets, smart contracts, and more.
## 🔥 **Key Features**
- **Blockchain Interaction**: Effortlessly connect and interact with Circular's blockchain networks, enabling various network operations.
- **Smart Contracts**: Deploy, test, and interact with smart contracts with ease and efficiency.
- **Wallet Management**: Create, retrieve, and manage blockchain wallets, track balances, and execute wallet operations.
- **Asset Management**: Issue and manage assets, handle transfers, and retrieve detailed information about assets and their supply.
- **Domain Management**: Resolve blockchain domain names to wallet addresses, ensuring a secure and reliable address lookup.
- **Transaction Management**: Send transactions, track status, search and validate transactions within the blockchain.
- **Analytics**: Access and retrieve analytical data and insights related to blockchain performance and activities.
## 🚀 **Getting Started**
### Installation
To integrate the Circular library into your project, include the library directly in your HTML or JavaScript files:
```html
```
Ensure you also load dependencies like `crypto-js`, `elliptic` and `sha256` from CDN:
```html
```
## 📜 **API Reference**
For detailed information on all available methods and parameters, refer to the [API Documentation](https://circular-protocol.gitbook.io/circular-sdk/api-docs/javascript). Below is a summary of key functions:
- **`setNAGKey(key)`**: Sets the Network Access Gateway key.
- **`registerWallet(blockchain, publicKey)`**: Registers a wallet on the specified blockchain.
- **`getWalletBalance(blockchain, address, asset)`**: Retrieves the balance of a specific asset for the given wallet.
- **`sendTransaction(id, from, to, timestamp, type, payload, nonce, signature, blockchain)`**: Sends a transaction on the specified blockchain.
... and many more!
## 🤝 **Contributing**
Contributions to the Circular Library are welcome! To contribute:
1. Fork the repository.
2. Create a feature branch (`git checkout -b feature-name`).
3. Commit your changes (`git commit -m 'Add new feature'`).
4. Push to the branch (`git push origin feature-name`).
5. Open a Pull Request.
Ensure to follow the contribution guidelines and code of conduct.
## 📄 **License**
This project is open-source and available under the MIT License for both private and commercial use.
## 📌 **Version**
- Current Version: **1.0.8**
- Last Update: **10/18/2024**
## 👥 **Authors and Acknowledgment**
- **Originator**: Gianluca De Novi, PhD
- **Contributors**: Danny De Novi
## 📧 **Contact**
For support or collaboration opportunities, please reach out to [info@circularlabs.io](mailto:info@circularlabs.io).