Nectar SDK & API
StartRelease
v1.6
v1.6
  • Introduction
  • Quick Start
  • Installation
  • Actions
    • getAllMarkets
    • getMarket
    • getMarketByTicker
    • getAllMarket24h
    • getMarket24h
    • getChains
    • getTokens
    • getAllOrders
    • getOpenOrders
    • getChart
    • getTrades
    • getBidAsk
    • transferToTradingWallet
    • transferToFundingWallet
    • buyLimit
    • sellLimit
    • buyMarketTotal
    • sellMarketAmount
    • cancelOrder
  • Types
    • BidAsk
    • Chain
    • Contract
    • Kline
    • Market
    • MarketQuote
    • NectarTransferResult
    • Order
    • Paginated
    • Token
    • Trade
    • Transaction
  • Enums
    • ChainType
    • ContractType
    • KLineInterval
    • OrderStatus
    • OrderType
    • TokenType
    • TransactionStatus
  • API Specifications
    • Header
    • Exchange Info
    • Markets 24hr Summary
    • Market History
    • Market Trades
    • Cancel Order
    • Opened User Orders
    • All User Orders
  • Release Notes
  • License and Copyright
Powered by GitBook
On this page
  • Usage
  • Parameters
  • Options
  • Returns
  1. Actions

transferToFundingWallet

The transferToFundingWallet() method of Nectar instances transfers a token from a trading wallet to the user's Web3 (funding) wallet.

Usage

import { Nectar } from "@wasd3rplay/nectar-sdk";

const nectar = new Nectar();

const ticker = "WETH_ETHSEPOLIA";

const market = await nectar.getMarketByTicker(ticker);
const res = await nectar.transferToFundingWallet(ticker, "10.5", market);

Parameters

  • ticker: string

    • A ticker of the token to transfer.

    • It is a combination of a symbol, an underscore, and a chain symbol.

    • E.g., USDT_ETHSEPOLIA

  • amount: string

    • The amount of token to transfer.

  • market: Market

    • A market whose base ticker or quote ticker matches the given ticker.

Options

  • signer?: Wallet

    • Optional

    • Default to userWallet property of Nectar instances.

    • A wallet placing the order.

Returns

  • NectarTransferResult

    • A result of the transaction.

Last updated 1 year ago