@streamflow/common 6.0.0-alpha.1 → 6.0.0-alpha.10

package/dist/solana/types.d.ts

@@ -1,21 +1,13 @@
 /// <reference types="node" />
-import { SignerWalletAdapter } from "@solana/wallet-adapter-base";
-import { AccountInfo, Keypair, PublicKey, TransactionInstruction, TransactionSignature } from "@solana/web3.js";
-export { WalletAdapterNetwork as Cluster } from "@solana/wallet-adapter-base";
+import { AccountInfo, PublicKey } from "@solana/web3.js";
+export interface ITransactionSolanaExt {
+    computePrice?: number;
+    computeLimit?: number;
+}
 export interface Account {
     pubkey: PublicKey;
     account: AccountInfo<Buffer>;
 }
-export interface IInteractStreamSolanaExt {
-    invoker: SignerWalletAdapter | Keypair;
-}
-export interface TransactionResponse {
-    tx: TransactionSignature;
-}
-export interface TxResponse {
-    ixs: TransactionInstruction[];
-    tx: TransactionSignature;
-}
 export interface CheckAssociatedTokenAccountsData {
     sender: PublicKey;
     recipient: PublicKey;

package/dist/solana/types.js

@@ -1,5 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cluster = void 0;
-var wallet_adapter_base_1 = require("@solana/wallet-adapter-base");
-Object.defineProperty(exports, "Cluster", { enumerable: true, get: function () { return wallet_adapter_base_1.WalletAdapterNetwork; } });

package/dist/solana/utils.d.ts

@@ -1,6 +1,6 @@
 import { SignerWalletAdapter } from "@solana/wallet-adapter-base";
-import { Connection, Keypair, PublicKey, TransactionInstruction, Transaction, BlockhashWithExpiryBlockHeight } from "@solana/web3.js";
-import { AtaParams, Account } from "./types";
+import { BlockhashWithExpiryBlockHeight, Commitment, Connection, Keypair, PublicKey, Transaction, TransactionInstruction } from "@solana/web3.js";
+import { Account, AtaParams, ITransactionSolanaExt } from "./types";
 /**
  * Wrapper function for Solana web3 getProgramAccounts with slightly better call interface
  * @param {Connection} connection - Solana web3 connection object.
@@ -22,6 +22,25 @@ export declare function isSignerWallet(walletOrKeypair: Keypair | SignerWalletAd
  * @returns {boolean} - Returns true if parameter is a Keypair.
  */
 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
+ * @param commitment - optional Commitment that will be used to fetch latest blockhash
+ * @param partialSigners - optional signers that will be used to partially sign a Transaction
+ * @returns Transaction and Blockhash
+ */
+export declare function prepareTransaction(connection: Connection, ixs: TransactionInstruction[], payer: PublicKey | undefined | null, commitment?: Commitment, ...partialSigners: (Keypair | undefined)[]): Promise<{
+    tx: Transaction;
+    hash: BlockhashWithExpiryBlockHeight;
+}>;
 export declare function signTransaction(invoker: Keypair | SignerWalletAdapter, tx: Transaction): Promise<Transaction>;
 /**
  * Signs, sends and confirms Transaction
@@ -74,3 +93,9 @@ export declare function createAtaBatch(connection: Connection, invoker: Keypair
  * @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[]>;
+/**
+ * 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[];

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.checkOrCreateAtaBatch = exports.createAtaBatch = exports.generateCreateAtaBatchTx = exports.ataBatchExist = exports.ata = exports.signAndExecuteTransaction = exports.signTransaction = exports.isSignerKeypair = exports.isSignerWallet = exports.getProgramAccounts = void 0;
+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;
 var spl_token_1 = require("@solana/spl-token");
 var web3_js_1 = require("@solana/web3.js");
 var bs58_1 = __importDefault(require("bs58"));
@@ -124,6 +124,60 @@ function isSignerKeypair(walletOrKeypair) {
         walletOrKeypair.constructor.name === web3_js_1.Keypair.prototype.constructor.name);
 }
 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
+ * @param commitment - optional Commitment that will be used to fetch latest blockhash
+ * @param partialSigners - optional signers that will be used to partially sign a Transaction
+ * @returns Transaction and Blockhash
+ */
+function prepareTransaction(connection, ixs, payer, commitment) {
+    var partialSigners = [];
+    for (var _i = 4; _i < arguments.length; _i++) {
+        partialSigners[_i - 4] = arguments[_i];
+    }
+    return __awaiter(this, void 0, void 0, function () {
+        var hash, tx, partialSigners_1, partialSigners_1_1, signer;
+        var _a, e_1, _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0: return [4 /*yield*/, connection.getLatestBlockhash(commitment)];
+                case 1:
+                    hash = _c.sent();
+                    tx = (_a = new web3_js_1.Transaction({
+                        feePayer: payer,
+                        blockhash: hash.blockhash,
+                        lastValidBlockHeight: hash.lastValidBlockHeight,
+                    })).add.apply(_a, __spreadArray([], __read(ixs), false));
+                    try {
+                        for (partialSigners_1 = __values(partialSigners), partialSigners_1_1 = partialSigners_1.next(); !partialSigners_1_1.done; partialSigners_1_1 = partialSigners_1.next()) {
+                            signer = partialSigners_1_1.value;
+                            if (signer) {
+                                tx.partialSign(signer);
+                            }
+                        }
+                    }
+                    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                    finally {
+                        try {
+                            if (partialSigners_1_1 && !partialSigners_1_1.done && (_b = partialSigners_1.return)) _b.call(partialSigners_1);
+                        }
+                        finally { if (e_1) throw e_1.error; }
+                    }
+                    return [2 /*return*/, { tx: tx, hash: hash }];
+            }
+        });
+    });
+}
+exports.prepareTransaction = prepareTransaction;
 function signTransaction(invoker, tx) {
     return __awaiter(this, void 0, void 0, function () {
         var signedTx;
@@ -279,16 +333,13 @@ exports.generateCreateAtaBatchTx = generateCreateAtaBatchTx;
  */
 function createAtaBatch(connection, invoker, paramsBatch) {
     return __awaiter(this, void 0, void 0, function () {
-        var _a, tx, hash, signature;
+        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;
-                    return [4 /*yield*/, signAndExecuteTransaction(connection, invoker, tx, hash)];
-                case 2:
-                    signature = _b.sent();
-                    return [2 /*return*/, signature];
+                    return [2 /*return*/, signAndExecuteTransaction(connection, invoker, tx, hash)];
             }
         });
     });
@@ -304,8 +355,8 @@ exports.createAtaBatch = createAtaBatch;
  */
 function checkOrCreateAtaBatch(connection, owners, mint, invoker) {
     return __awaiter(this, void 0, void 0, function () {
-        var ixs, atas, owners_1, owners_1_1, owner, _a, _b, e_1_1, response, i;
-        var e_1, _c;
+        var ixs, atas, owners_1, owners_1_1, owner, _a, _b, e_2_1, response, i;
+        var e_2, _c;
         return __generator(this, function (_d) {
             switch (_d.label) {
                 case 0:
@@ -329,14 +380,14 @@ function checkOrCreateAtaBatch(connection, owners, mint, invoker) {
                     return [3 /*break*/, 2];
                 case 5: return [3 /*break*/, 8];
                 case 6:
-                    e_1_1 = _d.sent();
-                    e_1 = { error: e_1_1 };
+                    e_2_1 = _d.sent();
+                    e_2 = { error: e_2_1 };
                     return [3 /*break*/, 8];
                 case 7:
                     try {
                         if (owners_1_1 && !owners_1_1.done && (_c = owners_1.return)) _c.call(owners_1);
                     }
-                    finally { if (e_1) throw e_1.error; }
+                    finally { if (e_2) throw e_2.error; }
                     return [7 /*endfinally*/];
                 case 8: return [4 /*yield*/, connection.getMultipleAccountsInfo(atas)];
                 case 9:
@@ -352,3 +403,20 @@ function checkOrCreateAtaBatch(connection, owners, mint, invoker) {
     });
 }
 exports.checkOrCreateAtaBatch = checkOrCreateAtaBatch;
+/**
+ * Create Base instructions for Solana
+ * - sets compute price if `computePrice` is provided
+ * - sets compute limit if `computeLimit` is provided
+ */
+function prepareBaseInstructions(connection, _a) {
+    var computePrice = _a.computePrice, computeLimit = _a.computeLimit;
+    var ixs = [];
+    if (computePrice) {
+        ixs.push(web3_js_1.ComputeBudgetProgram.setComputeUnitPrice({ microLamports: computePrice }));
+    }
+    if (computeLimit) {
+        ixs.push(web3_js_1.ComputeBudgetProgram.setComputeUnitLimit({ units: computeLimit }));
+    }
+    return ixs;
+}
+exports.prepareBaseInstructions = prepareBaseInstructions;

package/dist/types.d.ts

@@ -23,10 +23,11 @@ export declare enum IChain {
  */
 export declare class ContractError extends Error {
     contractErrorCode: string | null;
+    description: string | null;
     /**
      * Constructs the Error Wrapper
      * @param error Original error raised probably by the chain SDK
      * @param code extracted code from the error if managed to parse it
      */
-    constructor(error: Error, code?: string | null);
+    constructor(error: Error, code?: string | null, description?: string | null);
 }

package/dist/types.js

@@ -43,9 +43,10 @@ var ContractError = /** @class */ (function (_super) {
      * @param error Original error raised probably by the chain SDK
      * @param code extracted code from the error if managed to parse it
      */
-    function ContractError(error, code) {
+    function ContractError(error, code, description) {
         var _this = _super.call(this, error.message) || this;
         _this.contractErrorCode = code !== null && code !== void 0 ? code : null;
+        _this.description = description !== null && description !== void 0 ? description : null;
         // Copy properties from the original error
         Object.setPrototypeOf(_this, ContractError.prototype);
         _this.name = "ContractError"; // Set the name property

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "6.0.0-alpha.1",
+  "version": "6.0.0-alpha.10",
   "description": "Common utilities and types used by streamflow packages.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/index.js",
@@ -23,9 +23,9 @@
     "lint-config": "eslint --print-config",
     "prepublishOnly": "npm run lint && npm run build"
   },
-  "gitHead": "fe960e0939f41867ce01a7515ec95f22c3fe6cbf",
+  "gitHead": "ba69862bbf25947672eb767e5852c9763a4a1165",
   "devDependencies": {
-    "@streamflow/eslint-config": "6.0.0-alpha.1",
+    "@streamflow/eslint-config": "6.0.0-alpha.10",
     "@types/bn.js": "5.1.1",
     "@types/jest": "29.2.4",
     "date-fns": "2.28.0",