@hawksightco/hawk-sdk 1.3.265 → 1.3.267

package/dist/classes/Search.js

@@ -0,0 +1,216 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Search = void 0;
+const axios_1 = __importDefault(require("axios"));
+class Search {
+    /**
+     * Set load persistence callback
+     *
+     * @param loadFromPersistenceFn
+     */
+    setLoadFromPersistenceFn(loadFromPersistenceFn) {
+        this.loadFromPersistenceFn = loadFromPersistenceFn;
+    }
+    /**
+     * Set store to persistence callback
+     *
+     * @param storeToPersistenceFn
+     */
+    setStoreToPersistenceFn(storeToPersistenceFn) {
+        this.storeToPersistenceFn = storeToPersistenceFn;
+    }
+    /**
+     * Checks if the token indices and tokens have been loaded.
+     *
+     * @returns {boolean} True if the token indices and tokens have been loaded, false otherwise.
+     */
+    get loaded() { return this._loaded; }
+    /**
+     * Constructs a new instance of the Search class.
+     *
+     * @param {string} url - The base URL for the API.
+     */
+    constructor(url) {
+        this.url = url;
+        this._loaded = false;
+        this._loadedFromPersistence = false;
+        this.previousHash = '';
+        this.latestHash = '';
+        this.disableFetch = false;
+    }
+    /**
+     * Retrieves tokens that match the given keyword.
+     *
+     * This method searches for tokens that match the provided keyword.
+     * If the token indices or tokens are not yet loaded, it logs a warning and returns an empty array.
+     *
+     * @param {string} keyword - The keyword to search for.
+     * @param {number} limit - Number of results to show.
+     * @param {boolean} noLimit - disable limit
+     * @returns {Token[]} An array of tokens that match the given keyword.
+     */
+    token(keyword, limit = 100, noLimit = false) {
+        const result = [];
+        keyword = keyword.trim();
+        if (this.tokenIndices === undefined || this.tokens === undefined) {
+            console.warn("Token list still loading...");
+            return [];
+        }
+        const indices = this.tokenIndices.indices[keyword.toLowerCase()];
+        let count = 0;
+        for (const index in indices) {
+            count++;
+            result.push(this.tokens[index]);
+            if (!noLimit && count >= limit)
+                break;
+        }
+        return result;
+    }
+    /**
+     * Loads the token indices and tokens.
+     *
+     * This method loads the token indices and tokens if they are not already loaded.
+     * It also sets up a periodic update to refresh the token indices and tokens every minute.
+     *
+     * @returns {Promise<void>} A promise that resolves when the initial load is complete.
+     */
+    load() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.loaded) {
+                this._loaded = true;
+                let firstRun = true;
+                const update = () => __awaiter(this, void 0, void 0, function* () {
+                    if (this.disableFetch === false) {
+                        yield this.getTokenIndices();
+                        setTimeout(update, 60 * 1000);
+                    }
+                });
+                const updateFromPersistence = () => __awaiter(this, void 0, void 0, function* () {
+                    if (this.disableFetch === false) {
+                        yield this.loadFromPersistence();
+                        if (firstRun && this.loadFromPersistenceFn !== undefined) {
+                            yield update();
+                            firstRun = false;
+                        }
+                        if (!!this.tokens && !!this.tokenIndices) {
+                            if (!!this.storeToPersistenceFn && this.tokens.length > 0 && this.previousHash !== this.latestHash) {
+                                yield this.storeToPersistenceFn(this.tokenIndices, this.tokens);
+                            }
+                            setTimeout(() => __awaiter(this, void 0, void 0, function* () { return yield updateFromPersistence(); }), 60 * 1000);
+                            return;
+                        }
+                        setTimeout(() => __awaiter(this, void 0, void 0, function* () { return yield updateFromPersistence(); }), 1 * 1000);
+                    }
+                    else {
+                        yield this.loadFromPersistence();
+                        if (typeof this.tokens === 'undefined' || this.tokens.length === 0) {
+                            setTimeout(() => __awaiter(this, void 0, void 0, function* () { return yield updateFromPersistence(); }), 1 * 10000);
+                            return;
+                        }
+                        setTimeout(() => __awaiter(this, void 0, void 0, function* () { return yield updateFromPersistence(); }), 10 * 10000);
+                    }
+                });
+                yield updateFromPersistence();
+            }
+        });
+    }
+    /**
+     * Load tokens and indices from persistence
+     *
+     * @param tokenIndices
+     * @param tokens
+     * @returns
+     */
+    loadFromPersistence() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._loadedFromPersistence)
+                return;
+            if (this.loadFromPersistenceFn === undefined)
+                return;
+            const [tokenIndices, tokens] = yield this.loadFromPersistenceFn();
+            if (tokenIndices === undefined || tokens === undefined)
+                return;
+            this.tokenIndices = tokenIndices;
+            this.tokens = tokens;
+            this.latestHash = tokenIndices.hash;
+            this._loadedFromPersistence = true;
+        });
+    }
+    /**
+     * Retrieves and updates the token indices and tokens if necessary.
+     *
+     * This method checks if the current token indices and tokens are undefined.
+     * If they are, it fetches the token indices and tokens from the API.
+     * It then compares the hash of the current token indices with the hash from the server.
+     * If the hashes do not match, it updates the token indices and tokens.
+     *
+     * @private
+     * @returns {Promise<void>} A promise that resolves when the token indices and tokens are updated.
+     */
+    getTokenIndices() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.tokenIndices === undefined || this.latestHash === '') {
+                this.tokenIndices = yield this.getSearchIndices('tokens');
+                this.tokens = yield this.getAllTokens();
+                this.previousHash = '';
+                this.latestHash = this.tokenIndices.hash;
+                return;
+            }
+            const tokenIndices = yield this.getSearchIndices('tokens', this.tokenIndices.hash);
+            this.previousHash = this.tokenIndices.hash;
+            this.latestHash = tokenIndices.hash;
+            // If hash doesn't match, it means there's a new token.
+            if (tokenIndices.hash !== this.tokenIndices.hash) {
+                this.tokenIndices = tokenIndices;
+                this.tokens = yield this.getAllTokens();
+            }
+        });
+    }
+    /**
+     * Retrieves all tokens from the API.
+     *
+     * This method makes a GET request to the API to fetch all tokens.
+     *
+     * @private
+     * @returns {Promise<Token[]>} A promise that resolves to an array of tokens.
+     */
+    getAllTokens() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield axios_1.default.get(`${this.url}/tokens?all=true`)).data;
+        });
+    }
+    /**
+     * Retrieves the search indices from the API based on the provided key and optional hash.
+     *
+     * This method makes a GET request to the API to fetch the search indices for the specified key.
+     * If a hash is provided, it includes the hash in the request to check for updated indices.
+     *
+     * @private
+     * @param {string} key - The key to identify the search indices.
+     * @param {string} [hash] - Optional hash to validate against the current hash of the indices.
+     * @returns {Promise<SearchIndices>} A promise that resolves to the search indices for the specified key.
+     */
+    getSearchIndices(key, hash) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (hash !== undefined) {
+                return (yield axios_1.default.get(`${this.url}/searchIndices?key=${key}&hash=${hash}`)).data;
+            }
+            else {
+                return (yield axios_1.default.get(`${this.url}/searchIndices?key=${key}`)).data;
+            }
+        });
+    }
+}
+exports.Search = Search;

package/dist/classes/SimpleIxGenerator.d.ts

@@ -0,0 +1,57 @@
+import { IyfExtensionIxGenerator } from "../ixGenerator/IyfExtensionIxGenerator";
+import { IyfMainIxGenerator } from "../ixGenerator/IyfMainIxGenerator";
+import { MeteoraDlmmIxGenerator } from "../ixGenerator/MeteoraDlmmIxGenerator";
+import { UtilIxGenerator } from "../ixGenerator/UtilIxGenerator";
+import { OrcaIxGenerator } from "../ixGenerator/OrcaIxGenerator";
+import { RaydiumIxGenerator } from "../ixGenerator/RaydiumIxGenerator";
+import { SimplePdaGenerator } from "./SimplePdaGenerator";
+/**
+ * The SimpleIxGenerator class is a general-purpose utility for generating single
+ * transaction instructions for simple tasks on the Solana blockchain. It offers
+ * methods to set and verify transaction slots within an atomicity context, specifically
+ * interacting with the user's PDA (Program Derived Address) account.
+ */
+export declare class SimpleIxGenerator {
+    /**
+     * PDA generator instance
+     */
+    pda: SimplePdaGenerator;
+    /**
+     * Utility instruction generator for miscellaneous operations and transactions
+     * that don't fit into specific protocol categories.
+     */
+    util: UtilIxGenerator;
+    /**
+     * Instruction generator for the IYF (IndexYieldFarming) main protocol operations.
+     * Handles core protocol interactions and transactions.
+     */
+    iyfMain: IyfMainIxGenerator;
+    /**
+     * Instruction generator for IYF extension operations.
+     * Extends the functionality of the main IYF protocol with additional features.
+     * @param iyfMain - Reference to the main IYF instruction generator for dependency injection
+     */
+    iyfExtension: IyfExtensionIxGenerator;
+    /**
+     * Instruction generator for Meteora DLMM (Dynamic Liquidity Market Maker) operations.
+     * Handles concentrated liquidity pool interactions and transactions.
+     * @param iyfMain - Reference to the main IYF instruction generator for dependency injection
+     */
+    meteoraDlmm: MeteoraDlmmIxGenerator;
+    /**
+     * Instruction generator for Orca DEX operations.
+     * Handles Orca-specific pool interactions and transactions.
+     * @param iyfMain - Reference to the main IYF instruction generator for dependency injection
+     */
+    orca: OrcaIxGenerator;
+    /**
+     * Instruction generator for Raydium DEX operations.
+     * Handles Raydium-specific pool interactions, concentrated liquidity positions,
+     * and other Raydium protocol transactions.
+     * @param iyfMain - Reference to the main IYF instruction generator for dependency injection
+     * @param iyfExtension - Reference to the IYF extension instruction generator for additional functionality
+     * @param pda - Reference to the PDA generator for managing program derived addresses
+     */
+    raydium: RaydiumIxGenerator;
+}
+//# sourceMappingURL=SimpleIxGenerator.d.ts.map

package/dist/classes/SimpleIxGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimpleIxGenerator.d.ts","sourceRoot":"","sources":["../../src/classes/SimpleIxGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AACjF,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;;;GAKG;AACH,qBAAa,iBAAiB;IAE5B;;OAEG;IACI,GAAG,EAAE,kBAAkB,CAA2B;IAEzD;;;OAGG;IACI,IAAI,EAAE,eAAe,CAAyB;IAErD;;;OAGG;IACI,OAAO,EAAE,kBAAkB,CAA4B;IAE9D;;;;OAIG;IACI,YAAY,EAAE,uBAAuB,CAAuD;IAEnG;;;;OAIG;IACI,WAAW,EAAE,sBAAsB,CAA8C;IAExF;;;;OAIG;IACI,IAAI,EAAE,eAAe,CAA+C;IAE3E;;;;;;;OAOG;IACI,OAAO,EAAE,kBAAkB,CAAqE;CACxG"}

package/dist/classes/SimpleIxGenerator.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleIxGenerator = void 0;
+const IyfExtensionIxGenerator_1 = require("../ixGenerator/IyfExtensionIxGenerator");
+const IyfMainIxGenerator_1 = require("../ixGenerator/IyfMainIxGenerator");
+const MeteoraDlmmIxGenerator_1 = require("../ixGenerator/MeteoraDlmmIxGenerator");
+const UtilIxGenerator_1 = require("../ixGenerator/UtilIxGenerator");
+const OrcaIxGenerator_1 = require("../ixGenerator/OrcaIxGenerator");
+const RaydiumIxGenerator_1 = require("../ixGenerator/RaydiumIxGenerator");
+const SimplePdaGenerator_1 = require("./SimplePdaGenerator");
+/**
+ * The SimpleIxGenerator class is a general-purpose utility for generating single
+ * transaction instructions for simple tasks on the Solana blockchain. It offers
+ * methods to set and verify transaction slots within an atomicity context, specifically
+ * interacting with the user's PDA (Program Derived Address) account.
+ */
+class SimpleIxGenerator {
+    constructor() {
+        /**
+         * PDA generator instance
+         */
+        this.pda = new SimplePdaGenerator_1.SimplePdaGenerator();
+        /**
+         * Utility instruction generator for miscellaneous operations and transactions
+         * that don't fit into specific protocol categories.
+         */
+        this.util = new UtilIxGenerator_1.UtilIxGenerator();
+        /**
+         * Instruction generator for the IYF (IndexYieldFarming) main protocol operations.
+         * Handles core protocol interactions and transactions.
+         */
+        this.iyfMain = new IyfMainIxGenerator_1.IyfMainIxGenerator();
+        /**
+         * Instruction generator for IYF extension operations.
+         * Extends the functionality of the main IYF protocol with additional features.
+         * @param iyfMain - Reference to the main IYF instruction generator for dependency injection
+         */
+        this.iyfExtension = new IyfExtensionIxGenerator_1.IyfExtensionIxGenerator(this.pda, this.iyfMain);
+        /**
+         * Instruction generator for Meteora DLMM (Dynamic Liquidity Market Maker) operations.
+         * Handles concentrated liquidity pool interactions and transactions.
+         * @param iyfMain - Reference to the main IYF instruction generator for dependency injection
+         */
+        this.meteoraDlmm = new MeteoraDlmmIxGenerator_1.MeteoraDlmmIxGenerator(this, this.pda);
+        /**
+         * Instruction generator for Orca DEX operations.
+         * Handles Orca-specific pool interactions and transactions.
+         * @param iyfMain - Reference to the main IYF instruction generator for dependency injection
+         */
+        this.orca = new OrcaIxGenerator_1.OrcaIxGenerator(this.iyfMain, this.pda);
+        /**
+         * Instruction generator for Raydium DEX operations.
+         * Handles Raydium-specific pool interactions, concentrated liquidity positions,
+         * and other Raydium protocol transactions.
+         * @param iyfMain - Reference to the main IYF instruction generator for dependency injection
+         * @param iyfExtension - Reference to the IYF extension instruction generator for additional functionality
+         * @param pda - Reference to the PDA generator for managing program derived addresses
+         */
+        this.raydium = new RaydiumIxGenerator_1.RaydiumIxGenerator(this.iyfMain, this.iyfExtension, this.pda);
+    }
+}
+exports.SimpleIxGenerator = SimpleIxGenerator;

package/dist/classes/SimplePdaGenerator.d.ts

@@ -0,0 +1,28 @@
+import { HawksightPdaGenerator } from "../pdaGenerator/HawksightPdaGenerator";
+import { MeteoraPdaGenerator } from "../pdaGenerator/MeteoraPdaGenerator";
+import { OrcaPdaGenerator } from "../pdaGenerator/OrcaPdaGenerator";
+import { RaydiumPdaGenerator } from "../pdaGenerator/RaydiumPdaGenerator";
+import { UtilPdaGenerator } from "../pdaGenerator/UtilPdaGenerator";
+export declare class SimplePdaGenerator {
+    /**
+     * Util PDA Generator (Other PDA generators / uncategorized)
+     */
+    util: UtilPdaGenerator;
+    /**
+     * Hawksight PDA Generator
+     */
+    hawksight: HawksightPdaGenerator;
+    /**
+     * Meteora PDA Generator
+     */
+    meteora: MeteoraPdaGenerator;
+    /**
+     * Meteora PDA Generator
+     */
+    orca: OrcaPdaGenerator;
+    /**
+     * Meteora PDA Generator
+     */
+    raydium: RaydiumPdaGenerator;
+}
+//# sourceMappingURL=SimplePdaGenerator.d.ts.map

package/dist/classes/SimplePdaGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimplePdaGenerator.d.ts","sourceRoot":"","sources":["../../src/classes/SimplePdaGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAEpE,qBAAa,kBAAkB;IAE7B;;OAEG;IACI,IAAI,EAAE,gBAAgB,CAA0B;IAEvD;;OAEG;IACI,SAAS,EAAE,qBAAqB,CAA+B;IAEtE;;OAEG;IACI,OAAO,EAAE,mBAAmB,CAA6B;IAEhE;;OAEG;IACI,IAAI,EAAE,gBAAgB,CAA0B;IAEvD;;OAEG;IACI,OAAO,EAAE,mBAAmB,CAA6B;CACjE"}

package/dist/classes/SimplePdaGenerator.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimplePdaGenerator = void 0;
+const HawksightPdaGenerator_1 = require("../pdaGenerator/HawksightPdaGenerator");
+const MeteoraPdaGenerator_1 = require("../pdaGenerator/MeteoraPdaGenerator");
+const OrcaPdaGenerator_1 = require("../pdaGenerator/OrcaPdaGenerator");
+const RaydiumPdaGenerator_1 = require("../pdaGenerator/RaydiumPdaGenerator");
+const UtilPdaGenerator_1 = require("../pdaGenerator/UtilPdaGenerator");
+class SimplePdaGenerator {
+    constructor() {
+        /**
+         * Util PDA Generator (Other PDA generators / uncategorized)
+         */
+        this.util = new UtilPdaGenerator_1.UtilPdaGenerator();
+        /**
+         * Hawksight PDA Generator
+         */
+        this.hawksight = new HawksightPdaGenerator_1.HawksightPdaGenerator();
+        /**
+         * Meteora PDA Generator
+         */
+        this.meteora = new MeteoraPdaGenerator_1.MeteoraPdaGenerator();
+        /**
+         * Meteora PDA Generator
+         */
+        this.orca = new OrcaPdaGenerator_1.OrcaPdaGenerator();
+        /**
+         * Meteora PDA Generator
+         */
+        this.raydium = new RaydiumPdaGenerator_1.RaydiumPdaGenerator();
+    }
+}
+exports.SimplePdaGenerator = SimplePdaGenerator;

package/dist/classes/Transaction.d.ts

@@ -0,0 +1,229 @@
+import * as client from "@hawksightco/swagger-client";
+import * as web3 from "@solana/web3.js";
+import { GeneralUtility } from "./GeneralUtility";
+import { TransactionMetadata } from "../types";
+export type SimulatedTransactionResponse = {
+    err: web3.TransactionError | string | null;
+    logs: Array<string> | null;
+    accounts?: (web3.SimulatedTransactionAccountInfo | null)[] | null;
+    unitsConsumed: number;
+    returnData?: web3.TransactionReturnData | null;
+};
+export type TransactionMetadataResponse = {
+    description: string;
+    estimatedFeeInSOL: string;
+    addressLookupTableAddresses: string[];
+    computeBudgetInstructions: Instruction[];
+    mainInstructions: Instruction[];
+    payer: string;
+    signature: string;
+};
+export type Instruction = {
+    accounts: {
+        isSigner: boolean;
+        isWritable: boolean;
+        pubkey: string;
+    }[];
+    data: string;
+    programId: string;
+};
+/**
+ * Represents a transaction object in Solana using the web3.js library.
+ * This class encapsulates the logic for creating, signing, and verifying signatures of transactions.
+ */
+export declare class Transaction {
+    readonly txMetadataResponse: TransactionMetadataResponse;
+    readonly payerKey: web3.PublicKey;
+    protected latestBlockhash: {
+        blockhash: string;
+        lastValidBlockHeight: number;
+    };
+    readonly alts: web3.AddressLookupTableAccount[];
+    protected generalUtility: GeneralUtility;
+    protected readonly MAX_TX_SIZE = 1200;
+    /** Compiled TransactionMessage which includes payer, instructions, and recent blockhash */
+    protected _txMessage: web3.TransactionMessage;
+    get txMessage(): web3.TransactionMessage;
+    /** Versioned transaction built from the transaction message */
+    protected _versionedTransaction: web3.VersionedTransaction;
+    get versionedTransaction(): web3.VersionedTransaction;
+    /** A map indicating whether each required signer has signed the transaction */
+    readonly requiredSigners: Record<string, boolean>;
+    /** Estimated fee in SOL for priority fee when addPriorityFee() method is called. */
+    protected _priorityFeeEstimate: string;
+    get priorityFeeEstimate(): string;
+    /** The blockhash of a recent ledger entry */
+    get recentBlockhash(): string;
+    /** Array of TransactionInstruction to be executed in this transaction */
+    protected _instructions: web3.TransactionInstruction[];
+    get instructions(): web3.TransactionInstruction[];
+    /** last valid block height */
+    get lastValidBlockHeight(): number;
+    /**
+     * Constructs a new Transaction object.
+     *
+     * @param payerKey PublicKey of the transaction payer
+     * @param instructions Array of TransactionInstruction to be executed in this transaction
+     * @param recentBlockhash The blockhash of a recent ledger entry
+     * @param alts Address lookup tables that optimize account address storage
+     */
+    constructor(txMetadataResponse: TransactionMetadataResponse, payerKey: web3.PublicKey, latestBlockhash: {
+        blockhash: string;
+        lastValidBlockHeight: number;
+    }, alts: web3.AddressLookupTableAccount[], generalUtility: GeneralUtility, _mainIxs?: web3.TransactionInstruction[]);
+    /**
+     * Signs the transaction with provided signers.
+     *
+     * @param signers Array of Signer objects whose private keys will be used to sign the transaction.
+     * @param idempotent Boolean indicating whether signing should be idempotent (default is false).
+     * @throws Error if a signer is not required or has already signed the transaction when not idempotent.
+     */
+    sign(signers: web3.Signer[], idempotent?: boolean): void;
+    /**
+     * Add a signature on the transaction with provided signature.
+     *
+     * @param publicKey The public key of the signer
+     * @param signature A signature of the signed transaction
+     * @throws Error if a signer is not required or has already signed the transaction.
+     */
+    addSignature(publicKey: web3.PublicKey, signature: Uint8Array): void;
+    /**
+     * Checks if all required signers have signed the transaction.
+     *
+     * @returns Boolean indicating whether all required signers have signed.
+     */
+    isSignedByRequiredSigners(): boolean;
+    /**
+     * Add priority fee instructions (compute budget) with a fixed priority fee.
+     *
+     * This method adds priority fee instructions to the transaction based on a fixed priority fee.
+     *
+     * @param connection - The connection to the Solana cluster.
+     * @param computeUnitLimit - The limit on the number of compute units.
+     * @param fixedPriority - Set to true to indicate a fixed priority fee.
+     * @param fixedPriorityFee - The fixed priority fee in lamports.
+     * @returns An array of transaction instructions.
+     */
+    addPriorityFeeIx(connection: web3.Connection, computeUnitLimit: number, fixedPriority: true, fixedPriorityFee: number): Promise<web3.TransactionInstruction[]>;
+    /**
+     * Add priority fee instructions (compute budget) with a variable priority defined by Helius.
+     *
+     * This method adds priority fee instructions to the transaction based on the specified
+     * priority level and compute unit limit. It ensures that the total fee does not exceed
+     * the specified maximum priority fee (in SOL) if provided.
+     *
+     * @param connection - The connection to the Solana cluster.
+     * @param computeUnitLimit - The limit on the number of compute units.
+     * @param fixedPriority - Set to false to indicate a variable priority fee.
+     * @param priorityLevel - The priority level for the fee estimation.
+     * @param maxPriorityFee - The maximum priority fee in SOL (optional).
+     * @returns An array of transaction instructions.
+     */
+    addPriorityFeeIx(connection: web3.Connection, computeUnitLimit: number, fixedPriority: false, priorityLevel: client.PriorityLevel, maxPriorityFee?: number): Promise<web3.TransactionInstruction[]>;
+    /**
+     * Gets the compute unit limit from a transaction simulation.
+     *
+     * This function simulates a transaction and calculates the compute unit limit
+     * based on the simulation results. If an additional compute limit is provided,
+     * it is added to the units consumed in the simulation. Otherwise, the units
+     * consumed are increased by 10%.
+     *
+     * @param {web3.Connection} connection - The connection object to the Solana cluster.
+     * @param {number} [additionalComputeLimit] - Optional additional compute limit to add to the units consumed.
+     * @returns {Promise<number>} - A promise that resolves to the total compute unit limit.
+     * @throws {Error} - Throws an error if the transaction simulation fails.
+     */
+    getComputeUnitLimit(connection: web3.Connection, additionalComputeLimit?: number): Promise<number>;
+    /**
+     * Simulate transaction
+     *
+     * @param connection
+     * @returns
+     */
+    simulateTransaction(connection: web3.Connection, signers?: web3.Keypair[]): Promise<SimulatedTransactionResponse>;
+    /**
+     * Builds transaction object
+     */
+    buildTransaction(latestBlockhash: web3.BlockhashWithExpiryBlockHeight): [web3.TransactionMessage, web3.VersionedTransaction];
+    /**
+     * Gathers the public keys of all parties required to sign the transaction.
+     *
+     * @returns A record of signer public keys mapped to a boolean indicating whether they have signed.
+     */
+    protected getRequiredSigners(): Record<string, boolean>;
+    /**
+     * Find setComputeUnitLimit index within the instructions
+     */
+    protected findSetComputeUnitLimitIndex(instructions?: web3.TransactionInstruction[]): number;
+    /**
+     * Find setComputeUnitPrice index within the instructions
+     */
+    protected findSetComputeUnitPriceIndex(instructions?: web3.TransactionInstruction[]): number;
+    /**
+     * Remove priority fee instructions
+     */
+    protected removePriorityFeeIxs(): void;
+    /**
+     * Injects a candidate user alt into the transaction metadata.
+     *
+     * @param connection - The connection to the Solana cluster.
+     * @returns A new transaction metadata with the candidate user alt injected.
+     */
+    injectCandidateUserAlt(connection: web3.Connection): Promise<{
+        metadata: TransactionMetadata;
+        withUserAlt: boolean;
+    }>;
+    /**
+     * Generate a new transaction metadata with a user alt injected.
+     *
+     * @param connection - The connection to the Solana cluster.
+     * @param lookupTable - The lookup table to inject into the transaction metadata.
+     * @returns A new transaction metadata with the user alt injected.
+     */
+    injectUserAlt(connection: web3.Connection, lookupTable: web3.PublicKey): Promise<TransactionMetadata>;
+    /**
+     * Close all address lookup tables.
+     * Dev Note: This is a temporary function to close all address lookup tables.
+     * This is not meant to be used in production. It is only meant to be used for testing.
+     *
+     * @param connection - The connection to the Solana cluster.
+     */
+    deactivateAllAddressLookupTable(connection: web3.Connection): Promise<TransactionMetadata>;
+    /**
+     * Close all address lookup tables.
+     * Dev Note: This is a temporary function to close all address lookup tables.
+     * This is not meant to be used in production. It is only meant to be used for testing.
+     *
+     * @param connection - The connection to the Solana cluster.
+     */
+    closeAllAddressLookupTable(connection: web3.Connection): Promise<TransactionMetadata>;
+    /**
+     * Create a new address lookup table.
+     *
+     * @param connection - The connection to the Solana cluster.
+     * @param payer - The payer of the transaction.
+     * @returns A new address lookup table.
+     */
+    createAddressLookupTable(connection: web3.Connection, payer: web3.PublicKey): Promise<[TransactionMetadata, web3.PublicKey]>;
+    private pubkeysNotInAlt;
+    /**
+     * List all unique pubkeys in the instructions
+     * @param instructions - Transaction instructions
+     * @returns Unique pubkeys
+     */
+    private listPubkeys;
+    /**
+     * Check if a pubkey is in an alt
+     * @param pubkey - Pubkey to check
+     * @returns True if the pubkey is in an alt, false otherwise
+     */
+    private pubkeyInAlt;
+    private _pubkeysNotInAlt;
+    /**
+     * Check if a pubkey is in an alt
+     * @param pubkey - Pubkey to check
+     * @returns True if the pubkey is in an alt, false otherwise
+     */
+    private _pubkeyInAlt;
+}
+//# sourceMappingURL=Transaction.d.ts.map

package/dist/classes/Transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Transaction.d.ts","sourceRoot":"","sources":["../../src/classes/Transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,6BAA6B,CAAC;AACtD,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAGxC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAE/C,MAAM,MAAM,4BAA4B,GAAG;IACzC,GAAG,EAAE,IAAI,CAAC,gBAAgB,GAAG,MAAM,GAAG,IAAI,CAAC;IAC3C,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,+BAA+B,GAAG,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC;IAClE,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IAExC,WAAW,EAAE,MAAM,CAAC;IAEpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,2BAA2B,EAAE,MAAM,EAAE,CAAC;IACtC,yBAAyB,EAAE,WAAW,EAAE,CAAC;IACzC,gBAAgB,EAAE,WAAW,EAAE,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;CACnB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE;QACR,QAAQ,EAAE,OAAO,CAAC;QAClB,UAAU,EAAE,OAAO,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,EAAE,CAAC;IACJ,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,qBAAa,WAAW;IAkDpB,QAAQ,CAAC,kBAAkB,EAAE,2BAA2B;IACxD,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS;IACjC,SAAS,CAAC,eAAe,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,oBAAoB,EAAE,MAAM,CAAA;KAAE;IAC9E,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,yBAAyB,EAAE;IAC/C,SAAS,CAAC,cAAc,EAAE,cAAc;IApD1C,SAAS,CAAC,QAAQ,CAAC,WAAW,QAAQ;IAEtC,2FAA2F;IAC3F,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,kBAAkB,CAAC;IAC9C,IAAI,SAAS,IAAI,IAAI,CAAC,kBAAkB,CAEvC;IAED,+DAA+D;IAC/D,SAAS,CAAC,qBAAqB,EAAE,IAAI,CAAC,oBAAoB,CAAC;IAC3D,IAAI,oBAAoB,IAAI,IAAI,CAAC,oBAAoB,CAEpD;IAED,+EAA+E;IAC/E,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElD,oFAAoF;IACpF,SAAS,CAAC,oBAAoB,EAAE,MAAM,CAAM;IAC5C,IAAI,mBAAmB,IAAI,MAAM,CAEhC;IAED,6CAA6C;IAC7C,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,yEAAyE;IACzE,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,sBAAsB,EAAE,CAAC;IACvD,IAAI,YAAY,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAEhD;IAED,8BAA8B;IAC9B,IAAI,oBAAoB,IAAI,MAAM,CAEjC;IAED;;;;;;;OAOG;gBAEQ,kBAAkB,EAAE,2BAA2B,EAC/C,QAAQ,EAAE,IAAI,CAAC,SAAS,EACvB,eAAe,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,oBAAoB,EAAE,MAAM,CAAA;KAAE,EACrE,IAAI,EAAE,IAAI,CAAC,yBAAyB,EAAE,EACrC,cAAc,EAAE,cAAc,EACxC,QAAQ,GAAE,IAAI,CAAC,sBAAsB,EAAO;IA8C9C;;;;;;OAMG;IACH,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,UAAU,GAAE,OAAe,GAAG,IAAI;IAuB/D;;;;;;OAMG;IACH,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,GAAG,IAAI;IAcpE;;;;OAIG;IACH,yBAAyB,IAAI,OAAO;IAIpC;;;;;;;;;;OAUG;IACG,gBAAgB,CACpB,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,IAAI,EACnB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;IAEzC;;;;;;;;;;;;;OAaG;IACG,gBAAgB,CACpB,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,gBAAgB,EAAE,MAAM,EACxB,aAAa,EAAE,KAAK,EACpB,aAAa,EAAE,MAAM,CAAC,aAAa,EACnC,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;IAwFzC;;;;;;;;;;;;OAYG;IACG,mBAAmB,CACvB,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,sBAAsB,CAAC,EAAE,MAAM,GAC9B,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;OAKG;IACG,mBAAmB,CACvB,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,OAAO,GAAE,IAAI,CAAC,OAAO,EAAO,GAC3B,OAAO,CAAC,4BAA4B,CAAC;IAyCxC;;OAEG;IACH,gBAAgB,CACd,eAAe,EAAE,IAAI,CAAC,8BAA8B,GACnD,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,oBAAoB,CAAC;IAcvD;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAWvD;;OAEG;IACH,SAAS,CAAC,4BAA4B,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,sBAAsB,EAAE,GAAG,MAAM;IAgB5F;;OAEG;IACH,SAAS,CAAC,4BAA4B,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,sBAAsB,EAAE,GAAG,MAAM;IAgB5F;;OAEG;IACH,SAAS,CAAC,oBAAoB;IAY9B;;;;;OAKG;IACG,sBAAsB,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;QACjE,QAAQ,EAAE,mBAAmB,CAAC;QAC9B,WAAW,EAAE,OAAO,CAAC;KACtB,CAAC;IAiDF;;;;;;OAMG;IACG,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAa3G;;;;;;OAMG;IACG,+BAA+B,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA0BhG;;;;;;OAMG;IACG,0BAA0B,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA2B3F;;;;;;OAMG;IACG,wBAAwB,CAC5B,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,KAAK,EAAE,IAAI,CAAC,SAAS,GACpB,OAAO,CAAC,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAgFjD,OAAO,CAAC,eAAe;IAKvB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAMnB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,gBAAgB;IAKxB;;;;OAIG;IACH,OAAO,CAAC,YAAY;CAYrB"}