Skip to content

Saline SDK

The Saline SDK provides a comprehensive interface for building applications on the Saline blockchain. It simplifies account management, transaction creation, signing, and interaction with Saline nodes.

Features

  • Comprehensive Account Management: Create, import, and manage accounts with BLS key pairs
  • Transaction Management: Create, sign, and send transactions with ease
  • RPC Client: Interact with Saline nodes via secure JSON-RPC
  • Async Support: Full asynchronous API for high-performance applications
  • Token Support: Built-in support for USDC, BTC, ETH, and other tokens
  • Web3-like Interface: Familiar API for blockchain developers

Installation

Requires Python ≥3.12.0, <3.13.

Install using pip:

bash
pip install saline-sdk

Developers

Install with Poetry:

bash
poetry add saline-sdk

or from source

bash

  git clone https://github.com/risingsealabs/saline-sdk.git
  cd saline-sdk

  poetry install

Auto-generated Modules

The bindings.py module is auto-generated from the Saline codebase and should not be modified directly. To provide documentation for this module, we use a separate file bindings_docstrings.py that contains docstrings that are applied at documentation build time.

This approach allows us to maintain proper documentation without modifying the auto-generated code. When bindings.py is regenerated, only the bindings_docstrings.py file needs to be updated to reflect any changes in the API.