optimised cosmjs migration doc

Author: sdqede

docs/migration-from-cosmjs.md

@@ -1,14 +1,14 @@
 # Migrating from CosmJS to @interchainjs/cosmos
 
-This guide shows you how to migrate from CosmJS to the new InterchainJS SDK. The updated examples below follow the patterns used in our unit tests, with a special focus on wallet generation that completely removes any CosmJS dependency.
+This guide shows you how to migrate from CosmJS to the new InterchainJS SDK. The updated examples below follow the patterns used in our unit tests, with a special focus on wallet generation and signers that completely removes any CosmJS dependency.
 
 ## 1. Overview
 
 ### Goal:
 Replace CosmJS with @interchainjs/cosmos to sign, build, and broadcast transactions on Cosmos-based blockchains.
 
 ### Key Improvements:
-- Wallet Generation: Create wallets using our own methods (using Secp256k1Auth and generateMnemonic) instead of CosmJS’s DirectSecp256k1HdWallet.
+- Wallet Generation: Create wallets using our own methods (using Secp256k1Auth and Bip39) instead of CosmJS’s DirectSecp256k1HdWallet.
 - Modular Imports: Import only the needed submodules to reduce bundle size.
 - Unified Signer Interfaces: Use Direct (Protobuf) or Amino signing with a consistent API.
 
@@ -23,7 +23,6 @@ npm install @interchainjs/cosmos @interchainjs/auth @interchainjs/cosmos-types
 ## 3. Updated Wallet Generation
 
 In the new SDK, you can generate a wallet using our own methods rather than relying on CosmJS. For example, the unit tests use:
-- generateMnemonic – to create a mnemonic phrase.
 - Secp256k1Auth.fromMnemonic – to derive authentication objects from the mnemonic.
 - HDPath – to derive the correct HD paths for Cosmos.
 
@@ -32,23 +31,24 @@ Below is a sample code snippet illustrating the updated wallet generation:
 // Import wallet and HD path utilities from the SDK packages
 import { Secp256k1Auth } from '@interchainjs/auth/secp256k1';
 import { HDPath } from '@interchainjs/types';
-// Assume generateMnemonic is exported from the SDK (or from a dedicated utility module)
-import { generateMnemonic } from '@interchainjs/cosmos/utils';
 // Import the DirectSigner from our SDK
 import { DirectSigner } from '@interchainjs/cosmos/signers/direct';
+import { Bip39, Random } from '@interchainjs/crypto';
+import { toEncoders } from '@interchainjs/cosmos/utils';
+import { MsgSend } from 'interchainjs/cosmos/bank/v1beta1/tx';
 
 (async () => {
   // Generate a mnemonic using the SDK utility
-  const mnemonic = generateMnemonic();
+  const mnemonic = Bip39.encode(Random.getBytes(16)).toString();
 
   // Derive authentication objects (wallet accounts) using the SDK's Secp256k1Auth
   // Here we derive the first account using the standard Cosmos HD path.
   const [auth] = Secp256k1Auth.fromMnemonic(mnemonic, [
     HDPath.cosmos(0, 0, 0).toString(),
   ]);
 
-  // Prepare any encoders required for your message types; can be an empty array if not needed.
-  const encoders = [];
+  // Prepare any encoders required for your message types
+  const encoders:Encoder[] = toEncoders(MsgSend);
 
   // Define your RPC endpoint (ensure it points to a working Cosmos RPC node)
   const rpcEndpoint = 'http://your-rpc-endpoint:26657';
@@ -68,8 +68,8 @@ import { DirectSigner } from '@interchainjs/cosmos/signers/direct';
   const msg = {
     // Example message object; adjust fields according to your chain and message type
     // For instance, if using bank.MsgSend, you would populate:
-    // typeUrl: '/cosmos.bank.v1beta1.MsgSend',
-    // value: { fromAddress: address, toAddress: 'destination-address', amount: [{ denom: 'uatom', amount: '1000' }] }
+    typeUrl: '/cosmos.bank.v1beta1.MsgSend',
+    value: { fromAddress: address, toAddress: address, amount: [{ denom: 'uatom', amount: '1' }] }
   };
 
   // Sign and broadcast the transaction.
@@ -79,7 +79,7 @@ import { DirectSigner } from '@interchainjs/cosmos/signers/direct';
 })();
 ```
 Key Points:
-- No CosmJS Dependency: The wallet is generated entirely using generateMnemonic and Secp256k1Auth.fromMnemonic.
+- No CosmJS Dependency: The wallet is generated entirely using Bip39 and Secp256k1Auth.fromMnemonic.
 - HDPath Usage: The HD path is derived using HDPath.cosmos(0, 0, 0).toString(), which follows the Cosmos standard.
 - DirectSigner: Instantiated with the auth object and a set of encoders (which you can populate based on your message types).
 
@@ -124,20 +124,23 @@ If you need Amino signing for legacy compatibility, the process is analogous:
 
 ``` typescript
 import { AminoSigner } from '@interchainjs/cosmos/signers/amino';
+import { toEncoders, toConverters } from '@interchainjs/cosmos/utils';
+import { MsgSend } from 'interchainjs/cosmos/bank/v1beta1/tx';
 
 (async () => {
-  // Generate wallet using the same approach as above
-  const mnemonic = generateMnemonic();
   const [auth] = Secp256k1Auth.fromMnemonic(mnemonic, [
     HDPath.cosmos(0, 0, 0).toString(),
   ]);
-  const encoders = [];
   const rpcEndpoint = 'http://your-rpc-endpoint:26657';
 
   // Create an AminoSigner instance
-  const aminoSigner = new AminoSigner(auth, encoders, rpcEndpoint, {
-    prefix: 'cosmos',
-  });
+  const aminoSigner = new AminoSigner(
+    auth,
+    toEncoders(MsgSend),
+    toConverters(MsgSend),
+    rpcEndpoint,
+    { prefix: 'cosmos' }
+  );
 
   // Build your message and set fee/memo if needed
   const msg = {
@@ -154,9 +157,8 @@ import { AminoSigner } from '@interchainjs/cosmos/signers/amino';
     gas: '200000',
   };
 
-  const result = await aminoSigner.signAndBroadcast([msg], {
-    fee,
-    memo: 'Amino transaction test',
+  const result = await aminoSigner.signAndBroadcast({
+    messages: [msg], fee
   });
   console.log('Transaction hash:', result.hash);
 })();
@@ -183,10 +185,10 @@ import { makeCosmoshubPath } from "@cosmjs/crypto";
 ``` typescript
 import { Secp256k1Auth } from '@interchainjs/auth/secp256k1';
 import { HDPath } from '@interchainjs/types';
-import { generateMnemonic } from '@interchainjs/cosmos/utils';
+import { Bip39, Random } from '@interchainjs/crypto';
 
 (async () => {
-  const mnemonic = generateMnemonic();
+  const mnemonic = Bip39.encode(Random.getBytes(16)).toString();
   const [auth] = Secp256k1Auth.fromMnemonic(mnemonic, [
     HDPath.cosmos(0, 0, 0).toString(),
   ]);
@@ -238,7 +240,9 @@ import { DirectSigner } from '@interchainjs/cosmos/signers/direct';
   };
   const memo = "InterchainJS transaction test";
 
-  const result = await signer.signAndBroadcast([msg], { fee, memo });
+  const result = await signer.signAndBroadcast({
+    messages: [msg], fee, memo
+  });
   console.log("Transaction hash:", result.hash);
 })();
 ```
@@ -252,13 +256,13 @@ import { DirectSigner } from '@interchainjs/cosmos/signers/direct';
   - Replace any CosmJS imports with the new SDK sub-module imports.
   - For wallet generation, use:
 ``` typescript
-import { generateMnemonic } from '@interchainjs/cosmos/utils';
+import { Bip39, Random } from '@interchainjs/crypto';
 import { Secp256k1Auth } from '@interchainjs/auth/secp256k1';
 import { HDPath } from '@interchainjs/types';
 ```
 
 3. Wallet Generation:
-  - Generate a mnemonic using generateMnemonic().
+  - Generate a mnemonic using Bip39 and Random
   - Derive auth objects using Secp256k1Auth.fromMnemonic().
   - Note: This method completely avoids any dependency on CosmJS wallet implementations.
 4. Adapt Signer Interfaces:
@@ -273,7 +277,7 @@ import { HDPath } from '@interchainjs/types';
 
 ## 6. Conclusion
 
-This updated migration guide demonstrates how to generate wallets and sign transactions using the new InterchainJS SDK without any dependency on CosmJS. By leveraging built-in utilities such as generateMnemonic, Secp256k1Auth.fromMnemonic, and HDPath, your application can fully transition to a modern, modular, and lightweight approach to interacting with Cosmos blockchains.
+This updated migration guide demonstrates how to generate wallets and sign transactions using the new InterchainJS SDK without any dependency on CosmJS. By leveraging built-in utilities such as Secp256k1Auth.fromMnemonic, and HDPath, your application can fully transition to a modern, modular, and lightweight approach to interacting with Cosmos blockchains.
 
 For further details, refer to the GitHub repository README and unit tests (e.g., [token.test.ts](../networks/cosmos/starship/__tests__/token.test.ts)).