@okutrade/account-api
Version:
TypeScript client for OKU Account API using Connect-ES
337 lines (336 loc) • 8.47 kB
TypeScript
import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
import type { Address } from "./common_pb.js";
import type { Message } from "@bufbuild/protobuf";
/**
* Describes the file gfxcafe/oku/account/v1/specialorders.proto.
*/
export declare const file_gfxcafe_oku_account_v1_specialorders: GenFile;
/**
* HistoryRequest for querying order history
*
* @generated from message gfxcafe.oku.account.v1.HistoryRequest
*/
export type HistoryRequest = Message<"gfxcafe.oku.account.v1.HistoryRequest"> & {
/**
* List of addresses to query (max 10)
*
* @generated from field: repeated gfxcafe.oku.account.v1.Address addresses = 1;
*/
addresses: Address[];
/**
* Optional chain IDs to filter results
*
* @generated from field: repeated int32 chain_ids = 2;
*/
chainIds: number[];
};
/**
* Describes the message gfxcafe.oku.account.v1.HistoryRequest.
* Use `create(HistoryRequestSchema)` to create a new message.
*/
export declare const HistoryRequestSchema: GenMessage<HistoryRequest>;
/**
* HistoryResponse with order data
*
* @generated from message gfxcafe.oku.account.v1.HistoryResponse
*/
export type HistoryResponse = Message<"gfxcafe.oku.account.v1.HistoryResponse"> & {
/**
* List of special orders
*
* @generated from field: repeated gfxcafe.oku.account.v1.SpecialOrder orders = 1;
*/
orders: SpecialOrder[];
/**
* Total number of orders
*
* @generated from field: int32 total = 2;
*/
total: number;
};
/**
* Describes the message gfxcafe.oku.account.v1.HistoryResponse.
* Use `create(HistoryResponseSchema)` to create a new message.
*/
export declare const HistoryResponseSchema: GenMessage<HistoryResponse>;
/**
* SpecialOrder represents a unified order format
*
* @generated from message gfxcafe.oku.account.v1.SpecialOrder
*/
export type SpecialOrder = Message<"gfxcafe.oku.account.v1.SpecialOrder"> & {
/**
* Chain ID
*
* @generated from field: int32 chain_id = 1;
*/
chainId: number;
/**
* Created time (unix timestamp)
*
* @generated from field: int32 created_time = 2;
*/
createdTime: number;
/**
* Transaction hash
*
* @generated from field: string tx_hash = 3;
*/
txHash: string;
/**
* Sell token details
*
* @generated from field: gfxcafe.oku.account.v1.TokenDetails sell_token = 4;
*/
sellToken?: TokenDetails;
/**
* Buy token details
*
* @generated from field: gfxcafe.oku.account.v1.TokenDetails buy_token = 5;
*/
buyToken?: TokenDetails;
/**
* Input side (BUY/SELL)
*
* @generated from field: string input_side = 6;
*/
inputSide: string;
/**
* Order status
*
* @generated from field: string status = 7;
*/
status: string;
/**
* Order type (limit/market/special)
*
* @generated from field: string type = 8;
*/
type: string;
/**
* Price
*
* @generated from field: double price = 9;
*/
price: number;
/**
* Is price flipped
*
* @generated from field: bool is_flipped = 10;
*/
isFlipped: boolean;
/**
* Pool address (for limit orders)
*
* @generated from field: string pool = 11;
*/
pool: string;
/**
* Limit order details
*
* @generated from field: gfxcafe.oku.account.v1.BatchOrderViewData limit_order_full = 12;
*/
limitOrderFull?: BatchOrderViewData;
/**
* Amount filled
*
* @generated from field: string amount_filled = 13;
*/
amountFilled: string;
/**
* Total amount
*
* @generated from field: string amount_total = 14;
*/
amountTotal: string;
/**
* V2 order data
*
* @generated from field: gfxcafe.oku.account.v1.V2OrderData v2_order_data = 15;
*/
v2OrderData?: V2OrderData;
};
/**
* Describes the message gfxcafe.oku.account.v1.SpecialOrder.
* Use `create(SpecialOrderSchema)` to create a new message.
*/
export declare const SpecialOrderSchema: GenMessage<SpecialOrder>;
/**
* TokenDetails represents token information with amount
*
* @generated from message gfxcafe.oku.account.v1.TokenDetails
*/
export type TokenDetails = Message<"gfxcafe.oku.account.v1.TokenDetails"> & {
/**
* Token address
*
* @generated from field: string address = 1;
*/
address: string;
/**
* Token amount
*
* @generated from field: double amount = 2;
*/
amount: number;
};
/**
* Describes the message gfxcafe.oku.account.v1.TokenDetails.
* Use `create(TokenDetailsSchema)` to create a new message.
*/
export declare const TokenDetailsSchema: GenMessage<TokenDetails>;
/**
* BatchOrderViewData represents batch order details
*
* @generated from message gfxcafe.oku.account.v1.BatchOrderViewData
*/
export type BatchOrderViewData = Message<"gfxcafe.oku.account.v1.BatchOrderViewData"> & {
/**
* Order ID
*
* @generated from field: string id = 1;
*/
id: string;
/**
* Direction
*
* @generated from field: bool direction = 2;
*/
direction: boolean;
/**
* Upper tick
*
* @generated from field: int32 tick_upper = 3;
*/
tickUpper: number;
/**
* Lower tick
*
* @generated from field: int32 tick_lower = 4;
*/
tickLower: number;
/**
* User count
*
* @generated from field: uint64 user_count = 5;
*/
userCount: bigint;
/**
* Batch ID
*
* @generated from field: string batch_id = 6;
*/
batchId: string;
/**
* Token0 amount
*
* @generated from field: string token0_amount = 7;
*/
token0Amount: string;
/**
* Token1 amount
*
* @generated from field: string token1_amount = 8;
*/
token1Amount: string;
/**
* Head
*
* @generated from field: string head = 9;
*/
head: string;
/**
* Tail
*
* @generated from field: string tail = 10;
*/
tail: string;
/**
* Base currency
*
* @generated from field: string base_currency = 11;
*/
baseCurrency: string;
/**
* Quote currency
*
* @generated from field: string quote_currency = 12;
*/
quoteCurrency: string;
};
/**
* Describes the message gfxcafe.oku.account.v1.BatchOrderViewData.
* Use `create(BatchOrderViewDataSchema)` to create a new message.
*/
export declare const BatchOrderViewDataSchema: GenMessage<BatchOrderViewData>;
/**
* V2OrderData represents additional data for V2 orders
*
* @generated from message gfxcafe.oku.account.v1.V2OrderData
*/
export type V2OrderData = Message<"gfxcafe.oku.account.v1.V2OrderData"> & {
/**
* Order ID
*
* @generated from field: string order_id = 1;
*/
orderId: string;
/**
* Take profit price
*
* @generated from field: string take_profit_price = 2;
*/
takeProfitPrice: string;
/**
* Stop price
*
* @generated from field: string stop_price = 3;
*/
stopPrice: string;
/**
* Stop limit price
*
* @generated from field: string stop_limit_price = 4;
*/
stopLimitPrice: string;
/**
* Take profit slippage
*
* @generated from field: int32 take_profit_slippage = 5;
*/
takeProfitSlippage: number;
/**
* Stop loss slippage
*
* @generated from field: int32 stop_loss_slippage = 6;
*/
stopLossSlippage: number;
/**
* Amount out
*
* @generated from field: string amount_out = 7;
*/
amountOut: string;
};
/**
* Describes the message gfxcafe.oku.account.v1.V2OrderData.
* Use `create(V2OrderDataSchema)` to create a new message.
*/
export declare const V2OrderDataSchema: GenMessage<V2OrderData>;
/**
* SpecialOrdersService provides unified order history functionality
*
* @generated from service gfxcafe.oku.account.v1.SpecialOrdersService
*/
export declare const SpecialOrdersService: GenService<{
/**
* Get order history across multiple chains (/specialorders/history)
*
* @generated from rpc gfxcafe.oku.account.v1.SpecialOrdersService.History
*/
history: {
methodKind: "unary";
input: typeof HistoryRequestSchema;
output: typeof HistoryResponseSchema;
};
}>;