stacksminimint-sdk
v0.1.3
Published
Official JavaScript SDK for StacksMinimint - Minimal NFT minting platform on Stacks blockchain
Maintainers
Readme
stacksminimint-sdk
The official JavaScript SDK for interacting with the StacksMinimint NFT minting platform on the Stacks blockchain.
🚀 Features
- MinimintClient: Easy-to-use client for on-chain NFT reads and transaction building.
- Explorer URLs: Generate Stacks explorer links for transactions, tokens, and addresses (mainnet/testnet).
- Contract Constants: All deployed contract addresses and function names.
- Mainnet/Testnet Support: Unified interface for both networks.
📦 Installation
npm install stacksminimint-sdk🛠️ Quick Start
Mint an NFT
import { MinimintClient } from 'stacksminimint-sdk';
const client = new MinimintClient('mainnet');
// Get mint transaction options (use with @stacks/connect)
const mintOptions = client.getMintOptions();Check Token Ownership
import { MinimintClient } from 'stacksminimint-sdk';
const client = new MinimintClient('mainnet');
const owner = await client.getOwner(1);
console.log('Token #1 owner:', owner);Explorer URLs
import { getExplorerUrl, getTokenExplorerUrl } from 'stacksminimint-sdk';
const txLink = getExplorerUrl('0xabc...');
const tokenLink = getTokenExplorerUrl('42', 'testnet');📖 API Reference
| Export | Description |
|--------|-------------|
| MinimintClient | Core class for blockchain interactions |
| getExplorerUrl(txId) | Explorer link for a transaction |
| getTokenExplorerUrl(tokenId) | Explorer link for a token |
| getAddressExplorerUrl(address) | Explorer link for an address |
| CONTRACT_ADDRESS | Deployed contract address |
| CONTRACT_NAME | Contract name on-chain |
| MINT_FEE | Mint fee in micro-STX |
| FUNCTIONS | Map of contract function names |
📄 License
MIT © AdekunleBamz
