Implement testnet and update documentation plus unittests

Author: Fabrice Bascoulergue

README.md

@@ -65,7 +65,7 @@ The SDK is based on the [CosmJS](https://github.com/cosmos/cosmjs) implementatio
 
 It is intented to be used standalone, without having to import specific CosmJS packages which can get make implementations tricky and messy.
 
-Therefore all codecs, types, functions are features from the CosmJS SDK are either re-implemented by this SDK or re-exporter for simplicity purposes.
+Therefore all codecs, types, functions are features from the CosmJS SDK are either re-implemented by this SDK or re-exported for simplicity purposes.
 
 Directly importing the CosmJS SDK or other cryptographic library should be considered bad practice for most use cases.
 

docs/README.md

@@ -60,7 +60,8 @@ console.log(`Wallet address: ${wallet.address}`);
 ### Connect to the testnet
 
 ```typescript
-const testnetClient = await LumClient.connect('http://localhost:26657');
+// Use http://node0.lum.network/rpc to connect to the mainnet
+const testnetClient = await LumClient.connect('http://node0.testnet.lum.network/rpc');
 ```
 
 ### Account information & balance
@@ -93,7 +94,7 @@ if (balances.length === 0) {
 
 #### Get account transactions (sent and received)
 ```typescript
-// The client search feature supports multiple searches and merge+store the results
+// The client search feature supports multiple searches and merge+sort the results
 const transactions = await testnetClient.searchTx([
     LumUtils.searchTxFrom(wallet.address),
     LumUtils.searchTxTo(wallet.address),
@@ -119,3 +120,25 @@ const broadcastResult = await clt.signAndBroadcastTx(w1, [sendMsg], fee, 'hello
 // Verify the transaction was succesfully broadcasted and made it into a block
 console.log(`Broadcast success: ${LumUtils.broadcastTxCommitSuccess(broadcastResult)}`);
 ```
+
+### Use all tendermint RPCs
+
+The underlying tendermint client is directly accessible via the `.tmClient` property of the LumClient.
+
+```typescript
+    const health = await testnetClient.tmClient.health();
+    const status = await testnetClient.tmClient.status();
+    const genesis = await testnetClient.tmClient.genesis();
+    const latestBlock = await testnetClient.tmClient.block();
+```
+
+### Use all modules RPCs
+
+The underlying query client is directly accessible via the `.queryClient` property of the LumClient.
+
+It allows to directly query all modules endpoints such as:
+
+```typescript
+    const supplies = await clt.queryClient.bank.unverified.totalSupply();
+    // [{ denom: 'lum', amount: '1000000' }]
+```

tests/client.test.ts

@@ -1,38 +1,93 @@
-import { LumWallet, LumConstants } from '../src';
+import { LumWallet, LumClient, LumUtils, LumConstants, LumRegistry, LumTypes } from '../src';
+
+const genesisAccountAddress = 'lum100hm4tt3z3mj4gc453quvu452dcp2ehqavrtlp';
+const genesisValidatorAddress = '23D45E13FF3418D23DF989D78EBE6DE76F3A89EC';
 
 describe('LumClient', () => {
-    it('Should connect', async () => {
-        const w1 = await LumWallet.fromMnemonic('noodle hope lounge dismiss erase elephant seek crawl check equal city chest', LumConstants.getLumHdPath(0), 'cosmos');
-        const w2 = await LumWallet.fromMnemonic('sick hollow lizard train motion eternal mixture rude section tray nice awful', LumConstants.getLumHdPath(0), 'cosmos');
+    let clt: LumClient;
+    let w1: LumWallet;
+    let w2: LumWallet;
+
+    beforeAll(async () => {
+        clt = await LumClient.connect('http://node0.testnet.lum.network/rpc');
+        w1 = await LumWallet.fromMnemonic('noodle hope lounge dismiss erase elephant seek crawl check equal city chest');
+        w2 = await LumWallet.fromMnemonic('sick hollow lizard train motion eternal mixture rude section tray nice awful');
         expect(w1.address).not.toEqual(w2.address);
+    });
+
+    afterAll(async () => {
+        await expect(clt.disconnect()).resolves.toBeTruthy();
+    });
+
+    it('Should expose basic information', async () => {
+        expect(clt.getChainId()).resolves.toEqual('lumnetwork'); // TODO: will be update to lumnetwork-testnet
+        expect(clt.getBlockHeight()).resolves.toBeGreaterThan(0);
+        expect(clt.getBlock()).resolves.toBeTruthy();
+    });
+
+    it('should expose tendermint rpcs', async () => {
+        expect(clt.tmClient.health()).resolves.toBeNull();
+        expect(clt.tmClient.status()).resolves.toBeTruthy();
+        expect(clt.tmClient.genesis()).resolves.toBeTruthy();
+        expect(clt.tmClient.abciInfo()).resolves.toBeTruthy();
+        expect(clt.tmClient.block()).resolves.toBeTruthy();
+        expect(clt.tmClient.blockResults()).resolves.toBeTruthy();
+        expect(clt.tmClient.blockchain()).resolves.toBeTruthy();
+        expect(clt.tmClient.validatorsAll()).resolves.toBeTruthy();
+    });
+
+    it('Should expose bank module', async () => {
+        const supplies = await clt.queryClient.bank.unverified.totalSupply();
+        expect(supplies).toBeTruthy();
+        expect(supplies.length).toBeGreaterThan(0);
+        const lumSupply = supplies.filter((c) => c.denom === LumConstants.LumDenom)[0];
+        expect(lumSupply).toBeTruthy();
+        expect(parseFloat(lumSupply.amount)).toBeGreaterThan(0);
+    });
+
+    it('Should expose staking module', async () => {
+        const validators = await clt.tmClient.validatorsAll();
+        expect(validators.validators.length).toBeGreaterThanOrEqual(1);
+        const block = await clt.getBlock();
+        let found = false;
+        for (let v = 0; v < validators.validators.length; v++) {
+            const val = validators.validators[v];
+            if (LumUtils.toHex(val.address) === LumUtils.toHex(block.block.header.proposerAddress)) {
+                found = true;
+                break;
+            }
+        }
+        expect(found).toBeTruthy();
+
+        // Get boot val (genesis) with address genesisValidatorAddress
+        const bootVal = validators.validators.filter((v) => LumUtils.toHex(v.address).toUpperCase() === genesisValidatorAddress)[0];
+        expect(bootVal).toBeTruthy();
+
+        // Get staking validator by matching it using pubkeys
+        const stakers = await clt.queryClient.staking.unverified.validators('BOND_STATUS_BONDED');
+        const bootStak = stakers.validators.filter((s) => LumUtils.toHex((LumRegistry.decode(s.consensusPubkey) as LumTypes.PubKey).key) === LumUtils.toHex(bootVal.pubkey.data))[0];
+        expect(bootVal).toBeTruthy();
+
+        // Get account information by deriving the address from the operator address
+        const delegAddress = LumUtils.Bech32.encode(LumConstants.LumBech32PrefixAccAddr, LumUtils.Bech32.decode(bootStak.operatorAddress).data);
+        const account = await clt.getAccount(delegAddress);
+        expect(account).toBeTruthy();
+
+        // Get account balances
+        const balances = await clt.getAllBalancesUnverified(account.address);
+        expect(balances).toBeTruthy();
+        expect(balances.length).toBeGreaterThan(0);
+        const lumBalance = balances.filter((b) => b.denom === LumConstants.LumDenom)[0];
+        expect(lumBalance).toBeTruthy();
+        expect(parseFloat(lumBalance.amount)).toBeGreaterThan(0);
+    });
 
-        // Can connect to Cosmos testnet for compatibility checks:
-        // https://stargate.cosmos.network/testnet
-        // const clt = await LumClient.connect('http://localhost:26657');
-        // console.log('wallet address', w1.address);
-        // console.log('getChainId', await clt.getChainId());
-        // console.log('getBlockHeight', await clt.getBlockHeight());
-        // console.log('getBlock', await clt.getBlock());
-        // console.log('getAccount', await clt.getAccount(w1.address));
-        // console.log('getAccountUnverified', await clt.getAccountUnverified(w1.address));
-        // console.log('getBalance', await clt.getBalance(w1.address, 'token'));
-        // console.log('getBalancesUnverified', await clt.getBalancesUnverified(w1.address));
-        // const txs = await clt.searchTx([LumUtils.searchTxFrom(w1.address), LumUtils.searchTxTo(w1.address)]);
-        // console.log('getTx', await clt.getTx(txs[0].hash));
-        // console.log('searchTxs', txs);
-        // const sendMsg = LumMessages.BuildMsgSend(w1.address, w2.address, [{ denom: 'token', amount: '2' }]);
-        // const res = await clt.signAndBroadcastTx(w1, [sendMsg], {
-        //     amount: [
-        //         {
-        //             denom: 'token',
-        //             amount: '1',
-        //         },
-        //     ],
-        //     gas: '180000', // 180k
-        // });
-        // console.log('signAndBroadcastTx', LumUtils.broadcastTxCommitSuccess(res), res);
-        // console.log('getBalance(w1)', await clt.getBalance(w1.address, 'token'));
-        // console.log('getBalance(w2)', await clt.getBalance(w2.address, 'token'));
-        // WIP - needs to be automated through CICD
+    it('Should expose distribution module', async () => {
+        const deleg = await clt.queryClient.distribution.unverified.delegatorWithdrawAddress(genesisAccountAddress);
+        expect(deleg).toBeTruthy();
+        expect(deleg.withdrawAddress).toEqual(genesisAccountAddress);
+        const validators = await clt.queryClient.distribution.unverified.delegatorValidators(genesisAccountAddress);
+        expect(validators).toBeTruthy();
+        expect(validators.validators.length).toBeGreaterThan(0);
     });
 });