zo-sdk 0.0.3 → 0.0.5

package/README.md

@@ -1 +1,154 @@
 # zo-sdk
+
+A TypeScript SDK for interacting with the Zo Protocol on Sui Network.
+
+## Installation
+
+```bash
+npm install zo-sdk
+# or
+yarn add zo-sdk
+```
+
+## Quick Start
+
+```typescript
+import { API, Network } from 'zo-sdk'
+import { SuiClient } from '@mysten/sui/client'
+
+// Initialize the API
+const provider = new SuiClient({ url: 'https://sui-rpc.url' })
+const api = API.getInstance(
+  Network.MAINNET,
+  provider,
+  'https://api-endpoint',
+  'https://price-feed-url'
+)
+
+// Example: Get market information
+const marketInfo = await api.getMarketInfo()
+
+// Example: Get oracle price for a token
+const price = await api.getOraclePrice('sui')
+```
+
+## Key Features
+
+### Market Operations
+
+```typescript
+// Deposit tokens to get ZLP
+const tx = await api.deposit(
+  'sui', // token
+  ['coinObjectId'], // coin object IDs
+  1000000, // amount
+  0 // minimum amount out
+)
+
+// Withdraw tokens by burning ZLP
+const tx = await api.withdraw(
+  'sui', // token
+  ['zlpCoinObjectId'], // ZLP coin object IDs
+  1000000, // amount
+  0 // minimum amount out
+)
+
+// Swap tokens
+const tx = await api.swap(
+  'sui', // from token
+  'usdc', // to token
+  BigInt(1000000), // amount
+  ['coinObjectId'] // coin object IDs
+)
+```
+
+### Trading Operations
+
+```typescript
+// Open a position
+const tx = await api.openPosition(
+  'sui', // collateral token
+  'btc', // index token
+  BigInt(1000000), // size
+  BigInt(100000), // collateral amount
+  ['coinObjectId'], // coin object IDs
+  true, // long position
+  BigInt(100000), // reserve amount
+  30000, // index price
+  1.5, // collateral price
+  0.003 // slippage
+)
+
+// Decrease a position
+const tx = await api.decreasePosition(
+  'positionCapId',
+  'sui', // collateral token
+  'btc', // index token
+  BigInt(500000), // amount to decrease
+  true, // long position
+  30000, // index price
+  1.5, // collateral price
+)
+
+// Cancel an order
+const tx = await api.cancelOrder(
+  'orderCapId',
+  'sui',
+  'btc',
+  true, // long position
+  'OPEN_POSITION' // order type
+)
+```
+
+### Data Queries
+
+```typescript
+// Get position information
+const positions = await api.getPositionInfoList(positionCapInfoList, 'ownerAddress')
+
+// Get order information
+const orders = await api.getOrderInfoList(orderCapInfoList, 'ownerAddress')
+
+// Get vault information
+const vaultInfo = await api.getVaultInfo('sui')
+
+// Get symbol information
+const symbolInfo = await api.getSymbolInfo('btc', true) // true for long
+
+// Get market valuation
+const valuation = await api.valuateMarket()
+```
+
+### Staking Operations
+
+```typescript
+// Stake ZLP
+const tx = await api.stake(
+  ['zlpCoinObjectId'],
+  BigInt(1000000),
+  'poolId'
+)
+
+// Unstake ZLP
+const tx = await api.unstake(
+  credentials,
+  BigInt(1000000),
+  'poolId'
+)
+```
+
+## Error Handling
+
+The SDK throws errors for invalid operations and network issues. Always wrap API calls in try-catch blocks:
+
+```typescript
+try {
+  const marketInfo = await api.getMarketInfo()
+} catch (error) {
+  console.error('Failed to get market info:', error)
+}
+```
+
+## Documentation
+
+For detailed API documentation and advanced usage, please refer to the source code and comments.

package/package.json

@@ -1,10 +1,22 @@
 {
   "name": "zo-sdk",
-  "version": "0.0.3",
-  "description": "Zo SDK",
+  "version": "0.0.5",
+  "description": "",
   "author": "",
-  "license": "MIT",
+  "license": "ISC",
   "keywords": [],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -12,7 +24,6 @@
     "build": "ts-bridge build --project ./tsconfig.json --clean",
     "serve": "tsx dist/index.js",
     "start": "tsx src/index.ts",
-    "pub": "tsc && npm publish",
     "test": "vitest"
   },
   "dependencies": {
@@ -24,6 +35,7 @@
     "decimal.js": "10.4.3"
   },
   "devDependencies": {
-    "@ts-bridge/cli": "^0.6.3"
+    "@ts-bridge/cli": "^0.6.3",
+    "typescript": "^5.0.0"
   }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Zo Finance
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/jest.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  transform: {
-    '^.+\\.(ts|tsx)?$': 'ts-jest',
-    '^.+\\.(js|jsx)$': 'babel-jest',
-  },
-};