@vulcan-sol/sdk
v1.0.0
Published
An NPM package that is used for the Vulcan Rounting Engine implementation
Maintainers
Readme
@vulcan-sol/sdk
Welcome to the @vulcan-sol/sdk package, a software development kit designed to interact seamlessly with the Vulcan Router API on the Solana blockchain. This package provides a robust and user-friendly set of functions to facilitate token swaps and transaction management.
Installation
Install the package using npm:
npm install @vulcan-sol/sdkGetting Started
Initialization
First, initialize the Router class with your API key:
import Vulcan from '@vulcan-sol/sdk';
// OR
const Vulcan = require('@vulcan-sol/sdk');
const location = "closest" // frankfurt, nyc, closest
const vulcanSdk = new Vulcan(location, apiKey);Functions Overview
Token Swaps
- getSwapBest
- getSwapCustom
Transaction Management
- createTransaction
- sendTransaction
- simulateTransaction
Quote Retrieval
- getQuoteBest
- getQuoteCustom
Info
- getProviders
- getMint
- getMintBatch
- getPools
- getWalletBalance
Documentation
For detailed information on how to use each function, including installation instructions, usage examples, and API references, please visit our comprehensive documentation at Vulcan Documentation.
Thank you for using the @vulcan-sol/sdk package. We hope it helps you integrate with the Vulcan Router API effortlessly and effectively. Happy coding!
