rinowallet/sdk repository overview

⁠Intro to the RINO SDK (beta)

The RINO SDK runs as a sidecar container, exposing a simplified API for your application's consumption. It acts as an intermediary, or proxy, to the RINO servers. The SDK handles all client-side credentials, keys and cryptographic functionality in complete isolation from RINO. It can be run anywhere that runs docker...

API functionality includes, for example:

• fetching the wallet balance and transaction data
• sending transactions
• generating subaddresses

⁠RINO SDK Usage

The SDK can be used for Stagenet or Mainnet wallets. By default, the SDK is configured to use Stagenet. We recommend you develop and test your software against the Stagenet environment.

Stagenet RINO: https://test.rino.io⁠

Mainnet RINO: https://rino.io⁠

Note: the SDK is currently in BETA

⁠Requirements

• A RINO Enterprise account on relevant platform (https://rino.io⁠ for Mainnet, or https://test.rino.io⁠ for Stagenet)
• A wallet created in your RINO account, with SDK access enabled (in Wallet's settings tab in RINO)
• API key
• RINO wallet ID - a UUID string, get this from the Wallet's settings tab in RINO

⁠Environment Variables

• RINO_API_KEY: RINO account API Key.
• RINO_ACCOUNT_PASSWORD: RINO account password. Used for encryption / decryption.
• RINO_WALLET_ID: RINO Wallet Id to be connected to the SDK instance (a UUID string, get this from the Wallet's settings tab in RINO).
• RINO_ENV: Optional. Type of environment. Allows only test (Stagenet) and prod (Mainnet) values. Defaults to test.
• RINO_PORT: Optional. Port on which the SDK is running. Defaults to 3000.

⁠Now run a container

docker run -e RINO_ENV=test -e RINO_API_KEY=api_a0dxxxxxxxxxxxxxx -e RINO_ACCOUNT_PASSWORD=xxxxxxxx -e RINO_WALLET_ID=xxx49056-71ac-4fb5-8a83-6fd00c8xxxxx --rm -d -p 127.0.0.1:3000:3000 rinowallet/sdk:latest

⁠SDK API Documentation

When the SDK container is running (using above command), there is live "playground" documentation at http://localhost:3000/docs⁠ - you can interact with your wallet in real time.

⁠Docker Content Trust

We sign all tags, so you can trust the images by enabling Docker Content Trust.

EG. export DOCKER_CONTENT_TRUST=1 before running docker run ...

⁠Source code

Source code can be found at https://github.com/rino-wallet/sdk⁠