v2_client_go is a Go SDK for interacting with the Rysk V2 API and JSON-RPC Websocket, providing tools and utilities to streamline integration and interaction with Rysk V2 services.

Rysk V2: https://app.rysk.finance/

Getting Started

Before you start, ensure you have the following installed:

Go (Golang): Ensure you have Go installed on your machine. You can download it from https://golang.org/ and follow the installation instructions for your operating system.

Installation

To install v2_client_go as a Go module, simply use go get:

$ go get github.com/rysk-finance/v2_client_go

This command will download and install v2_client_go and its dependencies.

Usage

This package follows Rysk V2 API documentation

Includes:

REST HTTP client: RyskV2APIClient
JSON RPC Websocket: RyskV2WSClient

Examples

Look here for REST API Client examples
Look here for Websocket Client examples

Testing

Before running integration tests add a new .env file in both api_client and ws_client folder following both .env.example files.

To run tests for GO v2_client_go, you can use the provided Makefile:

# Run all tests
$ make test

# Run specific tests
$ make test_utils
$ make test_api_client
$ make test_ws_client

# Run unit tests
$ make test_unit

# Run integration tests
$ make test_integration

# View test coverage
$ make coverage

Contributing

Contributions to GO v2_client_go are welcome! Follow these steps to contribute:

Fork the repository and create your branch (git checkout -b feature/myfeature).
Commit your changes (git commit -am 'Add new feature').
Push to the branch (git push origin feature/myfeature).
Create a new Pull Request.

License

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

# Packages

# README

Rysk V2 Client