Merge pull request #7 from vechain/feat/release-1-0-0

Feat/release 1 0 0
vechain · May 8, 2024 · 2549f09 · 2549f09
2 parents bfc80a7 + 33f2396
commit 2549f09
Show file tree

Hide file tree

Showing 7 changed files with 254 additions and 136 deletions.
diff --git a/.npmrc b/.npmrc
diff --git a/README.md b/README.md
@@ -16,142 +16,21 @@
 
 # VeWorld Mock for E2E Testing
 
-VeWorld mock allows to develop playwright tests for dApps that interact with VeWorld browser wallet. 
+This repository contains packages:
 
-## Implementation
+* test-app : A simple webapp using DappKit & Connex for testing of the mock
+* veworld-mock : The actual mock implementation
+* vework-mock-playwright : A helper packing for using the mock in playwright tests
+* tests : Sample playwright tests using the test-app
 
-dApp's and VeWorld browser wallet communicate through the `window` object to each other. Specifically
-VeWorld makes functions available on the `window` object that a dApp can call. These functions
-are for certificate signing and transaction signing and sending to vechain thor.
+See documentation:
 
-VeWorld Mock replaces those functions with its own implementation, meaning that VeWorld browser wallet
-is not needed to be installed when running playwright tests, and the mock implementations of these
-functions can be configured to suit the test scenario.
+* [veworld-mock](./packages/veworld-mock/README.md)
+* [veworld-mock-playwright](./packages/veworld-mock-playwright/README.md)
+* [sample tests](./tests/playwright/README.md)
 
-## Installation
 
-Add the dependencies to your project
 
-`yarn add --dev @vechain/veworld-mock` 
-`yarn add --dev @vechain/veworld-mock-playwright`
-
-## Configuration
-
-VeWorld mock has the following configuration:
-
-- `accountIndex` : The account index derived from the mnemonic
-- `chainTag` : The chain tag of the thor instance used
-- `mnemonicWords` : The mnemonic used to derived the account index
-- `thorUrl` : Url of thorest api
-
-By default VeWorld mock is configured to use a local Solo, with its default mnemonic and its first account
-
-## Options
-
-VeWorld mock has the following options:
-
-### Transactions
-
-* `mockTransaction`: specifies the type of transaction to create, values are {real, fake, reject}
- * `real` --> The mock will create a real transaction
- * `fake` --> The mock will return the configured fake transaction id
- * `reject` --> The mock will return an error similar to when the user clicks on Reject in VeWorld 
-* `fakeTxId` --> The transaction id to use when using `fake`
-* `gasMultiplier` : When using `real` or `fake` the gas % multiplier to use when estimating the transaction gas
-
-The default values are: 
-
-```
-fakeCertSignerAddress: '0x0',
-fakeTxId: '0x0',
-mockTransaction: 'real',
-mockCertificate: 'valid',
-gasMultiplier: 0.2
-```
-
-(Note: To generate a reverted tx, a vet transfer clause of 10billion is added to the tx)
-
-### Certificates
-
-* `mockCertificate` : Specified how to mock the certificate signing, values are {valid, invalid}
- * `valid` --> Certificate will be signed correctly
- * `invalid` --> The certificate is signed correctly, but the `signer` is set to the fake address
-* `fakeCertSignerAddress` --> When using `invalid` the fake signer address
-
-
-
-## Outputs
-
-VeWorld mock makes the following available:
-
-- `address` : The address of the account index used
-- `txId` : The last signed tx id
-
-## Limitations
-
-- Does not mock WalletConnect
-- Does not mock Sync2
-- Does not support sending real tx's that use dependant tx's or delegated gas fee
-
-## Playwright
-
-Playwright runs as a node process, whereas the VeWorld mock run inside the browser 
-Two operations are needed: `load`, which loads the VeWorld mock js file into the browser, and `installMock` which sets up the mock functions on the window object. 
-
-This will need to be done before each test with a beforeEach block:
-
-```
- test.beforeEach(async ({ page }) => {
- await veWorldMockClient.load(page);
- await page.goto('http://localhost:5003');
- await veWorldMockClient.installMock(page);
- });
-```
-
-To configure the mock within a test:
-
-```
-import { veWorldMockClient } from '@vechain/veworld-mock-playwright'
-
-test('Configure mock', async ({ page }) => { 
- veWorldMockClient.setOptions(page, {validCertificate: false, fakeCertSignerAddress: "0x865306084235Bf804c8Bba8a8d56890940ca8F0b"});
-})
-```
-
-To read outputs of the mock:
-
-```
-import { veWorldMockClient } from '@vechain/veworld-mock-playwright'
-
-test('get outputs of mock', async ({ page }) => { 
- // do steps for cert signing...
- const address = await veWorldMockClient.getSignerAddress(page);
- // do steps for a tx ...
- const txId = await veWorldMockClient.getSenderTxId(page)
-})
-```
-
-## Sample App and Tests
-
-To build the test app, veworld mock and vework mock client:
-
-`yarn install` 
-`yarn build`
-
-The sample app uses Solo, to launch solo:
-
-`make solo-up`
-
-To launch the sample app (seperte terminal):
-
-`yarn dev`
-
-the test app is available at: http://localhost:5003/
-
-To run the playwright tests:
-
-`yarn install-browsers` 
-`yarn test`
 
 
 

diff --git a/packages/veworld-mock-playwright/README.md b/packages/veworld-mock-playwright/README.md
@@ -0,0 +1,87 @@
+
+```
+██╗ ██╗███████╗██╗ ██╗ ██████╗ ██████╗ ██╗ ██████╗ 
+██║ ██║██╔════╝██║ ██║██╔═══██╗██╔══██╗██║ ██╔══██╗
+██║ ██║█████╗ ██║ █╗ ██║██║ ██║██████╔╝██║ ██║ ██║
+╚██╗ ██╔╝██╔══╝ ██║███╗██║██║ ██║██╔══██╗██║ ██║ ██║
+ ╚████╔╝ ███████╗╚███╔███╔╝╚██████╔╝██║ ██║███████╗██████╔╝
+ ╚═══╝ ╚══════╝ ╚══╝╚══╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝╚═════╝ 
+███╗ ███╗ ██████╗ ██████╗██╗ ██╗ 
+████╗ ████║██╔═══██╗██╔════╝██║ ██╔╝ 
+██╔████╔██║██║ ██║██║ █████╔╝ 
+██║╚██╔╝██║██║ ██║██║ ██╔═██╗ 
+██║ ╚═╝ ██║╚██████╔╝╚██████╗██║ ██╗ 
+╚═╝ ╚═╝ ╚═════╝ ╚═════╝╚═╝ ╚═╝ 
+ ``` 
+
+## Playwright E2E
+
+Playwright runs as a node process, whereas the VeWorld mock run inside the browser 
+Two operations are needed: `load`, which loads the VeWorld mock js file into the browser, and `installMock` which sets up the mock functions on the window object. 
+
+This will need to be done before each test with a beforeEach block:
+
+```
+ test.beforeEach(async ({ page }) => {
+ await veWorldMockClient.load(page);
+ await page.goto('http://localhost:5003');
+ await veWorldMockClient.installMock(page);
+ });
+```
+
+To configure the mock within a test:
+
+```
+import { veWorldMockClient } from '@vechain/veworld-mock-playwright'
+
+test('Configure mock', async ({ page }) => { 
+ veWorldMockClient.setOptions(page, {validCertificate: false, fakeCertSignerAddress: "0x865306084235Bf804c8Bba8a8d56890940ca8F0b"});
+})
+```
+
+To read outputs of the mock:
+
+```
+import { veWorldMockClient } from '@vechain/veworld-mock-playwright'
+
+test('get outputs of mock', async ({ page }) => { 
+ // do steps for cert signing...
+ const address = await veWorldMockClient.getSignerAddress(page);
+ // do steps for a tx ...
+ const txId = await veWorldMockClient.getSenderTxId(page)
+})
+```
+
+## Sample App and Tests
+
+To build the test app, veworld mock and vework mock client:
+
+`yarn install` 
+`yarn build`
+
+The sample app uses Solo, to launch solo:
+
+`make solo-up`
+
+To launch the sample app (seperte terminal):
+
+`yarn dev`
+
+the test app is available at: http://localhost:5003/
+
+To run the playwright tests:
+
+`yarn install-browsers` 
+`yarn test`
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/packages/veworld-mock-playwright/package.json b/packages/veworld-mock-playwright/package.json
@@ -1,12 +1,17 @@
 {
  "name": "@vechain/veworld-mock-playwright",
- "version": "1.0.0-beta.1",
+ "version": "1.0.0",
  "description": "VeWorld Mock client for playwright",
  "main": "dist/client.js",
  "scripts": {
  "build": "tsc"
  },
- "keywords": [],
+ "keywords": [
+ "vechain",
+ "veworld",
+ "mock",
+ "playwright"
+ ],
  "author": "vechain",
  "license": "MIT",
  "repository": {
@@ -19,6 +24,6 @@
  },
  "dependencies": {
  "@playwright/test": "^1.42.1",
- "@vechain/veworld-mock": "1.0.0-beta.1"
+ "@vechain/veworld-mock": "1.0.0"
  }
 }
diff --git a/packages/veworld-mock/README.md b/packages/veworld-mock/README.md
@@ -0,0 +1,95 @@
+
+```
+██╗ ██╗███████╗██╗ ██╗ ██████╗ ██████╗ ██╗ ██████╗ 
+██║ ██║██╔════╝██║ ██║██╔═══██╗██╔══██╗██║ ██╔══██╗
+██║ ██║█████╗ ██║ █╗ ██║██║ ██║██████╔╝██║ ██║ ██║
+╚██╗ ██╔╝██╔══╝ ██║███╗██║██║ ██║██╔══██╗██║ ██║ ██║
+ ╚████╔╝ ███████╗╚███╔███╔╝╚██████╔╝██║ ██║███████╗██████╔╝
+ ╚═══╝ ╚══════╝ ╚══╝╚══╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝╚═════╝ 
+███╗ ███╗ ██████╗ ██████╗██╗ ██╗ 
+████╗ ████║██╔═══██╗██╔════╝██║ ██╔╝ 
+██╔████╔██║██║ ██║██║ █████╔╝ 
+██║╚██╔╝██║██║ ██║██║ ██╔═██╗ 
+██║ ╚═╝ ██║╚██████╔╝╚██████╗██║ ██╗ 
+╚═╝ ╚═╝ ╚═════╝ ╚═════╝╚═╝ ╚═╝ 
+ ``` 
+
+# VeWorld Mock for E2E Testing
+
+VeWorld mock allows to develop e2e tests for dApps that interact with VeWorld browser wallet. 
+
+## Implementation
+
+dApp's and VeWorld browser wallet communicate through the `window` object to each other. Specifically
+VeWorld makes functions available on the `window` object that a dApp can call. These functions
+are for certificate signing and transaction signing and sending to vechain thor.
+
+VeWorld Mock replaces those functions with its own implementation, meaning that VeWorld browser wallet
+is not needed to be installed when running playwright tests, and the mock implementations of these
+functions can be configured to suit the test scenario.
+
+## Installation
+
+Add the dependencies to your project
+
+`yarn add --dev @vechain/veworld-mock` 
+`yarn add --dev @vechain/veworld-mock-playwright`
+
+## Configuration
+
+VeWorld mock has the following configuration:
+
+- `accountIndex` : The account index derived from the mnemonic
+- `chainTag` : The chain tag of the thor instance used
+- `mnemonicWords` : The mnemonic used to derived the account index
+- `thorUrl` : Url of thorest api
+
+By default VeWorld mock is configured to use a local Solo, with its default mnemonic and its first account
+
+## Options
+
+VeWorld mock has the following options:
+
+### Transactions
+
+* `mockTransaction`: specifies the type of transaction to create, values are {real, fake, reject}
+ * `real` --> The mock will create a real transaction
+ * `fake` --> The mock will return the configured fake transaction id
+ * `reject` --> The mock will return an error similar to when the user clicks on Reject in VeWorld 
+* `fakeTxId` --> The transaction id to use when using `fake`
+* `gasMultiplier` : When using `real` or `fake` the gas % multiplier to use when estimating the transaction gas
+
+The default values are: 
+
+```
+fakeCertSignerAddress: '0x0',
+fakeTxId: '0x0',
+mockTransaction: 'real',
+mockCertificate: 'valid',
+gasMultiplier: 0.2
+```
+
+(Note: To generate a reverted tx, a vet transfer clause of 10billion is added to the tx)
+
+### Certificates
+
+* `mockCertificate` : Specified how to mock the certificate signing, values are {valid, invalid}
+ * `valid` --> Certificate will be signed correctly
+ * `invalid` --> The certificate is signed correctly, but the `signer` is set to the fake address
+* `fakeCertSignerAddress` --> When using `invalid` the fake signer address
+
+
+
+## Outputs
+
+VeWorld mock makes the following available:
+
+- `address` : The address of the account index used
+- `txId` : The last signed tx id
+
+## Limitations
+
+- Does not mock WalletConnect
+- Does not mock Sync2
+- Does not support sending real tx's that use dependant tx's or delegated gas fee
+
diff --git a/packages/veworld-mock/package.json b/packages/veworld-mock/package.json
@@ -1,13 +1,17 @@
 {
  "name": "@vechain/veworld-mock",
- "version": "1.0.0-beta.1",
+ "version": "1.0.0",
  "description": "VeWorld mock",
  "main": "dist/veworld-mock.js",
  "types": "dist/types.d.ts",
  "scripts": {
  "build": "webpack --config webpack.config.js"
  },
- "keywords": [],
+ "keywords": [
+ "vechain",
+ "veworld",
+ "mock"
+ ],
  "author": "vechain",
  "license": "MIT",
  "repository": {