Skip to content

Toolkit to work with Orca API, and Solana Transactions

Notifications You must be signed in to change notification settings

cryptoscan-pro/orca-sdk

Repository files navigation

@cryptoscan/orca-sdk

The fastest and easiest way to trade on Orca.

  • Get rate/price of coin in USD/Solana
  • Buy/Sell coin
  • Transfer coins to another wallet
  • Transfer solana to another wallet

[GitHub] [Our website] [Docs] [Discord]

Getting started

Let's see our Project example

npm install @cryptoscan/orca-sdk

Buy Example

Request

  • wallet - wallet keypair (by secret key)
  • sol - amount of SOL to buy, (Optional) if empty - all balance
  • coinAddress - coin address
  • fee - amount of SOL to pay fee (Optional)
  • payerWallet - payer wallet keypair (Optional)
  • slippage - amount of slippage (Default: 1)
  • priorityFee - amount of SOL to pay priority fee (Optional)

Response

txid string - transaction hash

import { getWallet } from '@cryptoscan/solana-wallet-sdk';
import { OrcaApi } from '@cryptoscan/orca-sdk';

const wallet = getWallet(process.env.SECRET_KEY!);
const coinAddress = 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v';
const sol = 0.05;
const api = new OrcaApi();

api.buy({
  wallet,
  coinAddress,
  sol,
})

Sell Example

Request

  • wallet - wallet keypair (by secret key)
  • sol - amount of SOL to sell, (Optional) if empty - all balance
  • coinAddress - coin address
  • fee - amount of SOL to pay fee (Optional)
  • payerWallet - payer wallet keypair (Optional)
  • slippage - amount of slippage (Default: 10)
  • priorityFee - amount of SOL to pay priority fee (Optional)

Response

txid string - transaction hash

import { getWallet } from '@cryptoscan/solana-wallet-sdk';
import { OrcaApi } from '@cryptoscan/orca-sdk';

const wallet = getWallet(process.env.SECRET_KEY!);
const coinAddress = 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v';
const sol = undefined; // Sell all
const api = new OrcaApi();

api.sell({
  wallet,
  coinAddress,
  sol,
})

Transfer Solana Example

Request

  • wallet - wallet keypair (by secret key)
  • sol - amount of SOL to transfer, (Optional) if empty - all balance
  • coinAddress - coin address (Optional)
  • fee - amount of SOL to pay fee (Optional)
  • payerWallet - payer wallet keypair (Optional)

Response

txid string - transaction hash

import { getWallet } from '@cryptoscan/solana-wallet-sdk';
import { OrcaApi } from '@cryptoscan/orca-sdk';

const wallet = getWallet(process.env.SECRET_KEY!);
const sol = undefined; // All amount
const api = new OrcaApi();

api.transfer({
  wallet,
  sol,
})

Transfer Coins Example

Request

  • wallet - wallet keypair (by secret key)
  • sol - amount of coins in SOL to transfer, (Optional) if empty - all balance
  • coinAddress - coin address (Optional)
  • fee - amount of SOL to pay fee (Optional)
  • payerWallet - payer wallet keypair (Optional)

Response

txid string - transaction hash

import { getWallet } from '@cryptoscan/solana-wallet-sdk';
import { OrcaApi } from '@cryptoscan/orca-sdk';

const wallet = getWallet(process.env.SECRET_KEY!);
const coinAddress = 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v';
const sol = 0.01;
const api = new OrcaApi();

api.transfer({
  wallet,
  coinAddress,
  sol,
})

Listen transactions

Request

  • coinAddress - coin address
  • callback - listen transaction callback
    • tx - transaction hash
    • baseAmount - amount of base coin
    • quoteAmount - amount of quote coin
    • amount - amount of base coin
import { OrcaApi } from '@cryptoscan/orca-sdk';

const api = new OrcaApi();
const coinAddress = 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v';

api.listenTransactions(coinAddress, (transaction) => {
  console.log(transaction)
})

FAQ

Is it secure to use sdk with private key?

Yes. You don't share private key through api request. You sign transaction with private key locally only. Library is based on @cryptoscan/swap-sdk

Is it free?

We charge a 0.39% fee on each successful transaction instruction. If you want to decrease fee - please contact us in discord or telegram We can increase fee down to 0.1% if you will contribute us.

How to contribute?

You can create pull requests or make a project based on our packages. You have chance to get some supply for a work and get fee reduced for the api.


Contribute

To install dependencies:

npm install

To build:

npm build

This project was created using bun init in bun v1.1.0. Bun is a fast all-in-one JavaScript runtime.

About

Toolkit to work with Orca API, and Solana Transactions

Resources

Stars

Watchers

Forks

Packages

No packages published