Skip to content

lorinaplugs-dev/bags-sdk

 
 

Repository files navigation

@bagsfm/bags-sdk

npm version npm downloads license TypeScript Solana

A TypeScript SDK for interacting with the Bags Public API - Solana token launch and management platform.

Installation

npm install @bagsfm/bags-sdk

Usage

import { BagsSDK } from '@bagsfm/bags-sdk';
import { Connection, PublicKey } from '@solana/web3.js';

// Initialize the SDK
const connection = new Connection('https://mainnet.helius-rpc.com/?api-key=your-helius-api-key'); // Or any other RPC provider
const sdk = new BagsSDK('your-bags-api-key', connection, 'processed');

// Use the SDK services
const tokenMint = new PublicKey('your-token-mint-address');
const creators = await sdk.state.getTokenCreators(tokenMint);
console.log('Token creators:', creators);

API Reference

BagsSDK

The main SDK class that provides access to all services:

  • bagsApiClient: HTTP API client for Bags services
  • tokenLaunch: Token launch management service
  • state: State management service
  • config: Configuration service
  • fee: Fee management service

Constructor

new BagsSDK(apiKey: string, connection: Connection, commitment?: Commitment)

Parameters:

  • apiKey: Your Bags API key
  • connection: Solana web3.js Connection instance
  • commitment: (optional) Transaction commitment level (default: 'processed')

Requirements

  • Node.js >= 18.0.0
  • A Bags API key (get one at https://dev.bags.fm)
  • A Solana RPC provider (we recommend Helius - they offer a free tier)

Development

# Install dependencies
npm install

# Build the project
npm run build

# Watch mode for development
npm run dev

# Clean build artifacts
npm run clean

License

MIT

Support

For issues and questions, please visit our GitHub Issues.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.2%
  • JavaScript 0.8%