@triadxyz/triad-protocol 0.1.3-alpha.7 → 0.1.3-beta

package/dist/stake.d.ts

@@ -1,8 +1,8 @@
 import { AnchorProvider, Program } from '@coral-xyz/anchor';
 import { PublicKey } from '@solana/web3.js';
 import { TriadProtocol } from './types/triad_protocol';
-import BN from 'bn.js';
 import { RpcOptions } from './types';
+import { DepositStakeRewardsArgs, InitializeStakeArgs, StakeNftArgsV1, RequestWithdrawArgs, WithdrawArgs, StakeResponse, UpdateStakeVaultStatusArgs, ClaimStakeRewardsArgs, CreateUserArgs, StakeTokenArgs, MigrateStakeArgs } from './types/stake';
 export default class Stake {
     program: Program<TriadProtocol>;
     provider: AnchorProvider;
@@ -10,188 +10,47 @@ export default class Stake {
     /**
      * Get all Stake Vaults
      */
-    getStakeVaults(): Promise<{
-        name: string;
-        collection: string;
-        slots: number;
+    getStakeVaults(): Promise<import("./types/stake").StakeVaultResponse[]>;
+    /**
+     * Get all Users
+     */
+    getUsers(): Promise<import("./types/stake").UserResponse[]>;
+    /**
+     * Get Stake Vault by name
+     * @param stakeVault - Stake Vault name
+     */
+    getStakeVaultByName(stakeVault: string): Promise<import("./types/stake").StakeVaultResponse>;
+    /**
+     * Get all stakes by vault
+     * @param stakeVault - Stake Vault name
+     *
+     */
+    getStakes(stakeVault: string): Promise<StakeResponse[]>;
+    /**
+     * Get Stake by wallet
+     * @param wallet - User wallet
+     * @param stakeVault - Stake Vault name
+     *
+     */
+    getStakeByWallet(wallet: PublicKey, stakeVault: string): Promise<StakeResponse[]>;
+    /**
+     * Get Stake Vault Rewards details
+     * @param stakeVault - Stake Vault name
+     */
+    getStakeVaultRewards(stakeVault: string): Promise<{
         amount: number;
-        isLocked: boolean;
-        usersPaid: PublicKey;
-        amountPaid: number;
-        amountUsers: number;
-        apr: number;
-        initTs: number;
-        endTs: number;
-    }[]>;
-    /**
-     * Get all stakes
-     */
-    getStakes(): Promise<{
-        name: string;
-        collections: (({
-            undead?: never;
-            alligators?: never;
-            pyth?: never;
-        } & {
-            coleta: Record<string, never>;
-        }) | ({
-            coleta?: never;
-            alligators?: never;
-            pyth?: never;
-        } & {
-            undead: Record<string, never>;
-        }) | ({
-            coleta?: never;
-            undead?: never;
-            pyth?: never;
-        } & {
-            alligators: Record<string, never>;
-        }) | ({
-            coleta?: never;
-            undead?: never;
-            alligators?: never;
-        } & {
-            pyth: Record<string, never>;
-        }))[];
-        rarity: ({
-            uncommon?: never;
-            rare?: never;
-            epic?: never;
-            legendary?: never;
-            mythic?: never;
-        } & {
-            common: Record<string, never>;
-        }) | ({
-            common?: never;
-            rare?: never;
-            epic?: never;
-            legendary?: never;
-            mythic?: never;
-        } & {
-            uncommon: Record<string, never>;
-        }) | ({
-            common?: never;
-            uncommon?: never;
-            epic?: never;
-            legendary?: never;
-            mythic?: never;
-        } & {
-            rare: Record<string, never>;
-        }) | ({
-            common?: never;
-            uncommon?: never;
-            rare?: never;
-            legendary?: never;
-            mythic?: never;
-        } & {
-            epic: Record<string, never>;
-        }) | ({
-            common?: never;
-            uncommon?: never;
-            rare?: never;
-            epic?: never;
-            mythic?: never;
-        } & {
-            legendary: Record<string, never>;
-        }) | ({
-            common?: never;
-            uncommon?: never;
-            rare?: never;
-            epic?: never;
-            legendary?: never;
-        } & {
-            mythic: Record<string, never>;
-        });
-        stakeVault: PublicKey;
-        account: PublicKey;
-        initTs: number;
-        isLocked: boolean;
-        withdrawTs: number;
-        mint: PublicKey;
-    }[]>;
-    getStakeByWallet(wallet: PublicKey): Promise<{
-        name: string;
-        collections: (({
-            undead?: never;
-            alligators?: never;
-            pyth?: never;
-        } & {
-            coleta: Record<string, never>;
-        }) | ({
-            coleta?: never;
-            alligators?: never;
-            pyth?: never;
-        } & {
-            undead: Record<string, never>;
-        }) | ({
-            coleta?: never;
-            undead?: never;
-            pyth?: never;
-        } & {
-            alligators: Record<string, never>;
-        }) | ({
-            coleta?: never;
-            undead?: never;
-            alligators?: never;
-        } & {
-            pyth: Record<string, never>;
-        }))[];
-        rarity: ({
-            uncommon?: never;
-            rare?: never;
-            epic?: never;
-            legendary?: never;
-            mythic?: never;
-        } & {
-            common: Record<string, never>;
-        }) | ({
-            common?: never;
-            rare?: never;
-            epic?: never;
-            legendary?: never;
-            mythic?: never;
-        } & {
-            uncommon: Record<string, never>;
-        }) | ({
-            common?: never;
-            uncommon?: never;
-            epic?: never;
-            legendary?: never;
-            mythic?: never;
-        } & {
-            rare: Record<string, never>;
-        }) | ({
-            common?: never;
-            uncommon?: never;
-            rare?: never;
-            legendary?: never;
-            mythic?: never;
-        } & {
-            epic: Record<string, never>;
-        }) | ({
-            common?: never;
-            uncommon?: never;
-            rare?: never;
-            epic?: never;
-            mythic?: never;
-        } & {
-            legendary: Record<string, never>;
-        }) | ({
-            common?: never;
-            uncommon?: never;
-            rare?: never;
-            epic?: never;
-            legendary?: never;
-        } & {
-            mythic: Record<string, never>;
-        });
-        stakeVault: PublicKey;
-        account: PublicKey;
-        initTs: number;
-        isLocked: boolean;
-        withdrawTs: number;
-        mint: PublicKey;
-    }[]>;
+        perDay: number;
+        perWeek: number;
+        perMonth: number;
+        period: number;
+        days: number[];
+    }>;
+    /**
+     * Get Stakes by day
+     * @param stakeVault - Stake Vault name
+     * @param day - Day timestamp
+     */
+    getStakesByDay(stakeVault: string, day: number): Promise<StakeResponse[]>;
     /**
      *  Stake NFT
      *  @param name - NFT name
@@ -201,42 +60,82 @@ export default class Stake {
      *  @param rarity - NFT rarity
      *
      */
-    stake({ name, wallet, mint, collections, rarity }: {
-        name: string;
-        wallet: PublicKey;
-        mint: PublicKey;
-        collections: {
-            alligators: boolean;
-            coleta: boolean;
-            undead: boolean;
-            pyth: boolean;
-        };
-        rarity: {
-            common: {};
-        } | {
-            uncommon: {};
-        } | {
-            rare: {};
-        } | {
-            epic: {};
-        } | {
-            legendary: {};
-        } | {
-            mythic: {};
-        };
-    }, options?: RpcOptions): Promise<string>;
+    stakeNft({ name, wallet, mint, collections, rarity, stakeVault }: StakeNftArgsV1, options?: RpcOptions): Promise<string>;
+    /**
+     *  Stake NFT
+     *  @param wallet - User wallet
+     *  @param mint - NFT mint
+     *  @param collections - NFT collections
+     *  @param rarity - NFT rarity
+     *
+     */
+    stakeToken({ name, wallet, stakeVault, amount }: StakeTokenArgs, options?: RpcOptions): Promise<string>;
     /**
      *  Initialize Stake Vault
      *  @param name - The ticker's name
-     *  @param amount - Reward amount
      *  @param slots - Amount available to users joining the vault
      *  @param collection - The Collection name
      *
      */
-    initializeStakeVault({ name, amount, slots, collection }: {
-        name: string;
-        amount: BN;
-        slots: BN;
-        collection: string;
-    }, options?: RpcOptions): Promise<string>;
+    initializeStakeVault({ name, slots, collection, amount }: InitializeStakeArgs, options?: RpcOptions): Promise<string>;
+    /**
+     *  Deposit Stake Rewards
+     *  @param wallet - User wallet
+     *  @param mint - NFT mint
+     *  @param amount - Reward amount
+     *
+     */
+    depositStakeRewards({ wallet, mint, amount, stakeVault }: DepositStakeRewardsArgs, options?: RpcOptions): Promise<string>;
+    /**
+     *  Request Withdraw
+     *  @param wallet - User wallet
+     *  @param name - Stake name
+     *  @param stakeVault - Name of the stake vault
+     *
+     */
+    requestWithdraw({ wallet, name, mint, stakeVault }: RequestWithdrawArgs, options?: RpcOptions): Promise<string>;
+    /**
+     *  Withdraw Stake
+     *  @param wallet - User wallet
+     *  @param name - Stake name
+     *  @param mint - NFT mint
+     *  @param stakeVault - Name of the stake vault
+     *
+     */
+    withdrawStake({ wallet, name, mint, stakeVault }: WithdrawArgs, options?: RpcOptions): Promise<string>;
+    /**
+     *  Update Stake Vault Status
+     *  @param wallet - User wallet
+     *  @param stakeVault - Name of the stake vault
+     *  @param isLocked - Status of the stake vault
+     *  @param week - Current week rewards (Starts from 0)
+     *
+     */
+    updateStakeVaultStatus({ wallet, isLocked, week, stakeVault }: UpdateStakeVaultStatusArgs, options?: RpcOptions): Promise<string>;
+    /**
+     *  Claim Stake Rewards
+     *  @param wallet - User wallet
+     *  @param mint - NFT mint
+     *  @param week - Week rewards
+     *  @param stakeVault - Name of the stake vault
+     *  @param nftName - Name of the nft
+     *
+     */
+    claimStakeRewards({ wallet, mint, stakeVault, nftName }: ClaimStakeRewardsArgs, options?: RpcOptions): Promise<string>;
+    /**
+     *  Create User
+     *  @param wallet - User wallet
+     *  @param name - user name
+     *  @param referral - user referral
+     *
+     */
+    createUser({ wallet, name, referral }: CreateUserArgs, options?: RpcOptions): Promise<string>;
+    /**
+     *  Migrate Stake
+     *  @param name - NFT name
+     *  @param wallet - User wallet
+     *  @param mint - NFT mint
+     *
+     */
+    migrateStake({ name, wallet, mint, stakeVault }: MigrateStakeArgs, options?: RpcOptions): Promise<string>;
 }