Skip to content
This repository was archived by the owner on Dec 2, 2024. It is now read-only.

Commit d1b65be

Browse files
authored
Update the commands in the plutus-pab README.md (#203)
* Update the commands in the plutus-pab README.md
1 parent 7bb80c0 commit d1b65be

File tree

1 file changed

+32
-30
lines changed

1 file changed

+32
-30
lines changed

plutus-pab/README.md

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ confirmed. Integration test complete."
8787
### psgenerator
8888

8989
```
90-
$ cabal run plutus-pab -- psgenerator
90+
$ cabal exec plutus-pab-setup -- psgenerator generated
9191
```
9292

9393
#### Description
@@ -101,7 +101,7 @@ Generates the purescript bridge code.
101101
### migrate
102102

103103
```
104-
$ cabal run plutus-pab -- migrate
104+
$ cabal exec plutus-pab-examples -- migrate --config plutus-pab.yaml.sample
105105
```
106106

107107
#### Description
@@ -115,25 +115,22 @@ Migrates the database in `pab-core.db` to the current schema. The database cont
115115
### all-servers
116116

117117
```
118-
$ cabal run plutus-pab -- all-servers
118+
$ cabal exec plutus-pab-examples -- all-servers --config plutus-pab.yaml.sample
119119
```
120120

121121
#### Description
122122

123-
Combines the execution of all core services and mocks in the appropriate order:
123+
Combines the execution of all services in the appropriate order:
124124

125-
* mocks
126-
- mock node
127-
- mock wallet
128-
* core services
129-
- PAB webserver
130-
- chain index
125+
* node (mock or real)
126+
* wallet (mock, local or remote)
127+
* PAB webserver
128+
* chain index
131129

132130
#### Dependencies
133131

134132
- plutus-pab.yaml
135133
- sqlite database
136-
- pab-client
137134

138135

139136
#### Source
@@ -143,24 +140,21 @@ Combines the execution of all core services and mocks in the appropriate order:
143140
### client-services
144141

145142
```
146-
$ cabal run plutus-pab -- client-services
143+
$ cabal exec plutus-pab-examples -- client-services --config plutus-pab.yaml.sample
147144
```
148145

149146
#### Description
150147

151-
Starts all mocks and core services *except for* the mock node service:
148+
Starts all services *except for* the node service:
152149

153-
* mocks
154-
- mock wallet
155-
* core services
156-
- PAB webserver
157-
- chain index
150+
* wallet (mock, local or remote)
151+
* PAB webserver
152+
* chain index
158153

159154
#### Dependencies
160155

161156
- plutus-pab.yaml
162157
- sqlite database
163-
- pab-client
164158

165159

166160
#### Source
@@ -170,7 +164,7 @@ Starts all mocks and core services *except for* the mock node service:
170164
### wallet-server
171165

172166
```
173-
$ cabal run plutus-pab -- wallet-server
167+
$ cabal exec plutus-pab-examples -- wallet-server --config plutus-pab.yaml.sample
174168
```
175169

176170
#### Description
@@ -183,18 +177,26 @@ Plutus specific wallet implementation for managing user funds on the blockchain.
183177
#### Dependencies
184178

185179
- plutus-pab.yaml
186-
- mock node
180+
- node
187181

188182
#### Source
189183

184+
- [Cardano.Wallet.Types.WalletConfig](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/Types.hs)
185+
186+
Mock wallet:
190187
- [Cardano.Wallet.Mock.API](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/Mock/API.hs)
191-
- [Cardano.Wallet.Mock.Server.main](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/Mock/Server.hs#L70)
192-
- [Cardano.Wallet.Mock.Types.WalletConfig](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/Mock/Types.hs#L110)
188+
- [Cardano.Wallet.Mock.Server.main](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/Mock/Server.hs)
189+
190+
Local wallet:
191+
- [Cardano.Wallet.LocalClient](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/LocalClient.hs)
192+
193+
Remote wallet:
194+
- [Cardano.Wallet.RemoteClient](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/RemoteClient.hs)
193195

194196
### webserver
195197

196198
```
197-
$ cabal run plutus-pab -- webserver
199+
$ cabal exec plutus-pab-examples -- webserver --config plutus-pab.yaml.sample
198200
```
199201

200202
#### Description
@@ -215,16 +217,16 @@ Serves the PAB user interface
215217
### node-server
216218

217219
```
218-
$ cabal run plutus-pab -- node-server
220+
$ cabal exec plutus-pab-examples -- node-server --config plutus-pab.yaml.sample
219221
```
220222

221223
#### Description
222224

223-
Mock-implementation of a Goguen node. Clients to this service are:
225+
Mock or real implementation of a Goguen node. Clients to this service are:
224226

225227
- chain-index
226228
- webserver
227-
- mock wallet
229+
- wallet
228230

229231
#### Dependencies
230232

@@ -238,7 +240,7 @@ Mock-implementation of a Goguen node. Clients to this service are:
238240
### chain-index
239241

240242
```
241-
$ cabal run plutus-pab -- chain-index
243+
$ cabal exec plutus-pab-examples -- chain-index --config plutus-pab.yaml.sample
242244
```
243245

244246
#### Description
@@ -251,7 +253,7 @@ for datum and script hashes. Clients to this service are:
251253
#### Dependencies
252254

253255
- plutus-pab.yaml
254-
- mock node
256+
- node
255257

256258
#### Source
257259

@@ -261,7 +263,7 @@ for datum and script hashes. Clients to this service are:
261263
### default-logging-config
262264

263265
```
264-
$ cabal run plutus-pab -- default-logging-config
266+
$ cabal exec plutus-pab-setup -- default-logging-config
265267
```
266268

267269
#### Description

0 commit comments

Comments
 (0)