@silvana-one/orderbook 1.1.8

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,191 @@
+# @silvana-one/orderbook
+
+Silvana Orderbook Client - A TypeScript/JavaScript client library for interacting with the Silvana Orderbook Service via gRPC.
+
+## Installation
+
+```bash
+npm install @silvana-one/orderbook
+```
+
+## Usage
+
+### Basic Setup
+
+```typescript
+import { OrderbookClient, OrderType, OrderStatus, TimeInForce } from '@silvana-one/orderbook';
+
+// Initialize the client
+const client = new OrderbookClient({
+  baseUrl: 'http://localhost:50052',
+  token: 'your-jwt-token-here'
+});
+```
+
+### Submitting Orders
+
+```typescript
+// Submit a buy order
+const response = await client.submitOrder({
+  marketId: 'BTC-USD',
+  orderType: OrderType.BID,
+  price: '50000.00',
+  quantity: '0.5',
+  timeInForce: TimeInForce.GTC,
+  expiresAt: new Date('2024-12-31'),
+  traderOrderRef: 'my-order-123'
+});
+
+if (response.success) {
+  console.log('Order submitted:', response.order);
+}
+```
+
+### Querying Orders
+
+```typescript
+// Get your active orders
+const orders = await client.getOrders({
+  marketId: 'BTC-USD',
+  status: OrderStatus.ACTIVE,
+  limit: 50
+});
+
+// Get order history
+const history = await client.getOrderHistory({
+  marketId: 'BTC-USD',
+  fromTime: new Date('2024-01-01'),
+  toTime: new Date(),
+  limit: 100
+});
+```
+
+### Market Data
+
+```typescript
+// Get orderbook depth
+const depth = await client.getOrderbookDepth({
+  marketId: 'BTC-USD',
+  depth: 20
+});
+
+console.log('Bids:', depth.orderbook?.bids);
+console.log('Offers:', depth.orderbook?.offers);
+
+// Get market data for multiple markets
+const marketData = await client.getMarketData({
+  marketIds: ['BTC-USD', 'ETH-USD']
+});
+```
+
+### Streaming Real-time Updates
+
+```typescript
+// Subscribe to orderbook updates
+const orderbookStream = client.subscribeOrderbook({
+  marketId: 'BTC-USD',
+  depth: 10
+});
+
+for await (const update of orderbookStream) {
+  console.log('Orderbook update:', update);
+}
+
+// Subscribe to your order updates
+const orderStream = client.subscribeOrders({
+  marketId: 'BTC-USD'
+});
+
+for await (const update of orderStream) {
+  console.log('Order update:', update.eventType, update.order);
+}
+```
+
+### Canceling Orders
+
+```typescript
+const cancelResponse = await client.cancelOrder({
+  orderId: BigInt(12345)
+});
+
+if (cancelResponse.success) {
+  console.log('Order cancelled');
+}
+```
+
+## API Methods
+
+### Order Management
+- `submitOrder()` - Submit a new order
+- `cancelOrder()` - Cancel an existing order
+- `getOrders()` - Get your orders
+- `getOrderHistory()` - Get historical orders
+
+### Market Data
+- `getMarkets()` - Get available markets
+- `getInstruments()` - Get tradable instruments
+- `getOrderbookDepth()` - Get orderbook depth
+- `getMarketData()` - Get market statistics
+
+### Settlements
+- `getSettlementProposals()` - Get settlement proposals
+- `getSettlements()` - Get completed settlements
+
+### Streaming (Real-time)
+- `subscribeOrderbook()` - Stream orderbook updates
+- `subscribeOrders()` - Stream order updates
+- `subscribeSettlements()` - Stream settlement updates
+
+## Types and Enums
+
+The package exports all necessary types and enums:
+
+```typescript
+import {
+  OrderType,
+  OrderStatus,
+  TimeInForce,
+  MarketType,
+  SettlementStatus,
+  type Order,
+  type Market,
+  type Instrument,
+  type Settlement,
+  type OrderbookDepth
+} from '@silvana-one/orderbook';
+```
+
+## JWT Authentication
+
+All methods require JWT authentication. The token should be signed with an Ed25519 private key and include the necessary claims for accessing the orderbook service.
+
+```typescript
+const token = generateJWT({
+  sub: 'trader-id',
+  exp: Date.now() + 3600000,
+  // ... other required claims
+});
+
+const client = new OrderbookClient({
+  baseUrl: 'http://orderbook-service:50052',
+  token
+});
+```
+
+## Error Handling
+
+All async methods may throw errors. It's recommended to wrap calls in try-catch blocks:
+
+```typescript
+try {
+  const response = await client.submitOrder({
+    // ... order parameters
+  });
+} catch (error) {
+  console.error('Failed to submit order:', error);
+}
+```
+
+## License
+
+Apache-2.0

package/dist/node/grpc.d.ts

@@ -0,0 +1,151 @@
+export * from "./proto/silvana/orderbook/v1/orderbook_pb.js";
+import { type GetOrdersResponse, type GetOrderbookDepthResponse, type GetSettlementProposalsResponse, type GetInstrumentsResponse, type GetMarketsResponse, type GetOrderHistoryResponse, type GetMarketDataResponse, type GetSettlementsResponse, type SubmitOrderResponse, type CancelOrderResponse, OrderType, OrderStatus, TimeInForce, MarketType, SettlementStatus } from "./proto/silvana/orderbook/v1/orderbook_pb.js";
+export { OrderType, OrderStatus, TimeInForce, MarketType, SettlementStatus };
+/**
+ * Custom error class for Orderbook client errors
+ */
+export declare class OrderbookError extends Error {
+    code?: string | undefined;
+    details?: any | undefined;
+    constructor(message: string, code?: string | undefined, details?: any | undefined);
+}
+/**
+ * Orderbook client configuration
+ */
+export interface OrderbookClientConfig {
+    /** Base URL of the orderbook service (e.g., "http://localhost:50052") */
+    baseUrl: string;
+    /** JWT token for authentication */
+    token: string;
+}
+/**
+ * Orderbook client for interacting with the Silvana Orderbook Service
+ */
+export declare class OrderbookClient {
+    private client;
+    private token;
+    /**
+     * Creates a new OrderbookClient instance
+     * @param config Client configuration
+     */
+    constructor(config: OrderbookClientConfig);
+    /**
+     * Creates JWT auth object
+     */
+    private createAuth;
+    /**
+     * Wraps async calls with error handling
+     */
+    private wrapCall;
+    /**
+     * Get orders for the authenticated user
+     */
+    getOrders(params?: {
+        marketId?: string;
+        status?: OrderStatus;
+        orderType?: OrderType;
+        limit?: number;
+        offset?: number;
+    }): Promise<GetOrdersResponse>;
+    /**
+     * Get orderbook depth for a market
+     */
+    getOrderbookDepth(params: {
+        marketId: string;
+        depth?: number;
+    }): Promise<GetOrderbookDepthResponse>;
+    /**
+     * Get settlement proposals for the authenticated user
+     */
+    getSettlementProposals(params?: {
+        marketId?: string;
+        status?: SettlementStatus;
+        limit?: number;
+        offset?: number;
+    }): Promise<GetSettlementProposalsResponse>;
+    /**
+     * Get available instruments
+     */
+    getInstruments(params: {
+        instrumentType?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<GetInstrumentsResponse>;
+    /**
+     * Get available markets
+     */
+    getMarkets(params?: {
+        marketType?: MarketType;
+        baseInstrument?: string;
+        quoteInstrument?: string;
+        activeOnly?: boolean;
+        limit?: number;
+        offset?: number;
+    }): Promise<GetMarketsResponse>;
+    /**
+     * Get order history for the authenticated user
+     */
+    getOrderHistory(params: {
+        marketId?: string;
+        fromTime?: Date;
+        toTime?: Date;
+        limit?: number;
+        offset?: number;
+    }): Promise<GetOrderHistoryResponse>;
+    /**
+     * Get market data
+     */
+    getMarketData(params: {
+        marketIds?: string[];
+    }): Promise<GetMarketDataResponse>;
+    /**
+     * Get settlements (completed) for the authenticated user
+     */
+    getSettlements(params: {
+        marketId?: string;
+        fromTime?: Date;
+        toTime?: Date;
+        limit?: number;
+        offset?: number;
+    }): Promise<GetSettlementsResponse>;
+    /**
+     * Submit a new order
+     */
+    submitOrder(params: {
+        marketId: string;
+        orderType: OrderType;
+        price: string;
+        quantity: string;
+        timeInForce: TimeInForce;
+        expiresAt?: Date;
+        traderOrderRef?: string;
+        credentials?: any;
+        requirements?: any;
+        metadata?: any;
+    }): Promise<SubmitOrderResponse>;
+    /**
+     * Cancel an existing order
+     */
+    cancelOrder(params: {
+        orderId: bigint;
+    }): Promise<CancelOrderResponse>;
+    /**
+     * Subscribe to orderbook updates (streaming)
+     */
+    subscribeOrderbook(params: {
+        marketId: string;
+        depth?: number;
+    }): AsyncIterable<import("./proto/silvana/orderbook/v1/orderbook_pb.js").OrderbookUpdate>;
+    /**
+     * Subscribe to order updates (streaming)
+     */
+    subscribeOrders(params: {
+        marketId?: string;
+    }): AsyncIterable<import("./proto/silvana/orderbook/v1/orderbook_pb.js").OrderUpdate>;
+    /**
+     * Subscribe to settlement updates (streaming)
+     */
+    subscribeSettlements(params: {
+        marketId?: string;
+    }): AsyncIterable<import("./proto/silvana/orderbook/v1/orderbook_pb.js").SettlementUpdate>;
+}