@marinade.finance/cli-common - npm Package Compare versions

Comparing version 2.1.4 to 2.2.0

package.json

 {
   "name": "@marinade.finance/cli-common",
-  "version": "2.1.4",
+  "version": "2.2.0",
   "description": "CLI tooling",
@@ -26,5 +26,5 @@ "repository": {
     "@solana/web3.js": "^1.78.5",
-    "@marinade.finance/web3js-common": "^2.1.4",
-    "@marinade.finance/ts-common": "^2.1.4",
-    "@marinade.finance/ledger-utils": "^2.1.4",
+    "@marinade.finance/web3js-common": "^2.2.0",
+    "@marinade.finance/ts-common": "^2.2.0",
+    "@marinade.finance/ledger-utils": "^3.0.0",
     "@types/expand-tilde": "^2.0.0",
@@ -40,5 +40,5 @@ "bn.js": "^5.2.1",
     "@solana/web3.js": "^1.78.5",
-    "@marinade.finance/web3js-common": "^2.1.4",
-    "@marinade.finance/ts-common": "^2.1.4",
-    "@marinade.finance/ledger-utils": "^2.1.4",
+    "@marinade.finance/ledger-utils": "^3.0.0",
+    "@marinade.finance/web3js-common": "^2.2.0",
+    "@marinade.finance/ts-common": "^2.2.0",
     "bn.js": "^5.2.1",
@@ -45,0 +45,0 @@ "borsh": "^0.7.0",

src/context.d.ts

 import { Logger } from 'pino';
 import { Wallet } from '@marinade.finance/web3js-common';
+import { Finality } from '@solana/web3.js';
 export declare function getContext(): Context;
@@ -9,9 +10,11 @@ export declare function setContext(newContext: Context): void;
     readonly skipPreflight: boolean;
+    readonly confirmationFinality: Finality;
     readonly simulate: boolean;
     readonly printOnly: boolean;
     readonly commandName: string;
-    constructor({ wallet, logger, skipPreflight, simulate, printOnly, commandName, }: {
+    constructor({ wallet, logger, skipPreflight, confirmationFinality, simulate, printOnly, commandName, }: {
         wallet?: Wallet;
         logger: Logger;
         skipPreflight: boolean;
+        confirmationFinality?: Finality;
         simulate: boolean;
@@ -18,0 +21,0 @@ printOnly: boolean;

src/context.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Context = exports.setContext = exports.getContext = void 0;
-const wallet_1 = require("./wallet");
+const web3js_common_1 = require("@marinade.finance/web3js-common");
 let context;
@@ -21,3 +21,3 @@ function getContext() {
 class Context {
-    constructor({ wallet = new wallet_1.NullWallet(), logger, skipPreflight, simulate, printOnly, commandName, }) {
+    constructor({ wallet = new web3js_common_1.NullWallet(), logger, skipPreflight, confirmationFinality = 'finalized', simulate, printOnly, commandName, }) {
         this.commandName = commandName;
@@ -27,2 +27,3 @@ this.wallet = wallet;
         this.skipPreflight = skipPreflight;
+        this.confirmationFinality = confirmationFinality;
         this.simulate = simulate;
@@ -29,0 +30,0 @@ this.printOnly = printOnly;

src/index.d.ts

@@ -6,2 +6,1 @@ export * from './context';
 export * from './pinoLogging';
-export * from './wallet';

src/index.js

@@ -22,3 +22,2 @@ "use strict";
 __exportStar(require("./pinoLogging"), exports);
-__exportStar(require("./wallet"), exports);
 //# sourceMappingURL=index.js.map

src/parsers.d.ts

@@ -1,2 +0,2 @@
-import { Keypair, PublicKey, Commitment } from '@solana/web3.js';
+import { Keypair, PublicKey, Commitment, Finality } from '@solana/web3.js';
 import { Wallet } from '@marinade.finance/web3js-common';
@@ -10,3 +10,11 @@ import { Logger } from 'pino';
 export declare function parseWalletOrPubkey(pubkeyOrPathOrLedger: string): Promise<Wallet | PublicKey>;
+/**
+ * --keypair (considered as 'wallet') could be defined or undefined (and default is on parsing).
+ * For 'show*' command we don't need a working wallet, so we can use NullWallet.
+ * For '--print-only' we don't need a working wallet, so we can use NullWallet.
+ * For other commands we need a working wallet, when cannot be parsed then Error.
+ */
+export declare function parseWalletFromOpts(keypairArg: string, printOnly: boolean, commandArgs: string[], logger: Logger, defaultKeypair?: string): Promise<Wallet>;
 export declare function parseClusterUrl(url: string | undefined): string;
 export declare function parseCommitment(commitment: string): Commitment;
+export declare function parseConfirmationFinality(confirmationFinality: string): Finality;

src/parsers.js

@@ -6,3 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseCommitment = exports.parseClusterUrl = exports.parseWalletOrPubkey = exports.parseWallet = exports.parseFile = exports.parseKeypair = exports.parseKeypairOrPubkey = exports.parsePubkey = void 0;
+exports.parseConfirmationFinality = exports.parseCommitment = exports.parseClusterUrl = exports.parseWalletFromOpts = exports.parseWalletOrPubkey = exports.parseWallet = exports.parseFile = exports.parseKeypair = exports.parseKeypairOrPubkey = exports.parsePubkey = void 0;
 const web3_js_1 = require("@solana/web3.js");
@@ -14,5 +14,6 @@ const expand_tilde_1 = __importDefault(require("expand-tilde")); // eslint-disable-line node/no-extraneous-import
 const error_1 = require("./error");
+const web3js_common_1 = require("@marinade.finance/web3js-common");
 const context_1 = require("./context");
 const pinoLogging_1 = require("./pinoLogging");
-const wallet_1 = require("./wallet");
+const DEFAULT_KEYPAIR_PATH = '~/.config/solana/id.json';
 async function parsePubkey(pubkeyOrPath) {
@@ -89,3 +90,3 @@ try {
     const keypair = await parseKeypair(pathOrLedger);
-    return new wallet_1.KeypairWallet(keypair);
+    return new web3js_common_1.KeypairWallet(keypair);
 }
@@ -110,2 +111,36 @@ exports.parseWallet = parseWallet;
 exports.parseWalletOrPubkey = parseWalletOrPubkey;
+/**
+ * --keypair (considered as 'wallet') could be defined or undefined (and default is on parsing).
+ * For 'show*' command we don't need a working wallet, so we can use NullWallet.
+ * For '--print-only' we don't need a working wallet, so we can use NullWallet.
+ * For other commands we need a working wallet, when cannot be parsed then Error.
+ */
+async function parseWalletFromOpts(keypairArg, printOnly, commandArgs, logger, defaultKeypair = DEFAULT_KEYPAIR_PATH) {
+    const wallet = keypairArg;
+    let walletInterface;
+    try {
+        walletInterface = wallet
+            ? await parseWallet(wallet, logger)
+            : await parseWallet(defaultKeypair, logger);
+    }
+    catch (err) {
+        if (commandArgs.find(arg => arg.startsWith('show')) !== undefined ||
+            printOnly) {
+            // when working with show command it does not matter to use NullWallet
+            // for other instructions it could matter as the transaction fees cannot be paid by NullWallet
+            // still using NullWallet is ok when one generates only --print-only
+            logger.debug(`Cannot load --keypair wallet '${wallet || defaultKeypair}' but it's show or --print-only command, using NullWallet`);
+            walletInterface = new web3js_common_1.NullWallet();
+        }
+        else {
+            const definedMsg = wallet !== undefined
+                ? `--keypair wallet '${wallet}'`
+                : `default keypair path ${defaultKeypair}`;
+            logger.error(`Failed to use ${definedMsg}, exiting.`);
+            throw err;
+        }
+    }
+    return walletInterface;
+}
+exports.parseWalletFromOpts = parseWalletFromOpts;
 function parseClusterUrl(url) {
@@ -163,2 +198,16 @@ const localhost = 'http://127.0.0.1:8899';
 exports.parseCommitment = parseCommitment;
+function parseConfirmationFinality(confirmationFinality) {
+    if (confirmationFinality === 'confirmed') {
+        return 'confirmed';
+    }
+    else if (confirmationFinality === 'finalized') {
+        return 'finalized';
+    }
+    else {
+        throw new Error('Invalid value of --confirmation-finality: ' +
+            confirmationFinality +
+            '. Permitted values: confirmed and finalized');
+    }
+}
+exports.parseConfirmationFinality = parseConfirmationFinality;
 //# sourceMappingURL=parsers.js.map

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

35994

increased by1.59%

Number of medium quality alerts

1

decreased by-50%

Number of lines in readme file

6

increased byInfinity%

Worsened metrics

Number of package files

20

decreased by-9.09%

Lines of code

598

decreased by-3.08%

No dependency changes