https://github.com/omnia-network/ic-websocket-sdk-js
IC Websocket for clients written in Typescript
https://github.com/omnia-network/ic-websocket-sdk-js
Last synced: 16 days ago
JSON representation
IC Websocket for clients written in Typescript
- Host: GitHub
- URL: https://github.com/omnia-network/ic-websocket-sdk-js
- Owner: omnia-network
- License: mit
- Created: 2023-07-27T17:01:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-01T21:17:50.000Z (2 months ago)
- Last Synced: 2025-03-07T22:49:04.146Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 2.28 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-internet-computer - ic-websocket-sdk - Library for interfacing with the IC via WebSocket using JavaScript. (Client Libraries (Agents) / JavaScript/TypeScript)
README
# ic-websocket-sdk-js
This repository contains the Rust implementation of IC WebSocket CDK. For more information about IC Websockets, see [IC WebSocket Gateway](https://github.com/omnia-network/ic-websocket-gateway).
# Installation
You can install the library using npm:
```bash
npm install --save ic-websocket-js
```
## Usage
Refer to the [ic_websocket_example](https://github.com/omnia-network/ic_websocket_example) repository for an example of how to use this package.
## Development
Make sure you have [pnpm](https://pnpm.io/) installed.
The **ic-websocket-sdk-js** library implementation can be found in the [src](./src/) folder.
### Testing
```bash
pnpm install
pnpm test
```
## License
MIT License. See [LICENSE](./LICENSE).
## Contributing
Feel free to open issues and pull requests.