README.md•5.17 kB
<p align="center">
<img src="https://github.com/settlemint/sdk/blob/main/logo.svg" width="200px" align="center" alt="SettleMint logo" />
<h1 align="center">SettleMint SDK</h1>
<p align="center">
✨ <a href="https://settlemint.com">https://settlemint.com</a> ✨
<br/>
Integrate SettleMint into your application with ease.
</p>
</p>
<p align="center">
<a href="https://github.com/settlemint/sdk/actions?query=branch%3Amain"><img src="https://github.com/settlemint/sdk/actions/workflows/build.yml/badge.svg?event=push&branch=main" alt="CI status" /></a>
<a href="https://github.com/settlemint/sdk" rel="nofollow"><img src="https://img.shields.io/github/stars/settlemint/sdk" alt="stars"></a>
</p>
<div align="center">
<a href="https://console.settlemint.com/documentation">Documentation</a>
<span> • </span>
<a href="https://github.com/settlemint/sdk/issues">Issues</a>
<br />
</div>
## About
The SettleMint SDK provides a comprehensive set of tools and libraries for integrating blockchain functionality into your applications.
It enables seamless interaction with the SettleMint platform's features and services.
## Packages
| Name | Description | NPM |
|---------|-------------|---------|
| [`@settlemint/sdk-blockscout`](sdk/blockscout) | Blockscout integration module for SettleMint SDK, enabling blockchain explorer and analytics functionality | [](https://www.npmjs.com/package/@settlemint/sdk-blockscout) |
| [`@settlemint/sdk-cli`](sdk/cli) | Command-line interface for SettleMint SDK, providing development tools and project management capabilities | [](https://www.npmjs.com/package/@settlemint/sdk-cli) |
| [`@settlemint/sdk-eas`](sdk/eas) | Ethereum Attestation Service (EAS) integration for SettleMint SDK | [](https://www.npmjs.com/package/@settlemint/sdk-eas) |
| [`@settlemint/sdk-hasura`](sdk/hasura) | Hasura and PostgreSQL integration module for SettleMint SDK, enabling database operations and GraphQL queries | [](https://www.npmjs.com/package/@settlemint/sdk-hasura) |
| [`@settlemint/sdk-ipfs`](sdk/ipfs) | IPFS integration module for SettleMint SDK, enabling decentralized storage and content addressing | [](https://www.npmjs.com/package/@settlemint/sdk-ipfs) |
| [`@settlemint/sdk-js`](sdk/js) | Core JavaScript SDK for integrating SettleMint's blockchain platform services into your applications | [](https://www.npmjs.com/package/@settlemint/sdk-js) |
| [`@settlemint/sdk-mcp`](sdk/mcp) | MCP interface for SettleMint SDK, providing development tools and project management capabilities | [](https://www.npmjs.com/package/@settlemint/sdk-mcp) |
| [`@settlemint/sdk-minio`](sdk/minio) | MinIO integration module for SettleMint SDK, providing S3-compatible object storage capabilities | [](https://www.npmjs.com/package/@settlemint/sdk-minio) |
| [`@settlemint/sdk-next`](sdk/next) | Next.js integration module for SettleMint SDK, providing React components and middleware for web applications | [](https://www.npmjs.com/package/@settlemint/sdk-next) |
| [`@settlemint/sdk-portal`](sdk/portal) | Portal API client module for SettleMint SDK, providing access to smart contract portal services and APIs | [](https://www.npmjs.com/package/@settlemint/sdk-portal) |
| [`@settlemint/sdk-thegraph`](sdk/thegraph) | TheGraph integration module for SettleMint SDK, enabling querying and indexing of blockchain data through subgraphs | [](https://www.npmjs.com/package/@settlemint/sdk-thegraph) |
| [`@settlemint/sdk-utils`](sdk/utils) | Shared utilities and helper functions for SettleMint SDK modules | [](https://www.npmjs.com/package/@settlemint/sdk-utils) |
| [`@settlemint/sdk-viem`](sdk/viem) | Viem (TypeScript Interface for Ethereum) module for SettleMint SDK | [](https://www.npmjs.com/package/@settlemint/sdk-viem) |
## Contributing
We welcome contributions from the community! Please check out our [Contributing](https://github.com/settlemint/sdk/blob/main/.github/CONTRIBUTING.md) guide to learn how you can help improve the SettleMint SDK through bug reports, feature requests, documentation updates, or code contributions.
## License
The SettleMint SDK is released under the [FSL Software License](https://fsl.software). See the [LICENSE](https://github.com/settlemint/sdk/blob/main/LICENSE) file for more details.