Package Exports
- @piratecrewfun/pirate-sdk
- @piratecrewfun/pirate-sdk/types
Readme
Pirate SDK
A TypeScript SDK for interacting with the PiratesCrewFun API.
Installation
npm install @piratecrewfun/pirate-sdkQuick Start
import { PirateSDK, PoolParams } from "@piratecrewfun/pirate-sdk";
async function createMyCoin() {
const sdk = new PirateSDK({
secretKey: "your-base58-private-key",
network: "mainnet-beta",
rpcUrl: "https://api.mainnet-beta.solana.com",
apiKey: "your-api-key",
});
const poolParams: PoolParams = {
name: "CREW",
symbol: "CREW",
image: "https://piratecrew.fun/images/alt-twitter-profile.avif",
description: "Community Coin for the crew",
buyAmount: 0.1, // Initial buy in SOL
website: "https://crew.com",
x: "https://twitter.com/crew",
telegram: "https://t.me/crew",
LootFrom: "crew_kol",
};
try {
const result = await sdk.createCoin(poolParams);
console.log("Coin created successfully!");
console.log("Pool address:", result.poolAddress);
console.log("Coin mint:", result.mintAddress);
console.log("Transaction signatures:", result.signatures);
return result;
} catch (error) {
console.error("Failed to create Coin:", error);
throw error;
}
}
createMyCoin();Pool Parameters
interface PoolParams {
name: string; // Coin name (1-20 chars)
symbol: string; // Coin symbol (1-10 chars, uppercase)
image: string; // Path to logo image file
description?: string; // Coin description (optional)
buyAmount?: number; // Initial buy amount in SOL (default: 0)
website?: string; // Website URL (optional)
x?: string; // Twitter/X URL (optional)
telegram?: string; // Telegram URL (optional)
LootFrom?: string; // KOL handle (optional)
}Network Support
- Mainnet Beta: Production Solana network
Requirements
- Node.js 16+
- A Solana wallet with sufficient SOL for:
- Transaction fees (~0.05 SOL)
- Initial Coin purchase (if
buyAmount > 0) - Platform fees
Security Notes
- Never commit private keys to version control
- Use environment variables for sensitive data
Support
For issues and questions:
- GitHub Issues: Updating Soon
- Documentation: Updating Soon
License
MIT License - see LICENSE file for details.