@streamflow/common 6.0.0 → 6.0.2

package/dist/solana/types.d.ts

@@ -18,4 +18,5 @@ export interface CheckAssociatedTokenAccountsData {
 export interface AtaParams {
     mint: PublicKey;
     owner: PublicKey;
+    programId?: PublicKey;
 }

package/dist/solana/utils.d.ts

@@ -1,3 +1,4 @@
+import { Mint } from "@solana/spl-token";
 import { SignerWalletAdapter } from "@solana/wallet-adapter-base";
 import { BlockhashWithExpiryBlockHeight, Commitment, Connection, Keypair, PublicKey, Transaction, TransactionInstruction } from "@solana/web3.js";
 import { Account, AtaParams, ITransactionSolanaExt } from "./types";
@@ -24,12 +25,6 @@ export declare function isSignerWallet(walletOrKeypair: Keypair | SignerWalletAd
 export declare function isSignerKeypair(walletOrKeypair: Keypair | SignerWalletAdapter): walletOrKeypair is Keypair;
 /**
  * Creates a Transaction with given instructions and optionally signs it.
- * Be careful when passing `commitment` as for `confirmed` blockhash it always returns blockheight + 300 in `lastValidBlockHeight`
- * And if you use this blockheight to confirm the transaction it could happen so that transaction is successfully executed
- * But because `confirmTransaction` waits for only a minute it considers tx as expired as it could be that 300 blocks won't pass in a minute
- * https://solana.stackexchange.com/questions/6238/why-is-lastvalidblockheight-300-blocks-ahead-than-current-blockheight-if-hashes
- * https://solana.com/docs/core/transactions/retry
- * It might be better to rely on `commitment` level that you pass to `Connection` instance of Solana client as it will be used when fetching blockheight on transaction confirmation
  * @param connection - Solana client connection
  * @param ixs - Instructions to add to the Transaction
  * @param payer - PublicKey of payer
@@ -44,6 +39,10 @@ export declare function prepareTransaction(connection: Connection, ixs: Transact
 export declare function signTransaction(invoker: Keypair | SignerWalletAdapter, tx: Transaction): Promise<Transaction>;
 /**
  * Signs, sends and confirms Transaction
+ * Confirmation strategy is not 100% reliable here as in times of congestion there can be a case that tx is executed,
+ * but is not in `commitment` state and so it's not considered executed by the `sendAndConfirmRawTransaction` method,
+ * and it raises an expiry error even though transaction may be executed soon.
+ * So we add additional 50 blocks for checks to account for such issues.
  * @param connection - Solana client connection
  * @param invoker - Keypair used as signer
  * @param tx - Transaction instance
@@ -55,21 +54,23 @@ export declare function signAndExecuteTransaction(connection: Connection, invoke
  * Shorthand call signature for getAssociatedTokenAddress, with allowance for address to be offCurve
  * @param {PublicKey} mint - SPL token Mint address.
  * @param {PublicKey} owner - Owner of the Associated Token Address
+ * @param {PublicKey} programId - Program ID of the mint
  * @return {Promise<PublicKey>} - Associated Token Address
  */
-export declare function ata(mint: PublicKey, owner: PublicKey): Promise<PublicKey>;
+export declare function ata(mint: PublicKey, owner: PublicKey, programId?: PublicKey): Promise<PublicKey>;
 /**
  * Function that checks whether ATA exists for each provided owner
  * @param connection - Solana client connection
- * @param paramsBatch - Array of Params for an each ATA account: {mint, owner}
- * @returns Array of boolean where each members corresponds to owners member
+ * @param paramsBatch - Array of Params for each ATA account: {mint, owner}
+ * @returns Array of boolean where each member corresponds to an owner
  */
 export declare function ataBatchExist(connection: Connection, paramsBatch: AtaParams[]): Promise<boolean[]>;
+export declare function enrichAtaParams(connection: Connection, paramsBatch: AtaParams[]): Promise<AtaParams[]>;
 /**
  * Generates a Transaction to create ATA for an array of owners
  * @param connection - Solana client connection
  * @param payer - Transaction invoker, should be a signer
- * @param coparamsBatchnfigs - Array of Params for an each ATA account: {mint, owner}
+ * @param paramsBatch - Array of Params for an each ATA account: {mint, owner}
  * @returns Unsigned Transaction with create ATA instructions
  */
 export declare function generateCreateAtaBatchTx(connection: Connection, payer: PublicKey, paramsBatch: AtaParams[]): Promise<{
@@ -90,12 +91,26 @@ export declare function createAtaBatch(connection: Connection, invoker: Keypair
  * @param owners - Array of ATA owners
  * @param mint - Mint for which ATA will be checked
  * @param invoker - Transaction invoker and payer
+ * @param programId - Program ID of the Mint
  * @returns Array of Transaction Instructions that should be added to a transaction
  */
-export declare function checkOrCreateAtaBatch(connection: Connection, owners: PublicKey[], mint: PublicKey, invoker: SignerWalletAdapter | Keypair): Promise<TransactionInstruction[]>;
+export declare function checkOrCreateAtaBatch(connection: Connection, owners: PublicKey[], mint: PublicKey, invoker: SignerWalletAdapter | Keypair, programId?: PublicKey): Promise<TransactionInstruction[]>;
 /**
  * Create Base instructions for Solana
  * - sets compute price if `computePrice` is provided
  * - sets compute limit if `computeLimit` is provided
  */
 export declare function prepareBaseInstructions(connection: Connection, { computePrice, computeLimit }: ITransactionSolanaExt): TransactionInstruction[];
+/**
+ * Retrieve information about a mint and its program ID, support all Token Programs.
+ *
+ * @param connection Connection to use
+ * @param address    Mint account
+ * @param commitment Desired level of commitment for querying the state
+ *
+ * @return Mint information
+ */
+export declare function getMintAndProgram(connection: Connection, address: PublicKey, commitment?: Commitment): Promise<{
+    mint: Mint;
+    programId: PublicKey;
+}>;

package/dist/solana/utils.js

@@ -75,7 +75,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareBaseInstructions = exports.checkOrCreateAtaBatch = exports.createAtaBatch = exports.generateCreateAtaBatchTx = exports.ataBatchExist = exports.ata = exports.signAndExecuteTransaction = exports.signTransaction = exports.prepareTransaction = exports.isSignerKeypair = exports.isSignerWallet = exports.getProgramAccounts = void 0;
+exports.getMintAndProgram = exports.prepareBaseInstructions = exports.checkOrCreateAtaBatch = exports.createAtaBatch = exports.generateCreateAtaBatchTx = exports.enrichAtaParams = exports.ataBatchExist = exports.ata = exports.signAndExecuteTransaction = exports.signTransaction = exports.prepareTransaction = exports.isSignerKeypair = exports.isSignerWallet = exports.getProgramAccounts = void 0;
 var spl_token_1 = require("@solana/spl-token");
 var web3_js_1 = require("@solana/web3.js");
 var bs58_1 = __importDefault(require("bs58"));
@@ -126,12 +126,6 @@ function isSignerKeypair(walletOrKeypair) {
 exports.isSignerKeypair = isSignerKeypair;
 /**
  * Creates a Transaction with given instructions and optionally signs it.
- * Be careful when passing `commitment` as for `confirmed` blockhash it always returns blockheight + 300 in `lastValidBlockHeight`
- * And if you use this blockheight to confirm the transaction it could happen so that transaction is successfully executed
- * But because `confirmTransaction` waits for only a minute it considers tx as expired as it could be that 300 blocks won't pass in a minute
- * https://solana.stackexchange.com/questions/6238/why-is-lastvalidblockheight-300-blocks-ahead-than-current-blockheight-if-hashes
- * https://solana.com/docs/core/transactions/retry
- * It might be better to rely on `commitment` level that you pass to `Connection` instance of Solana client as it will be used when fetching blockheight on transaction confirmation
  * @param connection - Solana client connection
  * @param ixs - Instructions to add to the Transaction
  * @param payer - PublicKey of payer
@@ -201,6 +195,10 @@ function signTransaction(invoker, tx) {
 exports.signTransaction = signTransaction;
 /**
  * Signs, sends and confirms Transaction
+ * Confirmation strategy is not 100% reliable here as in times of congestion there can be a case that tx is executed,
+ * but is not in `commitment` state and so it's not considered executed by the `sendAndConfirmRawTransaction` method,
+ * and it raises an expiry error even though transaction may be executed soon.
+ * So we add additional 50 blocks for checks to account for such issues.
  * @param connection - Solana client connection
  * @param invoker - Keypair used as signer
  * @param tx - Transaction instance
@@ -209,7 +207,7 @@ exports.signTransaction = signTransaction;
  */
 function signAndExecuteTransaction(connection, invoker, tx, hash) {
     return __awaiter(this, void 0, void 0, function () {
-        var signedTx, rawTx, confirmationStrategy, signature;
+        var signedTx, rawTx, confirmationStrategy;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, signTransaction(invoker, tx)];
@@ -219,14 +217,11 @@ function signAndExecuteTransaction(connection, invoker, tx, hash) {
                     if (!hash.lastValidBlockHeight || !signedTx.signature || !hash.blockhash)
                         throw Error("Error with transaction parameters.");
                     confirmationStrategy = {
-                        lastValidBlockHeight: hash.lastValidBlockHeight,
+                        lastValidBlockHeight: hash.lastValidBlockHeight + 50,
                         signature: bs58_1.default.encode(signedTx.signature),
                         blockhash: hash.blockhash,
                     };
-                    return [4 /*yield*/, (0, web3_js_1.sendAndConfirmRawTransaction)(connection, rawTx, confirmationStrategy)];
-                case 2:
-                    signature = _a.sent();
-                    return [2 /*return*/, signature];
+                    return [2 /*return*/, (0, web3_js_1.sendAndConfirmRawTransaction)(connection, rawTx, confirmationStrategy)];
             }
         });
     });
@@ -236,17 +231,18 @@ exports.signAndExecuteTransaction = signAndExecuteTransaction;
  * Shorthand call signature for getAssociatedTokenAddress, with allowance for address to be offCurve
  * @param {PublicKey} mint - SPL token Mint address.
  * @param {PublicKey} owner - Owner of the Associated Token Address
+ * @param {PublicKey} programId - Program ID of the mint
  * @return {Promise<PublicKey>} - Associated Token Address
  */
-function ata(mint, owner) {
-    return (0, spl_token_1.getAssociatedTokenAddress)(mint, owner, true);
+function ata(mint, owner, programId) {
+    return (0, spl_token_1.getAssociatedTokenAddress)(mint, owner, true, programId);
 }
 exports.ata = ata;
 /**
  * Function that checks whether ATA exists for each provided owner
  * @param connection - Solana client connection
- * @param paramsBatch - Array of Params for an each ATA account: {mint, owner}
- * @returns Array of boolean where each members corresponds to owners member
+ * @param paramsBatch - Array of Params for each ATA account: {mint, owner}
+ * @returns Array of boolean where each member corresponds to an owner
  */
 function ataBatchExist(connection, paramsBatch) {
     return __awaiter(this, void 0, void 0, function () {
@@ -255,16 +251,10 @@ function ataBatchExist(connection, paramsBatch) {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, Promise.all(paramsBatch.map(function (_a) {
-                        var mint = _a.mint, owner = _a.owner;
+                        var mint = _a.mint, owner = _a.owner, programId = _a.programId;
                         return __awaiter(_this, void 0, void 0, function () {
-                            var pubkey;
                             return __generator(this, function (_b) {
-                                switch (_b.label) {
-                                    case 0: return [4 /*yield*/, ata(mint, owner)];
-                                    case 1:
-                                        pubkey = _b.sent();
-                                        return [2 /*return*/, pubkey];
-                                }
+                                return [2 /*return*/, ata(mint, owner, programId)];
                             });
                         });
                     }))];
@@ -279,11 +269,42 @@ function ataBatchExist(connection, paramsBatch) {
     });
 }
 exports.ataBatchExist = ataBatchExist;
+function enrichAtaParams(connection, paramsBatch) {
+    return __awaiter(this, void 0, void 0, function () {
+        var programIdByMint;
+        var _this = this;
+        return __generator(this, function (_a) {
+            programIdByMint = {};
+            return [2 /*return*/, Promise.all(paramsBatch.map(function (params) { return __awaiter(_this, void 0, void 0, function () {
+                    var mintStr, programId;
+                    return __generator(this, function (_a) {
+                        switch (_a.label) {
+                            case 0:
+                                if (params.programId) {
+                                    return [2 /*return*/, params];
+                                }
+                                mintStr = params.mint.toString();
+                                if (!!(mintStr in programIdByMint)) return [3 /*break*/, 2];
+                                return [4 /*yield*/, getMintAndProgram(connection, params.mint)];
+                            case 1:
+                                programId = (_a.sent()).programId;
+                                programIdByMint[mintStr] = programId;
+                                _a.label = 2;
+                            case 2:
+                                params.programId = programIdByMint[mintStr];
+                                return [2 /*return*/, params];
+                        }
+                    });
+                }); }))];
+        });
+    });
+}
+exports.enrichAtaParams = enrichAtaParams;
 /**
  * Generates a Transaction to create ATA for an array of owners
  * @param connection - Solana client connection
  * @param payer - Transaction invoker, should be a signer
- * @param coparamsBatchnfigs - Array of Params for an each ATA account: {mint, owner}
+ * @param paramsBatch - Array of Params for an each ATA account: {mint, owner}
  * @returns Unsigned Transaction with create ATA instructions
  */
 function generateCreateAtaBatchTx(connection, payer, paramsBatch) {
@@ -293,25 +314,28 @@ function generateCreateAtaBatchTx(connection, payer, paramsBatch) {
         var _this = this;
         return __generator(this, function (_b) {
             switch (_b.label) {
-                case 0: return [4 /*yield*/, Promise.all(paramsBatch.map(function (_a) {
-                        var mint = _a.mint, owner = _a.owner;
-                        return __awaiter(_this, void 0, void 0, function () {
-                            var _b, _c;
-                            return __generator(this, function (_d) {
-                                switch (_d.label) {
-                                    case 0:
-                                        _b = spl_token_1.createAssociatedTokenAccountInstruction;
-                                        _c = [payer];
-                                        return [4 /*yield*/, ata(mint, owner)];
-                                    case 1: return [2 /*return*/, _b.apply(void 0, _c.concat([_d.sent(), owner, mint]))];
-                                }
-                            });
-                        });
-                    }))];
+                case 0: return [4 /*yield*/, enrichAtaParams(connection, paramsBatch)];
                 case 1:
+                    paramsBatch = _b.sent();
+                    return [4 /*yield*/, Promise.all(paramsBatch.map(function (_a) {
+                            var mint = _a.mint, owner = _a.owner, programId = _a.programId;
+                            return __awaiter(_this, void 0, void 0, function () {
+                                var _b, _c;
+                                return __generator(this, function (_d) {
+                                    switch (_d.label) {
+                                        case 0:
+                                            _b = spl_token_1.createAssociatedTokenAccountInstruction;
+                                            _c = [payer];
+                                            return [4 /*yield*/, ata(mint, owner)];
+                                        case 1: return [2 /*return*/, _b.apply(void 0, _c.concat([_d.sent(), owner, mint, programId]))];
+                                    }
+                                });
+                            });
+                        }))];
+                case 2:
                     ixs = _b.sent();
                     return [4 /*yield*/, connection.getLatestBlockhash()];
-                case 2:
+                case 3:
                     hash = _b.sent();
                     tx = (_a = new web3_js_1.Transaction({
                         feePayer: payer,
@@ -333,12 +357,17 @@ exports.generateCreateAtaBatchTx = generateCreateAtaBatchTx;
  */
 function createAtaBatch(connection, invoker, paramsBatch) {
     return __awaiter(this, void 0, void 0, function () {
-        var _a, tx, hash;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0: return [4 /*yield*/, generateCreateAtaBatchTx(connection, invoker.publicKey, paramsBatch)];
-                case 1:
-                    _a = _b.sent(), tx = _a.tx, hash = _a.hash;
+        var _a, tx, hash, _b, _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    _b = generateCreateAtaBatchTx;
+                    _c = [connection,
+                        invoker.publicKey];
+                    return [4 /*yield*/, enrichAtaParams(connection, paramsBatch)];
+                case 1: return [4 /*yield*/, _b.apply(void 0, _c.concat([_d.sent()]))];
+                case 2:
+                    _a = _d.sent(), tx = _a.tx, hash = _a.hash;
                     return [2 /*return*/, signAndExecuteTransaction(connection, invoker, tx, hash)];
             }
         });
@@ -351,9 +380,10 @@ exports.createAtaBatch = createAtaBatch;
  * @param owners - Array of ATA owners
  * @param mint - Mint for which ATA will be checked
  * @param invoker - Transaction invoker and payer
+ * @param programId - Program ID of the Mint
  * @returns Array of Transaction Instructions that should be added to a transaction
  */
-function checkOrCreateAtaBatch(connection, owners, mint, invoker) {
+function checkOrCreateAtaBatch(connection, owners, mint, invoker, programId) {
     return __awaiter(this, void 0, void 0, function () {
         var ixs, atas, owners_1, owners_1_1, owner, _a, _b, e_2_1, response, i;
         var e_2, _c;
@@ -371,7 +401,7 @@ function checkOrCreateAtaBatch(connection, owners, mint, invoker) {
                     if (!!owners_1_1.done) return [3 /*break*/, 5];
                     owner = owners_1_1.value;
                     _b = (_a = atas).push;
-                    return [4 /*yield*/, ata(mint, owner)];
+                    return [4 /*yield*/, ata(mint, owner, programId)];
                 case 3:
                     _b.apply(_a, [_d.sent()]);
                     _d.label = 4;
@@ -394,7 +424,7 @@ function checkOrCreateAtaBatch(connection, owners, mint, invoker) {
                     response = _d.sent();
                     for (i = 0; i < response.length; i++) {
                         if (!response[i]) {
-                            ixs.push((0, spl_token_1.createAssociatedTokenAccountInstruction)(invoker.publicKey, atas[i], owners[i], mint));
+                            ixs.push((0, spl_token_1.createAssociatedTokenAccountInstruction)(invoker.publicKey, atas[i], owners[i], mint, programId));
                         }
                     }
                     return [2 /*return*/, ixs];
@@ -420,3 +450,33 @@ function prepareBaseInstructions(connection, _a) {
     return ixs;
 }
 exports.prepareBaseInstructions = prepareBaseInstructions;
+/**
+ * Retrieve information about a mint and its program ID, support all Token Programs.
+ *
+ * @param connection Connection to use
+ * @param address    Mint account
+ * @param commitment Desired level of commitment for querying the state
+ *
+ * @return Mint information
+ */
+function getMintAndProgram(connection, address, commitment) {
+    return __awaiter(this, void 0, void 0, function () {
+        var accountInfo, programId;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, connection.getAccountInfo(address, commitment)];
+                case 1:
+                    accountInfo = _a.sent();
+                    programId = accountInfo === null || accountInfo === void 0 ? void 0 : accountInfo.owner;
+                    if (!(programId === null || programId === void 0 ? void 0 : programId.equals(spl_token_1.TOKEN_PROGRAM_ID)) && !(programId === null || programId === void 0 ? void 0 : programId.equals(spl_token_1.TOKEN_2022_PROGRAM_ID))) {
+                        programId = spl_token_1.TOKEN_PROGRAM_ID;
+                    }
+                    return [2 /*return*/, {
+                            mint: (0, spl_token_1.unpackMint)(address, accountInfo, programId),
+                            programId: programId,
+                        }];
+            }
+        });
+    });
+}
+exports.getMintAndProgram = getMintAndProgram;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "6.0.0",
+  "version": "6.0.2",
   "description": "Common utilities and types used by streamflow packages.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/index.js",
@@ -23,7 +23,7 @@
     "lint-config": "eslint --print-config",
     "prepublishOnly": "npm run lint && npm run build"
   },
-  "gitHead": "29f0a936ac05651c8b61d0e3db35f2f06533178c",
+  "gitHead": "53a78cbfcb7053bf2b9b267ad8f678cade3e6fe1",
   "devDependencies": {
     "@streamflow/eslint-config": "6.0.0",
     "@types/bn.js": "5.1.1",