Skip to content

Commit cfc68b6

Browse files
committed
Add README entry for pact verification server deployment
1 parent 3e974d7 commit cfc68b6

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,24 @@ This file must exist, so chainweaver won't start up in development mode (launchi
109109

110110
The first entry in the file will be chosen as the current network, unless the user picked a different one. The user will also be able to modify networks at runtime. The above configuration will be the default and the one that gets applied, when the user presses "Restore Defaults".
111111

112-
### Provide remote verification server
112+
### Remote verification server
113113

114-
chainweaver supports verification of Pact modules, unfortunately the prover used is z3 which is implemented in C++ and is therefore not available on ghcjs. To make it still work, we use a remote verification server for verifying contracts. Please provide a file `config/common/verification-server` containing the base url of some `pact -s` server, e.g.:
114+
chainweaver supports verification of Pact modules, unfortunately the prover used is z3 which is implemented in C++ and is therefore not available on ghcjs. To make it still work, we use a remote verification server for verifying contracts.
115+
116+
In order to deploy the remote verification server along with the chainweaver deployment copy the file `pact-server/module.nix` to the `deploydir`.
117+
Based on the deployment target please edit the imports in this file to use either `mkBaceEc2` or `virtualbox-image.nix`.
118+
119+
The other optional configurable parameter in this file is the `location`, which is the nginx virtualhost's path.
120+
Its default value is `/pact/`, but it could be modified to some other value.
121+
122+
Finally make sure the `config/common/verification-server` file matches the location value specified in the `module.nix`.
123+
124+
For the default location of `/pact/`, the contents of this file would be `<URI>/pact`, for example:
125+
```
126+
https://my-chainweaver.io/pact
127+
```
128+
129+
In case the pact server is not deployed with the chainweaver, please provide a file `config/common/verification-server` containing the base url of some other `pact -s` server, e.g.:
115130

116131
```
117132
https://pact01.kadena.io

0 commit comments

Comments
 (0)