@carrot-protocol/http-client 0.2.57-lib-docs-dev-77289ab → 0.2.57-lib-docs-dev-65a9672

package/dist/index.js

@@ -47,16 +47,19 @@ const bs58_1 = require("bs58");
 exports.Common = __importStar(require("@carrot-protocol/common"));
 class Client {
     constructor(baseUrl, provider) {
-        this.headers = { "Content-Type": "application/json" };
+        this.headers = { "Content-Type": "application/json" }; // Default headers for HTTP requests
+        // Initializes the client with a base URL and optional provider
         this.baseUrl = baseUrl;
         this.provider = provider;
     }
+    // Fetches and logs the index data from the base URL
     async index() {
         const response = await (0, cross_fetch_1.default)(this.baseUrl);
         checkResponse(response);
         const body = await response.json();
         console.log(JSON.stringify(body, undefined, 2));
     }
+    // Retrieves details of a specific vault
     async getVault(vault, useCache) {
         const url = new URL(`${this.baseUrl}/vault?vault=${vault.toString()}&useCache=${useCache}`);
         const response = await (0, cross_fetch_1.default)(url, {
@@ -104,6 +107,7 @@ class Client {
         }));
         return body;
     }
+    // Fetches performance metrics for a specific vault
     async getVaultPerformance(vault, useCache) {
         const url = new URL(`${this.baseUrl}/performance?vault=${vault.toString()}&useCache=${useCache}`);
         const response = await (0, cross_fetch_1.default)(url, {
@@ -130,6 +134,7 @@ class Client {
         }
         return body;
     }
+    // Retrieves user-specific data for a given vault
     async getUser(vault) {
         // error if provider is undefined
         requireProvider(this.provider);
@@ -149,6 +154,7 @@ class Client {
         }));
         return body;
     }
+    // Gets historical APY data for a specific vault
     async getHistoricalVaultApy(vault, interval) {
         const url = new URL(`${this.baseUrl}/historicalVaultApy?vault=${vault.toString()}&interval=${interval}`);
         const response = await (0, cross_fetch_1.default)(url, {
@@ -163,6 +169,7 @@ class Client {
         };
         return historicalVaultApyResponse;
     }
+    // Fetches performance data for a user across multiple wallets
     async getUserPerformance(vault, wallets) {
         const walletsString = wallets.map((wallet) => wallet.toString()).join(",");
         const url = new URL(`${this.baseUrl}/userPerformance?vault=${vault.toString()}&wallets=${walletsString}`);
@@ -183,6 +190,7 @@ class Client {
         };
         return getUserPerformanceResponse;
     }
+    // Retrieves historical NAV data for a specific vault
     async getHistoricalVaultNav(vault, interval) {
         const url = new URL(`${this.baseUrl}/historicalVaultNav?vault=${vault.toString()}&interval=${interval}`);
         const response = await (0, cross_fetch_1.default)(url, {
@@ -197,6 +205,7 @@ class Client {
         };
         return historicalVaultNavResponse;
     }
+    // Issues new assets to a specified vault
     async issue(vault, assetMint, amount) {
         // error if provider is undefined
         requireProvider(this.provider);
@@ -218,6 +227,7 @@ class Client {
         const txSig = await this.send(issueResponse.tx);
         return txSig;
     }
+    // Redeems assets from a specified vault
     async redeem(vault, assetMint, amount) {
         // error if provider is undefined
         requireProvider(this.provider);
@@ -239,6 +249,7 @@ class Client {
         const txSig = await this.send(redeemResponse.tx);
         return txSig;
     }
+    // Checks the status of a specified wallet
     async checkWallet(wallet) {
         const url = new URL(`${this.baseUrl}/checkWallet?wallet=${wallet.toString()}`);
         const response = await (0, cross_fetch_1.default)(url, {
@@ -250,6 +261,7 @@ class Client {
         const body = JSON.parse(JSON.stringify(responseBody));
         return body;
     }
+    // Claims a referral code for a specified wallet
     async claimReferralCode(wallet, code) {
         const url = new URL(`${this.baseUrl}/claimReferralCode`);
         const reqBody = {
@@ -266,6 +278,7 @@ class Client {
         const body = JSON.parse(JSON.stringify(responseBody));
         return body;
     }
+    // Retrieves referral codes associated with a specified wallet
     async getReferralCodes(wallet) {
         const url = new URL(`${this.baseUrl}/referralCodes?wallet=${wallet.toString()}`);
         const response = await (0, cross_fetch_1.default)(url, {
@@ -277,6 +290,7 @@ class Client {
         const body = JSON.parse(JSON.stringify(responseBody));
         return body;
     }
+    // Sends a signed transaction to the network
     async send(base64Tx) {
         // error if provider is undefined
         requireProvider(this.provider);
@@ -302,13 +316,17 @@ class Client {
     }
 }
 exports.Client = Client;
+// Checks if a wallet is allowed based on its status
 function isWalletAllowed(response) {
     return response.isWhitelisted || response.claimedReferralCode;
 }
+// Allowed intervals for historical data
 const allowedIntervals = ["HOUR", "DAY", "WEEK"];
+// Validates the provided historical interval
 function isValidVaultHistoricalInterval(interval) {
     return allowedIntervals.includes(interval);
 }
+// Prepares an unsigned transaction for submission
 async function prepareUnsignedTx(connection, payer, ixns, lutAddr, additionalSigner) {
     const lutAccounts = [];
     if (lutAddr) {
@@ -331,11 +349,13 @@ async function prepareUnsignedTx(connection, payer, ixns, lutAddr, additionalSig
     }
     return base64Tx;
 }
+// Checks the response status of an HTTP request
 function checkResponse(response) {
     if (response.status !== 200) {
         throw new Error(`unexpected http status of ${response.status}`);
     }
 }
+// Ensures that a provider is defined
 function requireProvider(provider) {
     if (provider) {
         return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carrot-protocol/http-client",
-  "version": "0.2.57-lib-docs-dev-77289ab",
+  "version": "0.2.57-lib-docs-dev-65a9672",
   "description": "interact with carrot api",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",