Problem: Support amount list on MsgSend & remove some Todos

lib/e2e/transaction.spec.ts

@@ -59,6 +59,73 @@ const env = {
 };
 
 describe('e2e test suite', function () {
+    describe('`v2` message types', function () {
+        it('[BANK] creates a MsgSend Type Transaction and Broadcasts it.', async function () {
+            const hdKey = HDKey.fromMnemonic(env.mnemonic.communityAccount);
+            const hdKey2 = HDKey.fromMnemonic(env.mnemonic.reserveAccount);
+            const hdKey3 = HDKey.fromMnemonic(env.mnemonic.randomEmptyAccount);
+            const privKey = hdKey.derivePrivKey(`m/44'/${customNetwork.bip44Path.coinType}'/0'/0/0`);
+            const privKey2 = hdKey2.derivePrivKey(`m/44'/${customNetwork.bip44Path.coinType}'/0'/0/0`);
+            const randomPrivKey = hdKey3.derivePrivKey(`m/44'/${customNetwork.bip44Path.coinType}'/0'/0/0`);
+            const keyPair = Secp256k1KeyPair.fromPrivKey(privKey);
+            const keyPair2 = Secp256k1KeyPair.fromPrivKey(privKey2);
+            const randomKeyPair = Secp256k1KeyPair.fromPrivKey(randomPrivKey);
+
+            const cro = CroSDK({ network: customNetwork });
+            const rawTx = new cro.RawTransaction();
+            const address1 = new cro.Address(keyPair.getPubKey());
+            const address2 = new cro.Address(keyPair2.getPubKey());
+            const randomAddress = new cro.Address(randomKeyPair.getPubKey());
+            const client = await cro.CroClient.connect();
+
+            const msgSend1 = new cro.v2.bank.MsgSend({
+                fromAddress: address1.account(),
+                toAddress: randomAddress.account(),
+                amount: [new cro.Coin('100000', Units.BASE)],
+            });
+
+            const msgSend2 = new cro.v2.bank.MsgSend({
+                fromAddress: address2.account(),
+                toAddress: address1.account(),
+                amount: [new cro.Coin('20000', Units.BASE)],
+            });
+
+            const account1 = await client.getAccount(address1.account());
+            const account2 = await client.getAccount(address2.account());
+
+            expect(account1).to.be.not.null;
+            expect(account2).to.be.not.null;
+
+            const signableTx = rawTx
+                .appendMessage(msgSend1)
+                .appendMessage(msgSend2)
+                .addSigner({
+                    publicKey: keyPair.getPubKey(),
+                    accountNumber: new Big(account1!.accountNumber),
+                    accountSequence: new Big(account1!.sequence),
+                })
+                .addSigner({
+                    publicKey: keyPair2.getPubKey(),
+                    accountNumber: new Big(account2!.accountNumber),
+                    accountSequence: new Big(account2!.sequence),
+                })
+                .toSignable();
+
+            const signedTx = signableTx
+                .setSignature(0, keyPair.sign(signableTx.toSignDocumentHash(0)))
+                .setSignature(1, keyPair2.sign(signableTx.toSignDocumentHash(1)))
+                .toSigned();
+
+            expect(msgSend1.fromAddress).to.eq(account1!.address);
+            expect(msgSend1.toAddress).to.eq(randomAddress.account());
+            const broadcastResult = await client.broadcastTx(signedTx.encode().toUint8Array());
+            assertIsBroadcastTxSuccess(broadcastResult);
+
+            const { transactionHash } = broadcastResult;
+            expect(transactionHash).to.match(/^[0-9A-F]{64}$/);
+        });
+    })
+
     it('[BANK] creates a MsgSend type Transaction Signed by Legacy Amino JSON mode and Broadcasts it', async function () {
         const hdKey = HDKey.fromMnemonic(env.mnemonic.communityAccount);
         const hdKey2 = HDKey.fromMnemonic(env.mnemonic.reserveAccount);

lib/src/core/cro.ts

@@ -29,6 +29,7 @@ import { msgMintNFT } from '../transaction/msg/nft/MsgMintNFT';
 import { msgEditNFT } from '../transaction/msg/nft/MsgEditNFT';
 import { msgTransferNFT } from '../transaction/msg/nft/MsgTransferNFT';
 import { msgBurnNFT } from '../transaction/msg/nft/MsgBurnNFT';
+import { msgSendV2 } from '../transaction/msg/v2/bank/v2.msgsend';
 
 export const CroSDK = function (configs: InitConfigurations) {
     ow(configs, 'configs', owCroSDKInitParams);
@@ -48,7 +49,6 @@ export const CroSDK = function (configs: InitConfigurations) {
                 CancelSoftwareUpgradeProposal: cancelSoftwareUpgradeProposal(),
                 SoftwareUpgradeProposal: softwareUpgradeProposal(),
                 TextProposal: textProposal(),
-                // TODO : More type of proposals to be added here
             },
         },
         bank: {
@@ -74,6 +74,11 @@ export const CroSDK = function (configs: InitConfigurations) {
             MsgTransferNFT: msgTransferNFT(configs),
             MsgBurnNFT: msgBurnNFT(configs),
         },
+        v2: {
+            bank: {
+                MsgSend: msgSendV2(configs),
+            },
+        },
         Options: configs,
     };
 };

lib/src/transaction/msg/bank/msgsend.spec.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 import 'mocha';
 import { expect } from 'chai';
 import Big from 'big.js';

lib/src/transaction/msg/ow.types.ts

@@ -16,6 +16,13 @@ export const owMsgSendOptions = owStrictObject().exactShape({
     toAddress: ow.string,
     amount: owCoin(),
 });
+export const v2 = {
+    owMsgSendOptions: owStrictObject().exactShape({
+        fromAddress: ow.string,
+        toAddress: ow.string,
+        amount: ow.array.ofType(owCoin()),
+    }),
+};
 
 const proposalContentValidatorFn = (val: object) => ({
     validator: isMsgProposalContent(val),

lib/src/transaction/msg/v2/bank/v2.msgsend.spec.ts

@@ -0,0 +1,189 @@
+import 'mocha';
+import { expect } from 'chai';
+import Big from 'big.js';
+
+import { fuzzyDescribe } from '../../../../test/mocha-fuzzy/suite';
+import { Msg } from '../../../../cosmos/v1beta1/types/msg';
+import { Secp256k1KeyPair } from '../../../../keypair/secp256k1';
+import { Bytes } from '../../../../utils/bytes/bytes';
+import { Units } from '../../../../coin/coin';
+import { CroSDK, CroNetwork } from '../../../../core/cro';
+
+const cro = CroSDK({
+    network: {
+        defaultNodeUrl: '',
+        chainId: 'testnet-croeseid-1',
+        addressPrefix: 'tcro',
+        validatorAddressPrefix: 'tcrocncl',
+        validatorPubKeyPrefix: 'tcrocnclconspub',
+        coin: {
+            baseDenom: 'basetcro',
+            croDenom: 'tcro',
+        },
+        bip44Path: {
+            coinType: 1,
+            account: 0,
+        },
+        rpcUrl: '',
+    },
+});
+
+describe('Testing MsgSend', function () {
+    describe('fromCosmosJSON', function () {
+        it('should throw Error if the JSON is not a MsgSend', function () {
+            const json =
+                '{ "@type": "/cosmos.bank.v1beta1.MsgCreateValidator", "amount": [{ "denom": "basetcro", "amount": "3478499933290496" }], "from_address": "tcro1x07kkkepfj2hl8etlcuqhej7jj6myqrp48y4hg", "to_address": "tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3" }';
+            expect(() => cro.v2.bank.MsgSend.fromCosmosMsgJSON(json, CroNetwork.Testnet)).to.throw(
+                'Expected /cosmos.bank.v1beta1.MsgSend but got /cosmos.bank.v1beta1.MsgCreateValidator',
+            );
+        });
+        it('should throw Error when the from field is missing', function () {
+            const json =
+                '{ "@type": "/cosmos.bank.v1beta1.MsgSend", "amount": [{ "denom": "basetcro", "amount": "3478499933290496" }], "to_address": "tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3" }';
+            expect(() => cro.v2.bank.MsgSend.fromCosmosMsgJSON(json, CroNetwork.Testnet)).to.throw(
+                'Expected property `fromAddress` to be of type `string` but received type `undefined` in object `options`',
+            );
+        });
+        it('should throw Error when the to field is missing', function () {
+            const json =
+                '{ "@type": "/cosmos.bank.v1beta1.MsgSend", "amount": [{ "denom": "basetcro", "amount": "3478499933290496" }], "from_address": "tcro1x07kkkepfj2hl8etlcuqhej7jj6myqrp48y4hg" }';
+            expect(() => cro.v2.bank.MsgSend.fromCosmosMsgJSON(json, CroNetwork.Testnet)).to.throw(
+                'Expected property `toAddress` to be of type `string` but received type `undefined` in object `options`',
+            );
+        });
+        it('should throw Error when the amount field is missing', function () {
+            const json =
+                '{ "@type": "/cosmos.bank.v1beta1.MsgSend", "from_address": "tcro1x07kkkepfj2hl8etlcuqhej7jj6myqrp48y4hg" , "to_address": "tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3" }';
+            expect(() => cro.v2.bank.MsgSend.fromCosmosMsgJSON(json, CroNetwork.Testnet)).to.throw(
+                'Invalid amount in the Msg.',
+            );
+        });
+        it('should throw on invalid `fromAddress`', function () {
+            const json =
+                '{ "@type": "/cosmos.bank.v1beta1.MsgSend", "amount": [{ "denom": "basetcro", "amount": "3478499933290496" }], "from_address": "cro1pndm4ywdf4qtmupa0fqe75krmqed2znjyj6x8f", "to_address": "tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3" }';
+
+            expect(() => cro.v2.bank.MsgSend.fromCosmosMsgJSON(json, CroNetwork.Testnet)).to.throw(
+                'Provided `fromAddress` does not match network selected',
+            );
+        });
+        it('should throw on invalid `toAddress`', function () {
+            const json =
+                '{ "@type": "/cosmos.bank.v1beta1.MsgSend", "amount": [{ "denom": "basetcro", "amount": "3478499933290496" }], "from_address": "tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3", "to_address": "cro1pndm4ywdf4qtmupa0fqe75krmqed2znjyj6x8f" }';
+
+            expect(() => cro.v2.bank.MsgSend.fromCosmosMsgJSON(json, CroNetwork.Testnet)).to.throw(
+                'Provided `toAddress` does not match network selected',
+            );
+        });
+        it('should return the MsgSend corresponding to the JSON', function () {
+            const json =
+                '{ "@type": "/cosmos.bank.v1beta1.MsgSend", "amount": [{ "denom": "basetcro", "amount": "3478499933290496" }], "from_address": "tcro1x07kkkepfj2hl8etlcuqhej7jj6myqrp48y4hg", "to_address": "tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3" }';
+            const msgSend = cro.v2.bank.MsgSend.fromCosmosMsgJSON(json, CroNetwork.Testnet);
+            expect(msgSend.fromAddress).to.eql('tcro1x07kkkepfj2hl8etlcuqhej7jj6myqrp48y4hg');
+            expect(msgSend.toAddress).to.eql('tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3');
+            expect(msgSend.amount[0].toCosmosCoin().amount).to.eql('3478499933290496');
+            expect(msgSend.amount[0].toCosmosCoin().denom).to.eql('basetcro');
+        });
+    });
+
+    fuzzyDescribe('should throw Error when options is invalid', function (fuzzy) {
+        const anyValidOptions = {
+            fromAddress: 'tcro165tzcrh2yl83g8qeqxueg2g5gzgu57y3fe3kc3',
+            toAddress: 'tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3',
+            amount: new cro.Coin('1000', Units.BASE),
+        };
+        const testRunner = fuzzy(fuzzy.ObjArg(anyValidOptions));
+
+        testRunner(function (options) {
+            if (options.valid) {
+                return;
+            }
+            expect(() => new cro.v2.bank.MsgSend(options.value)).to.throw('Expected `options` to be of type `object`');
+        });
+    });
+
+    it('Test MsgSend conversion', function () {
+        const coin = new cro.Coin('12000500', Units.BASE);
+
+        const msgSend = new cro.v2.bank.MsgSend({
+            fromAddress: 'tcro165tzcrh2yl83g8qeqxueg2g5gzgu57y3fe3kc3',
+            toAddress: 'tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3',
+            amount: [coin],
+        });
+
+        const rawMsg: Msg = {
+            typeUrl: '/cosmos.bank.v1beta1.MsgSend',
+            value: {
+                fromAddress: 'tcro165tzcrh2yl83g8qeqxueg2g5gzgu57y3fe3kc3',
+                toAddress: 'tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3',
+                amount: [
+                    {
+                        denom: 'basetcro',
+                        amount: '12000500',
+                    },
+                ],
+            },
+        };
+
+        expect(msgSend.toRawMsg()).to.eqls(rawMsg);
+    });
+
+    it('Test appendTxBody MsgSend Tx signing', function () {
+        const anyKeyPair = Secp256k1KeyPair.fromPrivKey(
+            Bytes.fromHexString('66633d18513bec30dd11a209f1ceb1787aa9e2069d5d47e590174dc9665102b3'),
+        );
+        const coin = new cro.Coin('12000500', Units.CRO);
+
+        const msgSend = new cro.v2.bank.MsgSend({
+            fromAddress: 'tcro165tzcrh2yl83g8qeqxueg2g5gzgu57y3fe3kc3',
+            toAddress: 'tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3',
+            amount: [coin],
+        });
+
+        const anySigner = {
+            publicKey: anyKeyPair.getPubKey(),
+            accountNumber: new Big(0),
+            accountSequence: new Big(2),
+        };
+
+        const rawTx = new cro.RawTransaction();
+
+        const signableTx = rawTx.appendMessage(msgSend).addSigner(anySigner).toSignable();
+
+        const signedTx = signableTx.setSignature(0, anyKeyPair.sign(signableTx.toSignDocumentHash(0))).toSigned();
+
+        const signedTxHex = signedTx.encode().toHexString();
+        expect(signedTxHex).to.be.eql(
+            '0a9b010a98010a1c2f636f736d6f732e62616e6b2e763162657461312e4d736753656e6412780a2b7463726f313635747a63726832796c3833673871657178756567326735677a6775353779336665336b6333122b7463726f3138346c7461326c7379753437767779703265387a6d746361336b3579713835703663347670331a1c0a08626173657463726f12103132303030353030303030303030303012580a500a460a1f2f636f736d6f732e63727970746f2e736563703235366b312e5075624b657912230a2103fd0d560b6c4aa1ca16721d039a192867c3457e19dad553edb98e7ba88b159c2712040a0208011802120410c09a0c1a40b28cefb83735e05253f641d0bca790a6f95481bc857a7d57a493125af1804ed440dffc080950d6ff39dee4ea113e5e686f8235e98d34870d9b64b4a9a057f686',
+        );
+    });
+
+    it('Should validate MsgSend provided addresses with network config', function () {
+        const coin = new cro.Coin('12000500', Units.BASE);
+
+        const params1 = {
+            fromAddress: 'cro1pndm4ywdf4qtmupa0fqe75krmqed2znjyj6x8f',
+            toAddress: 'tcro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3',
+            amount: [coin],
+        };
+
+        const params2 = {
+            fromAddress: 'tcro165tzcrh2yl83g8qeqxueg2g5gzgu57y3fe3kc3',
+            toAddress: 'cro1pndm4ywdf4qtmupa0fqe75krmqed2znjyj6x8f',
+            amount: [coin],
+        };
+
+        const params3 = {
+            fromAddress: 'tcro1pndm4ywdf4qtmupa0fqe75krmqed2znjyj6x8fzqa',
+            toAddress: 'cro184lta2lsyu47vwyp2e8zmtca3k5yq85p6c4vp3',
+            amount: [coin],
+        };
+
+        expect(() => new cro.v2.bank.MsgSend(params1)).to.throw(
+            'Provided `fromAddress` does not match network selected',
+        );
+        expect(() => new cro.v2.bank.MsgSend(params2)).to.throw('Provided `toAddress` does not match network selected');
+        expect(() => new cro.v2.bank.MsgSend(params3)).to.throw(
+            'Invalid checksum for tcro1pndm4ywdf4qtmupa0fqe75krmqed2znjyj6x8fzqa',
+        );
+    });
+});