From 4adddebbe837f19751e823440280bb81c2360085 Mon Sep 17 00:00:00 2001 From: rdewilder Date: Sun, 21 Aug 2022 21:47:59 -0400 Subject: [PATCH] Merge to master from develop (#38) * added the list of test accounts to chain.md and usage.md * updated description of timeAdded in time.md * bumped to version 0.3.0 --- docs/api/chain.md | 12 +++++++++++- docs/api/time.md | 4 ++-- docs/tutorial/usage.md | 11 +++++++++++ package.json | 2 +- 4 files changed, 25 insertions(+), 4 deletions(-) diff --git a/docs/api/chain.md b/docs/api/chain.md index 3a788b0..96788e3 100644 --- a/docs/api/chain.md +++ b/docs/api/chain.md @@ -22,7 +22,17 @@ Local port number the RPC api is bound to ## Methods ### static async setupChain(chainName: string): Promise<Chain> -Setup new testing chain, setup chain docker instance, initialize api client, create 10 test accounts +Setup new testing chain, setup chain docker instance, initialize api client, creates the following 10 test accounts: +- acc11.test +- acc12.test +- acc13.test +- acc14.test +- acc15.test +- acc21.test +- acc22.test +- acc23.test +- acc24.test +- acc25.test Valid chainName values: WAX, EOS and TLOS diff --git a/docs/api/time.md b/docs/api/time.md index d245573..e57d765 100644 --- a/docs/api/time.md +++ b/docs/api/time.md @@ -6,7 +6,7 @@ The Time class allows the manipulation of blocktime. These functions only add t ### chain: Chain Reference to the chain instance ### timeAdded: number -Record of time added to chain +The total number of seconds that have been skipped in the chain ## Constructor **constructor(chain: Chain): Time** @@ -18,4 +18,4 @@ Incrementally increase time of chain. ### async increaseTo(time: number): Promise<number> -Increase time of chain to specific time point. T +Increase time of chain to specific time point T diff --git a/docs/tutorial/usage.md b/docs/tutorial/usage.md index 8a98b42..b918711 100644 --- a/docs/tutorial/usage.md +++ b/docs/tutorial/usage.md @@ -20,6 +20,17 @@ const account2 = chain.accounts[2]; // create account let newAccount = await chain.system.createAccount("newaccount"); ``` +The following test accounts are created automatically: +- acc11.test +- acc12.test +- acc13.test +- acc14.test +- acc15.test +- acc21.test +- acc22.test +- acc23.test +- acc24.test +- acc25.test ## Contracts diff --git a/package.json b/package.json index bdc87d5..641df86 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "qtest-js", - "version": "0.2.2", + "version": "0.3.0", "description": "eosio testing library", "main": "dist/index.js", "license": "MIT",