SDK
SDK introduction
A Software Development Kit (SDK) is a collection of tools, libraries, and documentation designed to help developers build applications efficiently. SDKs provide pre-built functions, APIs, and utilities that eliminate the need to write code from scratch, making development faster and more reliable. Whether for mobile apps, cloud integrations, or blockchain applications, SDKs streamline the process by offering standardized solutions that ensure compatibility and ease of use. By leveraging SDKs, developers can focus on innovation rather than the complexities of low-level coding, leading to quicker deployment and enhanced functionality.
The SettleMint Blockchain SDK is designed to simplify blockchain development and integration for enterprises and developers. It provides a modular set of tools that allow seamless interaction with the SettleMint Blockchain Transformation Platform, enabling smart contract deployment, dApp connectivity, and blockchain infrastructure management. With support for multiple blockchain protocols, developer-friendly APIs, and integrations with frameworks like JavaScript, TypeScript, and Next.js, the SDK empowers organizations to build scalable blockchain applications effortlessly. By reducing complexity and offering plug-and-play functionality, SettleMint’s SDK accelerates blockchain adoption across industries.
Key features
- Modular Design – Pick and use only the packages you need.
- Seamless Integration – Connect applications to the SettleMint platform effortlessly.
- Blockchain Agnostic – Supports multiple protocols and networks.
- Developer-Friendly – Works with JavaScript, TypeScript, CLI, and frameworks like Next.js.
- Open Source – Contributions are welcome to enhance functionality.
Getting started
Prerequisites
- Node.js or Bun: Use the latest LTS version
- Package manager: npm, bun, pnpm and yarn are supported
- SettleMint Account: Sign up at console.settlemint.com
- Personal Access Token (PAT): Required for authenticated SDK usage
SDK module overview
The SettleMint SDK is a modular suite of tools designed for seamless blockchain development. Each package is specialized for different blockchain functionalities, allowing developers to integrate only the components they need.
| Package | Description | NPM |
|---|---|---|
@settlemint/sdk-blockscout | Blockscout integration module for SettleMint SDK, enabling blockchain explorer and analytics functionality | |
@settlemint/sdk-cli | Command-line interface for SettleMint SDK, providing development tools and project management capabilities | |
@settlemint/sdk-hasura | Hasura and PostgreSQL integration module for SettleMint SDK, enabling database operations and GraphQL queries | |
@settlemint/sdk-ipfs | IPFS integration module for SettleMint SDK, enabling decentralized storage and content addressing | |
@settlemint/sdk-js | Core JavaScript SDK for integrating SettleMint's blockchain platform services into your applications | |
@settlemint/sdk-mcp | MCP interface for SettleMint SDK, providing development tools and project management capabilities | |
@settlemint/sdk-minio | MinIO integration module for SettleMint SDK, providing S3-compatible object storage capabilities | |
@settlemint/sdk-next | Next.js integration module for SettleMint SDK, providing React components and middleware for web applications | |
@settlemint/sdk-portal | Portal API client module for SettleMint SDK, providing access to smart contract portal services and APIs | |
@settlemint/sdk-thegraph | TheGraph integration module for SettleMint SDK, enabling querying and indexing of blockchain data through subgraphs | |
@settlemint/sdk-utils | Shared utilities and helper functions for SettleMint SDK modules | |
@settlemint/sdk-viem | Viem (TypeScript Interface for Ethereum) module for SettleMint SDK |
How to contribute
We welcome contributions from the community! Please check out our Contributing guide to learn how you can help improve the SettleMint SDK through bug reports, feature requests, documentation updates, or code contributions.
Reporting issues
If you find a bug or have a suggestion, please open an issue on GitHub:
- Go to the Issues Page.
- Click New Issue and provide a detailed description.
License
The SettleMint SDK is released under the FSL Software License. See the LICENSE file for details.