@triadxyz/triad-protocol 0.1.0-alpha.2

package/dist/utils/helpers.js

@@ -0,0 +1,70 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatNumber = exports.getUserAddressSync = exports.getTokenVaultAddressSync = exports.getVaultAddressSync = exports.decodeString = exports.encodeString = exports.getTickerAddressSync = void 0;
+const web3_js_1 = require("@solana/web3.js");
+const anchor = __importStar(require("@coral-xyz/anchor"));
+const getTickerAddressSync = (programId, protocolProgramId) => {
+    const [TickerPDA] = web3_js_1.PublicKey.findProgramAddressSync([Buffer.from('ticker'), protocolProgramId.toBuffer()], programId);
+    return TickerPDA;
+};
+exports.getTickerAddressSync = getTickerAddressSync;
+const encodeString = (value) => {
+    const buffer = Buffer.alloc(32);
+    buffer.fill(value);
+    buffer.fill(' ', value.length);
+    return Array(...buffer);
+};
+exports.encodeString = encodeString;
+const decodeString = (bytes) => {
+    const buffer = Buffer.from(bytes);
+    return buffer.toString('utf8').trim();
+};
+exports.decodeString = decodeString;
+const getVaultAddressSync = (programId, tickerAddress) => {
+    const [VaultPDA] = web3_js_1.PublicKey.findProgramAddressSync([
+        Buffer.from(anchor.utils.bytes.utf8.encode('vault')),
+        tickerAddress.toBuffer()
+    ], programId);
+    return VaultPDA;
+};
+exports.getVaultAddressSync = getVaultAddressSync;
+const getTokenVaultAddressSync = (programId, vault) => {
+    const [VaultTokenPDA] = web3_js_1.PublicKey.findProgramAddressSync([
+        Buffer.from(anchor.utils.bytes.utf8.encode('vault_token_account')),
+        vault.toBuffer()
+    ], programId);
+    return VaultTokenPDA;
+};
+exports.getTokenVaultAddressSync = getTokenVaultAddressSync;
+function getUserAddressSync(programId, authority) {
+    const [UserPDA] = web3_js_1.PublicKey.findProgramAddressSync([Buffer.from(anchor.utils.bytes.utf8.encode('user')), authority.toBuffer()], programId);
+    return UserPDA;
+}
+exports.getUserAddressSync = getUserAddressSync;
+const formatNumber = (number, decimals = 6) => {
+    return Number(number.toString()) / Math.pow(10, decimals);
+};
+exports.formatNumber = formatNumber;

package/dist/vault.d.ts

@@ -0,0 +1,89 @@
+/// <reference types="bn.js" />
+import { AnchorProvider, BN, Program } from '@coral-xyz/anchor';
+import { PublicKey } from '@solana/web3.js';
+import { TriadProtocol } from './types/triad_protocol';
+export default class Vault {
+    program: Program<TriadProtocol>;
+    provider: AnchorProvider;
+    constructor(program: Program<TriadProtocol>, provider: AnchorProvider);
+    /**
+     * Create a new vault
+     *  @param protocolProgramId - The program ID of the protocol
+     *  @param mint - Token mint for the vault (e.g. USDC)
+     *
+     */
+    createVault({ protocolProgramId, mint }: {
+        protocolProgramId: PublicKey;
+        mint: PublicKey;
+    }): Promise<string>;
+    /**
+     * Get all vaults
+     */
+    getVaults(): Promise<import("@coral-xyz/anchor").ProgramAccount<{
+        bump: number;
+        authority: PublicKey;
+        name: string;
+        tokenAccount: PublicKey;
+        tickerAddress: PublicKey;
+        totalDeposits: BN;
+        totalWithdraws: BN;
+        initTs: BN;
+        netDeposits: BN;
+        netWithdraws: BN;
+        longBalance: BN;
+        shortBalance: BN;
+        longPositionsOpened: BN;
+        shortPositionsOpened: BN;
+        ticker: PublicKey;
+    }>[]>;
+    /**
+     * Get vault by ticker Address
+     */
+    getVaultByTickerAddress(tickerAddress: PublicKey): Promise<{
+        tvl: number;
+        bump: number;
+        authority: PublicKey;
+        name: string;
+        tokenAccount: PublicKey;
+        tickerAddress: PublicKey;
+        totalDeposits: BN;
+        totalWithdraws: BN;
+        initTs: BN;
+        netDeposits: BN;
+        netWithdraws: BN;
+        longBalance: BN;
+        shortBalance: BN;
+        longPositionsOpened: BN;
+        shortPositionsOpened: BN;
+        ticker: PublicKey;
+    }>;
+    /**
+     * Open Position
+     *  @param tickerPDA - Ticker PDA
+     *  @param amount - The amount to deposit
+     *  @param position - Long or Short
+     *  @param mint - Token mint for the vault (e.g. USDC)
+     */
+    openPosition({ tickerPDA, amount, position, mint }: {
+        tickerPDA: PublicKey;
+        amount: string;
+        position: 'Long' | 'Short';
+        mint: PublicKey;
+    }): Promise<string>;
+    /**
+     * Withdraw from a vault
+     *  @param tickerPDA - Ticker PDA
+     *  @param amount - The amount to deposit
+     *  @param position - Long or Short
+     *  @param mint - Token mint for the vault (e.g. USDC)
+     *  @param positionPubkey - The position public key
+     *
+     */
+    withdraw({ tickerPDA, amount, position, mint, positionPubkey }: {
+        tickerPDA: PublicKey;
+        amount: string;
+        position: 'Long' | 'Short';
+        mint: PublicKey;
+        positionPubkey: PublicKey;
+    }): Promise<string>;
+}

package/dist/vault.js

@@ -0,0 +1,125 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const anchor_1 = require("@coral-xyz/anchor");
+const helpers_1 = require("./utils/helpers");
+const spl_token_1 = require("@solana/spl-token");
+class Vault {
+    constructor(program, provider) {
+        this.provider = provider;
+        this.program = program;
+    }
+    /**
+     * Create a new vault
+     *  @param protocolProgramId - The program ID of the protocol
+     *  @param mint - Token mint for the vault (e.g. USDC)
+     *
+     */
+    createVault({ protocolProgramId, mint }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const TickerPDA = (0, helpers_1.getTickerAddressSync)(this.program.programId, protocolProgramId);
+            const VaultPDA = (0, helpers_1.getVaultAddressSync)(this.program.programId, TickerPDA);
+            const TokenAccountPDA = (0, helpers_1.getTokenVaultAddressSync)(this.program.programId, VaultPDA);
+            return this.program.methods
+                .createVault()
+                .accounts({
+                signer: this.provider.wallet.publicKey,
+                vault: VaultPDA,
+                ticker: TickerPDA,
+                tokenAccount: TokenAccountPDA,
+                payerTokenMint: mint
+            })
+                .rpc();
+        });
+    }
+    /**
+     * Get all vaults
+     */
+    getVaults() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.program.account.vault.all();
+        });
+    }
+    /**
+     * Get vault by ticker Address
+     */
+    getVaultByTickerAddress(tickerAddress) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const VaultPDA = (0, helpers_1.getVaultAddressSync)(this.program.programId, tickerAddress);
+            try {
+                const vault = yield this.program.account.vault.fetch(VaultPDA);
+                const tokenAcc = yield (0, spl_token_1.getAccount)(this.provider.connection, vault.tokenAccount);
+                return Object.assign(Object.assign({}, vault), { tvl: (0, helpers_1.formatNumber)(tokenAcc.amount) });
+            }
+            catch (e) {
+                throw new Error(e);
+            }
+        });
+    }
+    /**
+     * Open Position
+     *  @param tickerPDA - Ticker PDA
+     *  @param amount - The amount to deposit
+     *  @param position - Long or Short
+     *  @param mint - Token mint for the vault (e.g. USDC)
+     */
+    openPosition({ tickerPDA, amount, position, mint }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const UserPDA = (0, helpers_1.getUserAddressSync)(this.program.programId, this.provider.wallet.publicKey);
+            const VaultPDA = (0, helpers_1.getVaultAddressSync)(this.program.programId, tickerPDA);
+            const VaultTokenAccountPDA = (0, helpers_1.getTokenVaultAddressSync)(this.program.programId, VaultPDA);
+            const userTokenAccount = yield (0, spl_token_1.getAssociatedTokenAddress)(mint, this.provider.wallet.publicKey);
+            return this.program.methods
+                .openPosition({
+                amount: new anchor_1.BN(amount),
+                isLong: position === 'Long'
+            })
+                .accounts({
+                user: UserPDA,
+                vault: VaultPDA,
+                vaultTokenAccount: VaultTokenAccountPDA,
+                userTokenAccount
+            })
+                .rpc();
+        });
+    }
+    /**
+     * Withdraw from a vault
+     *  @param tickerPDA - Ticker PDA
+     *  @param amount - The amount to deposit
+     *  @param position - Long or Short
+     *  @param mint - Token mint for the vault (e.g. USDC)
+     *  @param positionPubkey - The position public key
+     *
+     */
+    withdraw({ tickerPDA, amount, position, mint, positionPubkey }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const UserPDA = (0, helpers_1.getUserAddressSync)(this.program.programId, this.provider.wallet.publicKey);
+            const VaultPDA = (0, helpers_1.getVaultAddressSync)(this.program.programId, tickerPDA);
+            const VaultTokenAccountPDA = (0, helpers_1.getTokenVaultAddressSync)(this.program.programId, VaultPDA);
+            const userTokenAccount = yield (0, spl_token_1.getAssociatedTokenAddress)(mint, this.provider.wallet.publicKey);
+            return this.program.methods
+                .closePosition({
+                amount: new anchor_1.BN(amount),
+                isLong: position === 'Long',
+                pubkey: positionPubkey
+            })
+                .accounts({
+                user: UserPDA,
+                vault: VaultPDA,
+                vaultTokenAccount: VaultTokenAccountPDA,
+                userTokenAccount
+            })
+                .rpc();
+        });
+    }
+}
+exports.default = Vault;

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@triadxyz/triad-protocol",
+  "version": "0.1.0-alpha.2",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "yarn run clean && tsc",
+    "prepublishOnly": "yarn build",
+    "start": "yarn build && node ./dist/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "./dist/**/*"
+  ],
+  "keywords": [
+    "solana",
+    "blockchain",
+    "protocol",
+    "triad",
+    "trading protocols"
+  ],
+  "author": "Lineup",
+  "license": "ISC",
+  "dependencies": {
+    "@coral-xyz/anchor": "0.28.0",
+    "@firethreexyz/firethree-protocol": "^0.19.1",
+    "@pythnetwork/client": "^2.19.0",
+    "@shadow-drive/sdk": "5.0.0",
+    "@solana/spl-token": "^0.3.11",
+    "@solana/web3.js": "1.89.1",
+    "axios": "^1.5.1",
+    "bs58": "5.0.0",
+    "uuid": "^9.0.1"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "6.7.3",
+    "@typescript-eslint/parser": "6.7.3",
+    "eslint": "8.50.0",
+    "eslint-config-prettier": "9.0.0",
+    "eslint-plugin-prettier": "5.0.0",
+    "prettier": "3.2.4",
+    "rimraf": "^5.0.5",
+    "typedoc": "0.25.1",
+    "typescript": "5.2.2"
+  }
+}