added transfer & whoami cli methods

Author: erhant

README.md

@@ -44,6 +44,7 @@ Depending on your use-cases, we have several optional dependencies:
 - You can use [hollowdb-prover](https://www.npmjs.com/package/hollowdb-prover) as a simple utility that generates zero-knowledge proofs that are verifiable by HollowDB.
 - You can use LMDB cache within your Warp instance via [warp-contracts-lmdb](https://www.npmjs.com/package/warp-contracts-lmdb).
 - You can use Redis cache within your warp instance via [warp-contracts-redis](https://www.npmjs.com/package/warp-contracts-redis) together with [ioredis](https://www.npmjs.com/package/ioredis).
+- When you are evaluating a contract that uses ZK proofs, you should also use [warp-contracts-plugin-snarkjs](https://www.npmjs.com/package/warp-contracts-plugin-snarkjs) and [warp-contracts-plugin-ethers](https://www.npmjs.com/package/warp-contracts-plugin-ethers).
 
 ## Usage
 

src/bin/cli.ts

@@ -13,7 +13,7 @@ import {transfer} from './transfer';
 const BASE_CONTRACT_NAME = 'hollowdb';
 
 yargs(hideBin(process.argv))
-  .scriptName('yarn contract')
+  .scriptName('pnpm contract')
   // .example('$0 build -n my-contract', 'Build your contract')
   // .example('$0 deploy -n my-contract -w ./my/wallet.json', 'Deploy to mainnet')
   // .example('$0 evolve -n new-contract -c txId -w ./my/wallet.json', 'Evolve an existing contract with new source')
@@ -46,6 +46,26 @@ yargs(hideBin(process.argv))
   })
   .string(['wallet', 'name', 'init', 'target', 'sourceTxId', 'contractTxId'])
 
+  .command(
+    'whoami',
+    'Display information about your wallet',
+    yargs => yargs.demandOption(['wallet']),
+    async args => {
+      const warp = prepareWarp(args.target);
+      const wallet = prepareWallet(args.wallet);
+
+      const address = await warp.arweave.wallets.getAddress(wallet);
+      const balance = await warp.arweave.wallets.getBalance(address);
+      const lastTxId = await warp.arweave.wallets.getLastTransactionID(address);
+
+      console.table({
+        address,
+        balance: parseFloat(balance),
+        lastTxId: lastTxId === '' ? 'no transactions yet' : lastTxId,
+      });
+    }
+  )
+
   .command(
     'deploy',
     'Deploy a new contract',

src/bin/transfer.ts

@@ -1,4 +1,4 @@
-import {lastPossibleSortKey} from 'warp-contracts';
+import {LoggerFactory, lastPossibleSortKey} from 'warp-contracts';
 import type {JWKInterface, Warp} from 'warp-contracts';
 import {SDK} from '../hollowdb';
 
@@ -10,9 +10,7 @@ async function loadState(sdk: SDK) {
   }, 2000);
 
   await sdk.getState();
-
   clearInterval(interval);
-  console.log('Done!\n');
 }
 
 // gets keys directly from the storage layer (no interactions)
@@ -35,23 +33,25 @@ export async function transfer(
   srcContractTxId: string,
   destContractTxId: string
 ): Promise<number> {
-  console.log('Creating source SDK...');
+  LoggerFactory.INST.logLevel('none');
+
+  console.time('Creating source SDK');
   const src = new SDK(wallet, srcContractTxId, warp);
   await loadState(src);
+  console.timeEnd('Creating source SDK');
+  console.log('https://sonar.warp.cc/?#/app/contract/' + srcContractTxId);
 
-  console.log('Creating destination SDK...');
+  console.time('\nCreating destination SDK');
   const dest = new SDK(wallet, destContractTxId, warp);
   await loadState(dest);
-
-  console.log('Source     : https://sonar.warp.cc/?#/app/contract/' + srcContractTxId);
-  console.log('Destination: https://sonar.warp.cc/?#/app/contract/' + destContractTxId);
-  console.log('');
+  console.timeEnd('\nCreating destination SDK');
+  console.log('https://sonar.warp.cc/?#/app/contract/' + destContractTxId);
 
   const [srcKeys, destKeys] = await Promise.all([
     getKeysFromStorage(src, srcContractTxId),
     getKeysFromStorage(dest, destContractTxId),
   ]);
-  console.log('Number of keys:', '\n\tSRC:', srcKeys.length, '\n\tDEST:', destKeys.length);
+  console.log('\nNumber of keys:', '\n  Source:', srcKeys.length, '\n  Destination:', destKeys.length);
 
   let numKeys = 0;
   async function transferKey(i: number) {

src/contracts/README.md

@@ -9,19 +9,21 @@ To begin, clone the repo and install the packages:
 git clone https://github.com/firstbatchxyz/hollowdb
 
 # install packages
-yarn
+pnpm install
 ```
 
-Our command-line tool can be called via `yarn contract`. You will see the message below if you type `yarn contract --help`:
+Our command-line tool can be called via `pnpm contract`. You will see the message below if you type `pnpm contract --help`:
 
 ```sh
-yarn contract <command>
+pnpm contract <command>
 
 Commands:
-  yarn contract deploy  Deploy a new contract
-  yarn contract evolve  Evolve an existing contract
-  yarn contract create  Create your own custom contract
-  yarn contract build   Build a contract
+  pnpm contract whoami    Display information about your wallet
+  pnpm contract deploy    Deploy a new contract
+  pnpm contract evolve    Evolve an existing contract
+  pnpm contract create    Create your own custom contract
+  pnpm contract build     Build a contract
+  pnpm contract transfer  Transfer keys & values from one contract to another
 
 Options:
       --help          Show help                                        [boolean]
@@ -41,25 +43,25 @@ As shown in the help message above, building, deploying, or evolving a contract
 
 ```sh
 # build all contracts
-yarn contract build
+pnpm contract build
 
 # build a specific contract
-yarn contract build -n contract-name
+pnpm contract build -n contract-name
 
 # deploy to mainnet from a local source code
-yarn contract deploy -w ./secret/wallet.json -n contract-name
+pnpm contract deploy -w ./secret/wallet.json -n contract-name
 
 # deploy to mainnet from an existing contract source
-yarn contract deploy -w ./secret/wallet.json -s sourceTxId
+pnpm contract deploy -w ./secret/wallet.json -s sourceTxId
 
 # deploy to testnet from a local source code with a specific state
-yarn contract deploy -w ./secret/wallet.json -n contract-name -t test -i ./path/to/state.json
+pnpm contract deploy -w ./secret/wallet.json -n contract-name -t test -i ./path/to/state.json
 
 # evolve a contract on mainnet to a local source code
-yarn contract evolve -w ./secret/wallet.json -c contractTxId -n contract-name
+pnpm contract evolve -w ./secret/wallet.json -c contractTxId -n contract-name
 
 # evolve a contract on mainnet to an existing contract source
-yarn contract evolve -w ./secret/wallet.json -c contractTxId -s sourceTxId
+pnpm contract evolve -w ./secret/wallet.json -c contractTxId -s sourceTxId
 ```
 
 Thanks to the file structure we are using here, you do not need to worry about paths to your contracts or their initial states. When you provide a contract name with `-n` option, the CLI knows to look for the contract source code at `./src/contracts/<name>.contract.ts` and such.
@@ -71,7 +73,7 @@ A SmartWeave contract for Warp Contracts is basically a single JS file that expo
 To begin creating your own contract, simply do:
 
 ```sh
-yarn contract create -n your-new-contract
+pnpm contract create -n your-new-contract
 ```
 
 Within your newly created contract, you can modify the existing functions or add your own.
@@ -235,4 +237,4 @@ Within this directory:
 - `states` has the initial state for each contract.
 - `types` has types, as usual in TypeScript.
 - `utils` has common utility functions, such as proof verification.
-- the remaining files with `.contract.ts` extension are the smart-contracts, and when you run `yarn contract:build` they will be detected and built.
+- the remaining files with `.contract.ts` extension are the smart-contracts, and when you run `pnpm contract build` they will be detected and built.