Interface PerpSpin

Hierarchy

PerpSpin

Methods

bundle

bundle(units?: perp.PerpBundlerUnit[]): perp.PerpBundler

- Defined in src/perp/api.types.ts:283
Bundler

Parameters
- Optional units: perp.PerpBundlerUnit[]
Returns perp.PerpBundler

cancelOrder

cancelOrder(request: perp.CancelOrderRequest, unitConfig?: perp.CancelOrderConfig): Promise<perp.CancelOrderResponse>

- Defined in src/perp/api.types.ts:141
TODO

Parameters
- request: perp.CancelOrderRequest
- Optional unitConfig: perp.CancelOrderConfig
Returns Promise<perp.CancelOrderResponse>

cancelOrders

cancelOrders(request: perp.CancelOrdersRequest, unitConfig?: perp.CancelOrdersConfig): Promise<perp.CancelOrdersResponse>

- Defined in src/perp/api.types.ts:148
TODO

Parameters
- request: perp.CancelOrdersRequest
- Optional unitConfig: perp.CancelOrdersConfig
Returns Promise<perp.CancelOrdersResponse>

deposit

deposit(request: perp.DepositRequest, unitConfig?: perp.DepositConfig): Promise<perp.DepositResponse>

- Defined in src/perp/api.types.ts:129
TODO

Parameters
- request: perp.DepositRequest
- Optional unitConfig: perp.DepositConfig
Returns Promise<perp.DepositResponse>

depositStorage

depositStorage(request: DepositStorageRequest, unitConfig?: DepositStorageConfig): Promise<DepositStorageResponse>

- Defined in src/perp/api.types.ts:222
TODO

Parameters
- request: DepositStorageRequest
- Optional unitConfig: DepositStorageConfig
Returns Promise<DepositStorageResponse>

getBalance

getBalance(request: GetBalanceRequest): Promise<string>

- Defined in src/perp/api.types.ts:167
Get balance
example
```
const response = await spin.getBalance(request);
```
Parameters
- request: GetBalanceRequest
Returns Promise<string>

getBalanceFt

getBalanceFt(request: GetBalanceFtRequest): Promise<string>

- Defined in src/perp/api.types.ts:176
Get balance ft
example
```
const response = await spin.getBalanceFt(request);
```
Parameters
- request: GetBalanceFtRequest
Returns Promise<string>

getBalanceNear

getBalanceNear(request: GetBalanceNearRequest): Promise<string>

- Defined in src/perp/api.types.ts:185
Get balance near
example
```
const response = await spin.getBalanceNear(request);
```
Parameters
- request: GetBalanceNearRequest
Returns Promise<string>

getBalanceStorage

getBalanceStorage(request: GetBalanceStorageRequest): Promise<GetBalanceStorageResponse>

- Defined in src/perp/api.types.ts:194
Get balance storage
example
```
const response = await spin.getBalanceStorage(request);
```
Parameters
- request: GetBalanceStorageRequest
Returns Promise<GetBalanceStorageResponse>

getBalanceStorageBounds

getBalanceStorageBounds(request: GetBalanceStorageBoundsRequest): Promise<GetBalanceStorageBoundsResponse>

- Defined in src/perp/api.types.ts:216
TODO

Parameters
- request: GetBalanceStorageBoundsRequest
Returns Promise<GetBalanceStorageBoundsResponse>

getBalances

getBalances(request: GetBalancesRequest): Promise<string>

- Defined in src/perp/api.types.ts:113
TODO

Parameters
- request: GetBalancesRequest
Returns Promise<string>

getBaseCurrency

getBaseCurrency(): Promise<GetBaseCurrencyResponse>

- Defined in src/perp/api.types.ts:109
TODO

Returns Promise<GetBaseCurrencyResponse>

getFundingInfo

getFundingInfo(request: GetFundingInfoRequest): Promise<GetFundingInfoResponse>

- Defined in src/perp/api.types.ts:117
TODO

Parameters
- request: GetFundingInfoRequest
Returns Promise<GetFundingInfoResponse>

getMarket

getMarket(request: perp.GetMarketRequest): Promise<perp.Market>

- Defined in src/perp/api.types.ts:84
Returns market info by ID supported by the contract
example
```
const response = await spin.getMarket(request);
```
Parameters
- request: perp.GetMarketRequest
Returns Promise<perp.Market>

getMarketPrices

getMarketPrices(): Promise<GetMarketPricesResponse>

- Defined in src/perp/api.types.ts:155
TODO

Returns Promise<GetMarketPricesResponse>

getMarkets

getMarkets(): Promise<perp.GetMarketsResponse>

- Defined in src/perp/api.types.ts:93
Returns all markets info supported by the contract
example
```
const response = await spin.getMarkets();
```
Returns Promise<perp.GetMarketsResponse>

getOrder

getOrder(request: perp.GetOrderRequest): Promise<perp.Order>

- Defined in src/perp/api.types.ts:133
TODO

Parameters
- request: perp.GetOrderRequest
Returns Promise<perp.Order>

getOrderbook

getOrderbook(request: perp.GetOrderbookRequest): Promise<perp.GetOrderbookResponse>

- Defined in src/perp/api.types.ts:97
TODO

Parameters
- request: perp.GetOrderbookRequest
Returns Promise<perp.GetOrderbookResponse>

getOrders

getOrders(request: perp.GetOrdersRequest): Promise<perp.GetOrdersResponse>

- Defined in src/perp/api.types.ts:137
TODO

Parameters
- request: perp.GetOrdersRequest
Returns Promise<perp.GetOrdersResponse>

getOrdersHistory

getOrdersHistory(request: perp.GetOrdersHistoryRequest, config?: MethodConfig<perp.GetOrdersHistoryResponse>): Subscription

- Defined in src/perp/api.types.ts:276
TODO

Parameters
- request: perp.GetOrdersHistoryRequest
- Optional config: MethodConfig<perp.GetOrdersHistoryResponse>
Returns Subscription

getPositions

getPositions(request: GetPositionsRequest): Promise<GetPositionsResponse>

- Defined in src/perp/api.types.ts:121
TODO

Parameters
- request: GetPositionsRequest
Returns Promise<GetPositionsResponse>

getTrades

getTrades(request: perp.GetTradesRequest, config?: MethodConfig<perp.GetTradesResponse>): Subscription

- Defined in src/perp/api.types.ts:258
TODO

Parameters
- request: perp.GetTradesRequest
- Optional config: MethodConfig<perp.GetTradesResponse>
Returns Subscription

getTransactionStatus

getTransactionStatus(request: GetTransactionStatusRequest): Promise<FinalExecutionOutcome>

- Defined in src/perp/api.types.ts:210
TODO

Parameters
- request: GetTransactionStatusRequest
Returns Promise<FinalExecutionOutcome>

getUserTrades

getUserTrades(request: perp.GetUserTradesRequest, config?: MethodConfig<perp.GetUserTradesResponse>): Subscription

- Defined in src/perp/api.types.ts:262
TODO

Parameters
- request: perp.GetUserTradesRequest
- Optional config: MethodConfig<perp.GetUserTradesResponse>
Returns Subscription

listenAccountOrders

listenAccountOrders(request: perp.ListenAccountOrdersRequest, config?: NotifyWithStateConfig<perp.AccountOrdersState, perp.OrderInfo>): Subscription

- Defined in src/perp/api.types.ts:269
TODO

Parameters
- request: perp.ListenAccountOrdersRequest
- Optional config: NotifyWithStateConfig<perp.AccountOrdersState, perp.OrderInfo>
Returns Subscription

listenAccountTrades

listenAccountTrades(request: perp.ListenAccountTradesRequest, config?: NotifyConfig<perp.Trade>): Subscription

- Defined in src/perp/api.types.ts:251
TODO

Parameters
- request: perp.ListenAccountTradesRequest
- Optional config: NotifyConfig<perp.Trade>
Returns Subscription

listenBookL1

listenBookL1(request: perp.ListenBookL1Request, config?: NotifyConfig<perp.BookL1Notify>): Subscription

- Defined in src/perp/api.types.ts:232
TODO

Parameters
- request: perp.ListenBookL1Request
- Optional config: NotifyConfig<perp.BookL1Notify>
Returns Subscription

listenBookL2

listenBookL2(request: perp.ListenBookL2Request, config?: NotifyConfig<perp.BookL2Notify>): Subscription

- Defined in src/perp/api.types.ts:236
TODO

Parameters
- request: perp.ListenBookL2Request
- Optional config: NotifyConfig<perp.BookL2Notify>
Returns Subscription

listenBookL3

listenBookL3(request: perp.ListenBookL3Request, config?: NotifyWithStateConfig<perp.BookL3State, perp.BookL3Notify>): Subscription

- Defined in src/perp/api.types.ts:240
TODO

Parameters
- request: perp.ListenBookL3Request
- Optional config: NotifyWithStateConfig<perp.BookL3State, perp.BookL3Notify>
Returns Subscription

listenTrades

listenTrades(request: perp.ListenTradesRequest, config?: NotifyConfig<perp.Trade>): Subscription

- Defined in src/perp/api.types.ts:247
TODO

Parameters
- request: perp.ListenTradesRequest
- Optional config: NotifyConfig<perp.Trade>
Returns Subscription

placeAsk

placeAsk(request: perp.PlaceAskRequest, unitConfig?: perp.PlaceAskConfig): Promise<perp.PlaceAskResponse>

- Defined in src/perp/api.types.ts:101
TODO

Parameters
- request: perp.PlaceAskRequest
- Optional unitConfig: perp.PlaceAskConfig
Returns Promise<perp.PlaceAskResponse>

placeBid

placeBid(request: perp.PlaceAskRequest, unitConfig?: perp.PlaceBidConfig): Promise<perp.PlaceBidResponse>

- Defined in src/perp/api.types.ts:105
TODO

Parameters
- request: perp.PlaceAskRequest
- Optional unitConfig: perp.PlaceBidConfig
Returns Promise<perp.PlaceBidResponse>

transferFt

transferFt(request: TransferFtRequest, unitConfig?: TransferFtConfig): Promise<TransferFtResponse>

- Defined in src/perp/api.types.ts:203
Transfer ft
example
```
const response = await spin.transferFt(request);
```
Parameters
- request: TransferFtRequest
- Optional unitConfig: TransferFtConfig
Returns Promise<TransferFtResponse>

withdraw

withdraw(request: perp.WithdrawRequest, unitConfig?: perp.WithdrawConfig): Promise<perp.WithdrawResponse>

- Defined in src/perp/api.types.ts:125
TODO

Parameters
- request: perp.WithdrawRequest
- Optional unitConfig: perp.WithdrawConfig
Returns Promise<perp.WithdrawResponse>

Generated using TypeDoc