purple-goctopus

module
v0.0.0-...-eb215bf Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2024 License: MIT

README

Purple Goctopus

Unofficial Golang SDKs and integration utilities for Kraken products.

Status: Work in progress

Currently, only the REST and the Websocket SDKs for the Kraken spot exchange are fully implemented and have unit tests and/or integration tests. Integration tests are designed to use validation features: No order should be created and no fee should be charged (please, verify). It is recommended to run the tests with a separate account as target as cancel requests, especially the Cancel All Orders ones, can cancel orders.

Run unit tests only

go test -cover -short ./...

Run integration tests

export KRAKEN_API_KEY="SECRET"
export KRAKEN_API_SECRET="SECRET"
export KRAKEN_API_OTP="SECRET"
go test -p 1 -cover ./...

Hint: The second factor is optional. Use KRAKEN_API_OTP only if you defined a password second factor for your API key.

Principles

  • Based only on standard Go libraries and on some self-developped frameworks (gosette & gowse)
  • Fully configurable, all spare parts are visible and customizable
  • Built-in observability with the OpenTelemetry framework
  • Data feeds (ticker, ohlc, ...) use CloudEvent to encapsulate received data and enable end to end traceability with OpenTelemetry.
  • All security options provided by Kraken (password second factor) are supported

Directories

Path Synopsis
sdk
noncegen
This package provides an interface and several implementations for a nonce generator.
This package provides an interface and several implementations for a nonce generator.
spot/websocket
This package provides interfaces and implementations for websocket clients using Kraken spot websocket API (both public and private environments)
This package provides interfaces and implementations for websocket clients using Kraken spot websocket API (both public and private environments)
spot/websocket/messages
This package contains definitions of messages exchanged when interacting with Kraken spot websocket API.
This package contains definitions of messages exchanged when interacting with Kraken spot websocket API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL