@triadxyz/triad-protocol 4.0.4 → 4.0.6

package/README.md

@@ -1,27 +1,114 @@
 <div align="center">
-  <h1>Triad Protocol</h1>
+  <h1>Triad Protocol SDK</h1>
+  <p>The official TypeScript SDK for interacting with the Triad Protocol on Solana.</p>
 </div>
 
-The official Triad Protocol. trading your prefer companie in web3.
+---
 
-### Docs
+## ✨ Features
 
-[Triad Protocol Docs](https://docs.triadfi.co/)
+- **Market Management**: Create and manage prediction markets (Standard & Pyth-based).
+- **Order Book**: Place limit/market bids and asks, cancel orders, and claim payouts.
+- **Liquidity Pools**: Create and manage liquidity pools for groups of markets.
+- **Staking**: Stake tokens, request unstakes, and claim rewards.
+- **Predictor Accounts**: Initialize and manage user predictor profiles.
+- **Customer Management**: Register frontends and manage custom fee structures.
 
-## Quick Setup
+## 🚀 Quick Setup
 
 ### Install
 
-Install these dependencies over:
+```bash
+# npm
+npm install @triadxyz/triad-protocol
 
-npm:
+# yarn
+yarn add @triadxyz/triad-protocol
+```
 
-```shell
-npm install @triadxyz/triad-protocol
+### Initialize SDK
+
+```typescript
+import { Connection, PublicKey } from '@solana/web3.js';
+import { TriadProtocol } from '@triadxyz/triad-protocol';
+import { Wallet } from '@coral-xyz/anchor';
+
+const connection = new Connection("https://api.mainnet-beta.solana.com");
+const wallet = ...; // Your Solana wallet
+
+const sdk = new TriadProtocol(connection, wallet, {
+  commitment: 'confirmed'
+});
 ```
 
-yarn:
+## 📖 Usage Examples
 
-```shell
-yarn add @triadxyz/triad-protocol
+### Fetching Markets
+
+```typescript
+// Get all active markets
+const markets = await sdk.getAllMarkets()
+
+// Get a specific market by ID
+const market = await sdk.getMarketById(123)
+console.log(`Question: ${market.question}`)
 ```
+
+### Creating a Market
+
+```typescript
+await sdk.createMarket({
+  markets: [
+    {
+      marketId: 456,
+      question: 'Will Bitcoin reach $100k by 2026?',
+      startTime: Math.floor(Date.now() / 1000),
+      endTime: 1767225600, // Jan 1, 2026
+      feeBps: 100, // 1%
+      payoutFee: 50 // 0.5%
+    }
+  ],
+  customer: new PublicKey('...'),
+  poolId: null
+})
+```
+
+### Placing a Bet (Trade)
+
+```typescript
+// Place a bid (YES) on market 456
+await sdk.trade.placeBidOrder({
+  marketId: 456,
+  amount: new BN(1 * 1e6), // 1 USDC
+  price: 500, // 50% probability
+  direction: WinningDirection.Yes
+})
+```
+
+### Staking
+
+```typescript
+// Stake tokens
+await sdk.stake.stakeToken({
+  amount: new BN(1000000000),
+  mint: new PublicKey('...')
+})
+
+// Claim rewards
+await sdk.stake.claimStakeRewards()
+```
+
+## 🛠 Developer Guide
+
+To generate the full API documentation (TypeDoc):
+
+```bash
+yarn install
+yarn docs
+```
+
+The documentation will be available in the `docs/` folder.
+
+## 📄 License
+
+ISC

package/dist/customer.d.ts

@@ -1,9 +1,8 @@
-/// <reference types="@coral-xyz/anchor/node_modules/@solana/web3.js" />
 import { PublicKey } from '@solana/web3.js';
 import { Program } from '@coral-xyz/anchor';
 import { TriadProtocol } from './types/triad_protocol';
 import { RpcOptions } from './types';
-import { CreateCustomerArgs, UpdateCustomerFeeArgs } from './types/customer';
+import { CreateCustomerArgs } from './types/customer';
 export default class Customer {
     private program;
     private rpcOptions;
@@ -16,12 +15,12 @@ export default class Customer {
      * Get Costumer By Wallet Address
      * @param wallet - The wallet address of the customer
      */
-    getCustomerByWallet(wallet: PublicKey): Promise<import("@triadxyz/triad-protocol").Customer>;
+    getCustomerByWallet(wallet: PublicKey): Promise<import("./types/customer").Customer>;
     /**
      * Get Customer By ID
      * @param customerId - The ID of the customer
      */
-    getCustomerById(customerId: number): Promise<import("@triadxyz/triad-protocol").Customer>;
+    getCustomerById(customerId: number): Promise<import("./types/customer").Customer>;
     /**
      * Create Customer
      * @param args.id - The ID of the customer
@@ -30,10 +29,4 @@ export default class Customer {
      * @param args.feeRecipient - The fee recipient of the customer
      */
     createCustomer({ id, name, authority, feeRecipient }: CreateCustomerArgs): Promise<string | import("@solana/web3.js").VersionedTransaction>;
-    /**
-     * Update Customer Fee
-     * @param customerId - Customer ID
-     * @param feeBps - Fee in basis points
-     */
-    updateCustomerFee({ customerId, feeBps, feeRecipient }: UpdateCustomerFeeArgs): Promise<string | import("@solana/web3.js").VersionedTransaction>;
 }

package/dist/customer.js

@@ -12,8 +12,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const helpers_1 = require("./utils/helpers");
 const sendVersionedTransaction_1 = __importDefault(require("./utils/sendVersionedTransaction"));
-const triad_protocol_1 = require("@triadxyz/triad-protocol");
+const pda_1 = require("./utils/pda");
 class Customer {
     constructor(program, rpcOptions) {
         this.program = program;
@@ -42,7 +43,7 @@ class Customer {
                     }
                 }
             ]);
-            return (0, triad_protocol_1.formatCustomer)(customer.account, customer.publicKey);
+            return (0, helpers_1.formatCustomer)(customer.account, customer.publicKey);
         });
     }
     /**
@@ -51,9 +52,9 @@ class Customer {
      */
     getCustomerById(customerId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const customerPDA = (0, triad_protocol_1.getCustomerPDA)(this.program.programId, customerId);
+            const customerPDA = (0, pda_1.getCustomerPDA)(this.program.programId, customerId);
             const customer = yield this.program.account.customer.fetch(customerPDA, this.rpcOptions.commitment);
-            return (0, triad_protocol_1.formatCustomer)(customer, customerPDA);
+            return (0, helpers_1.formatCustomer)(customer, customerPDA);
         });
     }
     /**
@@ -76,23 +77,5 @@ class Customer {
             return (0, sendVersionedTransaction_1.default)(this.program, ixs, this.rpcOptions);
         });
     }
-    /**
-     * Update Customer Fee
-     * @param customerId - Customer ID
-     * @param feeBps - Fee in basis points
-     */
-    updateCustomerFee({ customerId, feeBps, feeRecipient }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const ixs = [
-                yield this.program.methods
-                    .updateCustomerFee({ id: customerId, feeBps, feeRecipient })
-                    .accounts({
-                    signer: this.program.provider.publicKey
-                })
-                    .instruction()
-            ];
-            return (0, sendVersionedTransaction_1.default)(this.program, ixs, this.rpcOptions);
-        });
-    }
 }
 exports.default = Customer;

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@coral-xyz/anchor/node_modules/@solana/web3.js" />
 import { Connection, PublicKey } from '@solana/web3.js';
 import { AnchorProvider, Program, Wallet } from '@coral-xyz/anchor';
 import { TriadProtocol as TriadProtocolIDL } from './types/triad_protocol';
@@ -104,7 +103,7 @@ export default class TriadProtocol {
      * @param question - The question of the pool
      * @param markets - The markets of the pool
      */
-    createPool({ poolId, question, markets, customer, startTime, endTime, feeBps, payoutFee, isFast }: CreatePoolArgs): Promise<string | import("@solana/web3.js").VersionedTransaction>;
+    createPool({ poolId, question, markets, customer, startTime, endTime, feeBps, payoutFee, isFast, isPyth, feedId }: CreatePoolArgs): Promise<string | import("@solana/web3.js").VersionedTransaction>;
     /**
      * Update Market Winning Direction
      * @param args.marketId - The ID of the Market
@@ -143,9 +142,13 @@ export default class TriadProtocol {
     }[]): Promise<string | import("@solana/web3.js").VersionedTransaction>;
     /**
      * Close Order Book
-     * @param marketIds - Market IDs
+     * @param markets.id - Market IDs
+     * @param markets.authority - The authority of the market
      */
-    closeOrderBook(marketIds: number[]): Promise<string | import("@solana/web3.js").VersionedTransaction>;
+    closeOrderBook(markets: {
+        id: number;
+        authority: PublicKey;
+    }[]): Promise<string | import("@solana/web3.js").VersionedTransaction>;
     /**
      * Update Pool Question
      * @param poolId - Pool ID

package/dist/index.js

@@ -269,7 +269,7 @@ class TriadProtocol {
      * @param question - The question of the pool
      * @param markets - The markets of the pool
      */
-    createPool({ poolId, question, markets, customer, startTime, endTime, feeBps, payoutFee, isFast }) {
+    createPool({ poolId, question, markets, customer, startTime, endTime, feeBps, payoutFee, isFast, isPyth, feedId }) {
         return __awaiter(this, void 0, void 0, function* () {
             if (question.length > 80) {
                 throw new Error('Pool question must be less than 80 characters');
@@ -280,7 +280,9 @@ class TriadProtocol {
                 .createPool({
                 poolId: new bn_js_1.default(poolId),
                 question: (0, helpers_1.encodeString)(question, 80),
-                isFast
+                isFast,
+                isPyth,
+                feedId
             })
                 .accounts({
                 signer: this.program.provider.publicKey,
@@ -422,18 +424,19 @@ class TriadProtocol {
     }
     /**
      * Close Order Book
-     * @param marketIds - Market IDs
+     * @param markets.id - Market IDs
+     * @param markets.authority - The authority of the market
      */
-    closeOrderBook(marketIds) {
+    closeOrderBook(markets) {
         return __awaiter(this, void 0, void 0, function* () {
             const ixs = [];
-            for (const marketId of marketIds) {
+            for (const market of markets) {
                 ixs.push(yield this.program.methods
                     .closeOrderBook()
                     .accounts({
-                    signer: this.program.provider.publicKey,
-                    market: (0, pda_1.getMarketPDA)(this.program.programId, marketId),
-                    orderBook: (0, pda_1.getOrderBookPDA)(this.program.programId, marketId)
+                    authority: market.authority,
+                    market: (0, pda_1.getMarketPDA)(this.program.programId, market.id),
+                    orderBook: (0, pda_1.getOrderBookPDA)(this.program.programId, market.id)
                 })
                     .instruction());
             }

package/dist/poseidon.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@coral-xyz/anchor/node_modules/@solana/web3.js" />
 import { Program } from '@coral-xyz/anchor';
 import { PublicKey } from '@solana/web3.js';
 import { TriadProtocol } from './types/triad_protocol';
@@ -7,17 +6,6 @@ export default class Poseidon {
     private program;
     private rpcOptions;
     constructor(program: Program<TriadProtocol>, rpcOptions: RpcOptions);
-    /**
-     * Transfer Poseidon
-     * @param args.poseidonAsset - Poseidon Asset
-     * @param args.ticketAsset - Ticket Asset
-     * @param args.ticketNumber - Ticket Number
-     */
-    transferPoseidon(poseidons: {
-        poseidonAsset: PublicKey;
-        ticketAsset: PublicKey;
-        ticketNumber: number;
-    }[]): Promise<string | import("@solana/web3.js").VersionedTransaction>;
     /**
      * Withdraw Poseidon
      * @param poseidonAsset - Poseidon Asset - CORE PublicKey
@@ -41,13 +29,4 @@ export default class Poseidon {
      * @param poseidonAsset - Poseidon Asset
      */
     removeTraderPoseidon(user: PublicKey, poseidonAsset: PublicKey): Promise<string | import("@solana/web3.js").VersionedTransaction>;
-    /**
-     * Update Metadata
-     * @param poseidons.uri - URI
-     * @param poseidons.asset - Asset
-     */
-    updateMetadata(poseidons: {
-        uri: string;
-        asset: PublicKey;
-    }[]): Promise<string | import("@solana/web3.js").VersionedTransaction>;
 }

package/dist/poseidon.js

@@ -20,33 +20,6 @@ class Poseidon {
         this.program = program;
         this.rpcOptions = rpcOptions;
     }
-    /**
-     * Transfer Poseidon
-     * @param args.poseidonAsset - Poseidon Asset
-     * @param args.ticketAsset - Ticket Asset
-     * @param args.ticketNumber - Ticket Number
-     */
-    transferPoseidon(poseidons) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const ixs = [];
-            for (const poseidon of poseidons) {
-                ixs.push(yield this.program.methods
-                    .transferPoseidon()
-                    .accounts({
-                    signer: this.program.provider.publicKey,
-                    nft: (0, pda_1.getNftPDA)(this.program.programId, poseidon.ticketNumber),
-                    poseidonAsset: poseidon.poseidonAsset,
-                    ticketAsset: poseidon.ticketAsset,
-                    poseidonCollection: (0, pda_1.getCollectionPDA)(this.program.programId, constants_1.POSEIDON_COLLECTION_SYMBOL),
-                    ticketCollection: (0, pda_1.getCollectionPDA)(this.program.programId, constants_1.TICKET_COLLECTION_SYMBOL),
-                    coreTicketCollection: constants_1.TICKET_CORE_COLLECTION,
-                    corePoseidonCollection: constants_1.POSEIDON_CORE_COLLECTION
-                })
-                    .instruction());
-            }
-            return (0, sendVersionedTransaction_1.default)(this.program, ixs, this.rpcOptions);
-        });
-    }
     /**
      * Withdraw Poseidon
      * @param poseidonAsset - Poseidon Asset - CORE PublicKey
@@ -127,27 +100,5 @@ class Poseidon {
             return (0, sendVersionedTransaction_1.default)(this.program, ixs, this.rpcOptions);
         });
     }
-    /**
-     * Update Metadata
-     * @param poseidons.uri - URI
-     * @param poseidons.asset - Asset
-     */
-    updateMetadata(poseidons) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const ixs = [];
-            for (const poseidon of poseidons) {
-                ixs.push(yield this.program.methods
-                    .updateMetadata(poseidon.uri)
-                    .accounts({
-                    signer: this.program.provider.publicKey,
-                    corePoseidonCollection: constants_1.POSEIDON_CORE_COLLECTION,
-                    poseidonCollection: (0, pda_1.getCollectionPDA)(this.program.programId, constants_1.POSEIDON_COLLECTION_SYMBOL),
-                    poseidonAsset: poseidon.asset
-                })
-                    .instruction());
-            }
-            return (0, sendVersionedTransaction_1.default)(this.program, ixs, this.rpcOptions);
-        });
-    }
 }
 exports.default = Poseidon;

package/dist/predictor.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@coral-xyz/anchor/node_modules/@solana/web3.js" />
 import { PublicKey } from '@solana/web3.js';
 import { Program } from '@coral-xyz/anchor';
 import { TriadProtocol } from './types/triad_protocol';

package/dist/stake.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@coral-xyz/anchor/node_modules/@solana/web3.js" />
 import { Program } from '@coral-xyz/anchor';
 import { PublicKey } from '@solana/web3.js';
 import { TriadProtocol } from './types/triad_protocol';

package/dist/trade.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@coral-xyz/anchor/node_modules/@solana/web3.js" />
 import { PublicKey } from '@solana/web3.js';
 import { Program } from '@coral-xyz/anchor';
 import { TriadProtocol } from './types/triad_protocol';

package/dist/types/customer.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@coral-xyz/anchor/node_modules/@solana/web3.js" />
 import { PublicKey } from '@solana/web3.js';
 export type Customer = {
     id: number;
@@ -15,8 +14,3 @@ export type CreateCustomerArgs = {
     authority: PublicKey;
     feeRecipient: PublicKey;
 };
-export type UpdateCustomerFeeArgs = {
-    customerId: number;
-    feeBps: number;
-    feeRecipient: PublicKey | null;
-};