Merge pull request #2 from usherlabs/test/git-action

Readme Edit

Author: xlassix

README.md

@@ -8,14 +8,16 @@ A high-performance gRPC-based cryptocurrency exchange broker service that provid
 - **gRPC Interface**: High-performance RPC communication
 - **Real-time Pricing**: Optimal price discovery across exchanges
 - **Balance Management**: Real-time balance checking
+- **Order Management**: Create, track, and cancel orders
+- **Transfer Operations**: Withdraw funds to external addresses
+- **Token Conversion**: Convert between different tokens
 - **Policy Enforcement**: Configurable trading and withdrawal limits
 - **IP Authentication**: Security through IP whitelisting
 - **Type Safety**: Full TypeScript support with generated protobuf types
 
 ## Prerequisites
 
 - [Bun](https://bun.sh) (v1.2.17 or higher)
-- Node.js (v18 or higher) - for TypeScript support
 - API keys for supported exchanges (Binance, Bybit)
 
 ## Installation
@@ -56,6 +58,8 @@ BYBIT_API_SECRET=your_bybit_api_secret
 ROOCH_CHAIN_ID=BINANCE,BYBIT
 ```
 
+**Note**: API keys are only required for the exchanges you plan to use. The system will validate that required keys are provided based on the `ROOCH_CHAIN_ID` configuration.
+
 ### Policy Configuration
 
 Configure trading policies in `policy/policy.json`:
@@ -64,22 +68,36 @@ Configure trading policies in `policy/policy.json`:
 {
   "withdraw": {
     "rule": {
-      "networks": ["ARB"],
+      "networks": ["BEP20", "ARBITRUM"],
       "whitelist": ["0x9d467fa9062b6e9b1a46e26007ad82db116c67cb"],
-      "amounts": {
-        "ticker": "USDC",
-        "max": 100000,
-        "min": 1
-      }
+      "amounts": [
+        {
+          "ticker": "USDC",
+          "max": 100000,
+          "min": 1
+        },
+        {
+          "ticker": "USDT",
+          "max": 100000,
+          "min": 1
+        }
+      ]
     }
   },
   "deposit": {},
   "order": {
     "rule": {
-      "markets": ["BINANCE:ARB/USDT", "BYBIT:ARB/USDC"],
+      "markets": [
+        "BINANCE:ARB/USDT",
+        "BYBIT:ARB/USDC",
+        "BINANCE:ETH/USDT",
+        "BINANCE:BTC/ETH"
+      ],
       "limits": [
         { "from": "USDT", "to": "ETH", "min": 1, "max": 100000 },
-        { "from": "ETH", "to": "USDT", "min": 0.5, "max": 5 }
+        { "from": "ETH", "to": "USDT", "min": 0.5, "max": 5 },
+        { "from": "ARB", "to": "USDC", "min": 1, "max": 1000 },
+        { "from": "USDC", "to": "ARB", "min": 1, "max": 10000 }
       ]
     }
   }
@@ -111,11 +129,17 @@ bun run build
 # Run tests
 bun test
 
-# Run tests with coverage
-bun test --coverage
-
 # Generate protobuf types
 bun run proto-gen
+
+# Format code
+bun run format
+
+# Lint code
+bun run lint
+
+# Check code (format + lint)
+bun run check
 ```
 
 ## API Reference
@@ -163,24 +187,24 @@ Get available balance for a specific currency on a specific exchange.
 **Request:**
 ```protobuf
 message BalanceRequest {
-  string cex_key = 1;          // CEX identifier (e.g., "BINANCE", "BYBIT")
-  string symbol = 2;           // Trading pair symbol, e.g. "ARB/USDT"
+  string cex = 1;              // CEX identifier (e.g., "BINANCE", "BYBIT")
+  string token = 2;            // Token symbol, e.g. "USDT"
 }
 ```
 
 **Response:**
 ```protobuf
 message BalanceResponse {
-  double balance = 1;          // Available balance for the symbol
+  double balance = 1;          // Available balance for the token
   string currency = 2;         // Currency of the balance
 }
 ```
 
 **Example:**
 ```typescript
 const request = {
-  cex_key: "BINANCE",
-  symbol: "ARB/USDT"
+  cex: "BINANCE",
+  token: "USDT"
 };
 ```
 
@@ -201,57 +225,113 @@ message DepositConfirmationRequest {
 **Response:**
 ```protobuf
 message DepositConfirmationResponse {
-  double new_balance = 1;
+  double newBalance = 1;
 }
 ```
 
 ### Transfer
 
-Execute a transfer/withdrawal.
+Execute a transfer/withdrawal to an external address.
 
 **Request:**
 ```protobuf
 message TransferRequest {
-  string chain = 1;
-  string recipient_address = 2;
-  double amount = 3;
+  string chain = 1;            // Network chain (e.g., "ARBITRUM", "BEP20")
+  string recipient_address = 2; // Destination address
+  double amount = 3;           // Amount to transfer
+  string cex = 4;              // CEX identifier
+  string token = 5;            // Token symbol
 }
 ```
 
 **Response:**
 ```protobuf
 message TransferResponse {
   bool success = 1;
-  double new_balance = 2;
+  string transaction_id = 2;
 }
 ```
 
 ### Convert
 
-Convert between different tokens.
+Convert between different tokens using limit orders.
 
 **Request:**
 ```protobuf
 message ConvertRequest {
-  string from_token = 1;
-  string to_token = 2;
-  double amount = 3;
+  string from_token = 1;       // Source token
+  string to_token = 2;         // Destination token
+  double amount = 3;           // Amount to convert
+  double price = 4;            // Limit price
+  string cex = 5;              // CEX identifier
 }
 ```
 
 **Response:**
 ```protobuf
 message ConvertResponse {
-  double received_amount = 1;
-  double new_balance = 2;
+  string order_id = 3;
+}
+```
+
+### GetOrderDetails
+
+Get details of a specific order.
+
+**Request:**
+```protobuf
+message OrderDetailsRequest {
+  string order_id = 1;         // Unique order identifier
+  string cex = 2;              // CEX identifier
+}
+```
+
+**Response:**
+```protobuf
+message OrderDetailsResponse {
+  string order_id = 1;         // Unique order identifier
+  string status = 2;           // Current order status
+  double original_amount = 3;  // Original order amount
+  double filled_amount = 4;    // Amount that has been filled
+  string symbol = 5;           // Trading pair symbol
+  string mode = 6;             // Buy or Sell mode
+  double price = 7;            // Order price
+}
+```
+
+### CancelOrder
+
+Cancel an existing order.
+
+**Request:**
+```protobuf
+message CancelOrderRequest {
+  string order_id = 1;         // Unique order identifier
+  string cex = 2;              // CEX identifier
+}
+```
+
+**Response:**
+```protobuf
+message CancelOrderResponse {
+  bool success = 1;            // Whether cancellation was successful
+  string final_status = 2;     // Final status of the order
 }
 ```
 
 ## Security
 
 ### IP Authentication
 
-All API calls require IP authentication. Configure allowed IPs in your policy or security layer.
+All API calls require IP authentication. Configure allowed IPs in `helpers/index.ts`:
+
+```typescript
+const ALLOWED_IPS = [
+  "127.0.0.1", // localhost
+  "::1",       // IPv6 localhost
+  // Add your allowed IP addresses here
+];
+```
 
 ### API Key Management
 
@@ -279,12 +359,20 @@ fietCexBroker/
 │   ├── broker.ts          # Exchange broker setup
 │   └── index.ts           # Environment configuration
 ├── helpers/               # Utility functions
+│   └── index.ts           # Core helper functions
 ├── policy/                # Policy configuration
+│   └── policy.json        # Trading and withdrawal rules
 ├── proto/                 # Protocol buffer definitions
 │   ├── fietCexNode/       # Generated TypeScript types
-│   └── node.proto         # Service definition
+│   ├── node.proto         # Service definition
+│   └── node.ts            # Type exports
+├── scripts/               # Build scripts
+│   └── patch-protobufjs.js
 ├── index.ts               # Main server file
 ├── types.ts               # TypeScript type definitions
+├── proto-gen.sh           # Protobuf generation script
+├── biome.json             # Code formatting/linting config
+├── bunfig.toml            # Bun configuration
 └── package.json           # Dependencies and scripts
 ```
 
@@ -308,14 +396,30 @@ bun test --watch
 bun test --coverage
 ```
 
+## Dependencies
+
+### Core Dependencies
+- `@grpc/grpc-js`: gRPC server implementation
+- `@grpc/proto-loader`: Protocol buffer loading
+- `ccxt`: Cryptocurrency exchange library
+- `dotenv`: Environment variable management
+- `joi`: Configuration validation
+
+### Development Dependencies
+- `@biomejs/biome`: Code formatting and linting
+- `@types/bun`: Bun type definitions
+- `bun-types`: Additional Bun types
+- `husky`: Git hooks
+
 ## Contributing
 
 1. Fork the repository
 2. Create a feature branch
 3. Make your changes
 4. Add tests for new functionality
 5. Ensure all tests pass
-6. Submit a pull request
+6. Run `bun run check` to format and lint code
+7. Submit a pull request
 
 ## License
 

index.ts

@@ -208,10 +208,11 @@ function getServer(policy: PolicyConfig) {
 			}
 
 			try {
-				// Placeholder for actual deposit confirmation logic
-				const newBalance = 1000; // Example balance update
-
-				callback(null, { new_balance: newBalance });
+				console.log(
+					`[${new Date().toISOString()}] ` +
+						`Amount ${amount} at ${transactionHash} on chain ${chain}. Paid to ${recipientAddress}`,
+				);
+				callback(null, { newBalance: 0 });
 			} catch (error) {
 				console.error({ error });
 				callback(