Add SigningCosmosClient.sign

CHANGELOG.md

@@ -20,6 +20,8 @@
 - @cosmjs/launchpad: `Secp256k1HdWallet.sign` method renamed `signAmino`.
 - @cosmjs/launchpad: Add `CosmosClient.getTx` method for searching by ID and
   remove such functionality from `CosmosClient.searchTx`.
+- @cosmjs/launchpad: Add `SigningCosmosClient.sign` method for signing without
+  broadcasting.
 - @cosmjs/launchpad-ledger: `LedgerSigner.sign` method renamed `signAmino`.
 - @cosmjs/proto-signing: Add new package for handling transaction signing with
   protobuf encoding.

packages/launchpad/src/signingcosmosclient.spec.ts

@@ -4,10 +4,10 @@ import { assert } from "@cosmjs/utils";
 import { Coin, coin, coins } from "./coins";
 import { assertIsBroadcastTxSuccess, PrivateCosmosClient } from "./cosmosclient";
 import { GasPrice } from "./gas";
-import { MsgDelegate } from "./msgs";
+import { MsgDelegate, MsgSend } from "./msgs";
 import { Secp256k1HdWallet } from "./secp256k1hdwallet";
 import { PrivateSigningCosmosClient, SigningCosmosClient } from "./signingcosmosclient";
-import { launchpad, makeRandomAddress, pendingWithoutLaunchpad } from "./testutils.spec";
+import { base64Matcher, launchpad, makeRandomAddress, pendingWithoutLaunchpad } from "./testutils.spec";
 
 const httpUrl = "http://localhost:1317";
 
@@ -172,4 +172,51 @@ describe("SigningCosmosClient", () => {
       assertIsBroadcastTxSuccess(result);
     });
   });
+
+  describe("sign", () => {
+    it("works", async () => {
+      pendingWithoutLaunchpad();
+      const wallet = await Secp256k1HdWallet.fromMnemonic(faucet.mnemonic);
+      const client = new SigningCosmosClient(httpUrl, faucet.address, wallet);
+
+      const msg1: MsgDelegate = {
+        type: "cosmos-sdk/MsgDelegate",
+        value: {
+          delegator_address: faucet.address,
+          validator_address: launchpad.validator.address,
+          amount: coin(1234, "ustake"),
+        },
+      };
+      const msg2: MsgSend = {
+        type: "cosmos-sdk/MsgSend",
+        value: {
+          from_address: faucet.address,
+          to_address: makeRandomAddress(),
+          amount: coins(1234567, "ucosm"),
+        },
+      };
+      const fee = {
+        amount: coins(2000, "ucosm"),
+        gas: "180000", // 180k
+      };
+      const memo = "Use your power wisely";
+
+      const signed = await client.sign([msg1, msg2], fee, memo);
+      expect(signed.msg).toEqual([msg1, msg2]);
+      expect(signed.fee).toEqual(fee);
+      expect(signed.memo).toEqual(memo);
+      expect(signed.signatures).toEqual([
+        {
+          pub_key: {
+            type: "tendermint/PubKeySecp256k1",
+            value: jasmine.stringMatching(base64Matcher),
+          },
+          signature: jasmine.stringMatching(base64Matcher),
+        },
+      ]);
+
+      const broadcastResult = await client.broadcastTx(signed);
+      assertIsBroadcastTxSuccess(broadcastResult);
+    });
+  });
 });

packages/launchpad/src/signingcosmosclient.ts

@@ -6,7 +6,7 @@ import { buildFeeTable, FeeTable, GasLimits, GasPrice } from "./gas";
 import { BroadcastMode } from "./lcdapi";
 import { Msg, MsgSend } from "./msgs";
 import { OfflineSigner } from "./signer";
-import { makeStdTx } from "./tx";
+import { makeStdTx, StdTx } from "./tx";
 import { StdFee } from "./types";
 
 /**
@@ -87,11 +87,19 @@ export class SigningCosmosClient extends CosmosClient {
    * creates a single signature, assembles the signed transaction and broadcasts it.
    */
   public async signAndBroadcast(msgs: readonly Msg[], fee: StdFee, memo = ""): Promise<BroadcastTxResult> {
+    const signedTx = await this.sign(msgs, fee, memo);
+    return this.broadcastTx(signedTx);
+  }
+
+  /**
+   * Gets account number and sequence from the API, creates a sign doc,
+   * creates a single signature and assembles the signed transaction.
+   */
+  public async sign(msgs: readonly Msg[], fee: StdFee, memo = ""): Promise<StdTx> {
     const { accountNumber, sequence } = await this.getSequence();
     const chainId = await this.getChainId();
     const signDoc = makeSignDoc(msgs, fee, chainId, memo, accountNumber, sequence);
     const { signed, signature } = await this.signer.signAmino(this.senderAddress, signDoc);
-    const signedTx = makeStdTx(signed, signature);
-    return this.broadcastTx(signedTx);
+    return makeStdTx(signed, signature);
   }
 }

packages/launchpad/types/signingcosmosclient.d.ts

@@ -4,6 +4,7 @@ import { FeeTable, GasLimits, GasPrice } from "./gas";
 import { BroadcastMode } from "./lcdapi";
 import { Msg } from "./msgs";
 import { OfflineSigner } from "./signer";
+import { StdTx } from "./tx";
 import { StdFee } from "./types";
 /**
  * These fees are used by the higher level methods of SigningCosmosClient
@@ -52,4 +53,9 @@ export declare class SigningCosmosClient extends CosmosClient {
    * creates a single signature, assembles the signed transaction and broadcasts it.
    */
   signAndBroadcast(msgs: readonly Msg[], fee: StdFee, memo?: string): Promise<BroadcastTxResult>;
+  /**
+   * Gets account number and sequence from the API, creates a sign doc,
+   * creates a single signature and assembles the signed transaction.
+   */
+  sign(msgs: readonly Msg[], fee: StdFee, memo?: string): Promise<StdTx>;
 }