Skip to content

Commit

Permalink
Update the commands in the plutus-pab README.md (#203)
Browse files Browse the repository at this point in the history
* Update the commands in the plutus-pab README.md
  • Loading branch information
koslambrou authored Dec 17, 2021
1 parent 7bb80c0 commit d1b65be
Showing 1 changed file with 32 additions and 30 deletions.
62 changes: 32 additions & 30 deletions plutus-pab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ confirmed. Integration test complete."
### psgenerator

```
$ cabal run plutus-pab -- psgenerator
$ cabal exec plutus-pab-setup -- psgenerator generated
```

#### Description
Expand All @@ -101,7 +101,7 @@ Generates the purescript bridge code.
### migrate

```
$ cabal run plutus-pab -- migrate
$ cabal exec plutus-pab-examples -- migrate --config plutus-pab.yaml.sample
```

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

```
$ cabal run plutus-pab -- all-servers
$ cabal exec plutus-pab-examples -- all-servers --config plutus-pab.yaml.sample
```

#### Description

Combines the execution of all core services and mocks in the appropriate order:
Combines the execution of all services in the appropriate order:

* mocks
- mock node
- mock wallet
* core services
- PAB webserver
- chain index
* node (mock or real)
* wallet (mock, local or remote)
* PAB webserver
* chain index

#### Dependencies

- plutus-pab.yaml
- sqlite database
- pab-client


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

```
$ cabal run plutus-pab -- client-services
$ cabal exec plutus-pab-examples -- client-services --config plutus-pab.yaml.sample
```

#### Description

Starts all mocks and core services *except for* the mock node service:
Starts all services *except for* the node service:

* mocks
- mock wallet
* core services
- PAB webserver
- chain index
* wallet (mock, local or remote)
* PAB webserver
* chain index

#### Dependencies

- plutus-pab.yaml
- sqlite database
- pab-client


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

```
$ cabal run plutus-pab -- wallet-server
$ cabal exec plutus-pab-examples -- wallet-server --config plutus-pab.yaml.sample
```

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

- plutus-pab.yaml
- mock node
- node

#### Source

- [Cardano.Wallet.Types.WalletConfig](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/Types.hs)

Mock wallet:
- [Cardano.Wallet.Mock.API](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/Mock/API.hs)
- [Cardano.Wallet.Mock.Server.main](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/Mock/Server.hs#L70)
- [Cardano.Wallet.Mock.Types.WalletConfig](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/Mock/Types.hs#L110)
- [Cardano.Wallet.Mock.Server.main](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/Mock/Server.hs)

Local wallet:
- [Cardano.Wallet.LocalClient](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/LocalClient.hs)

Remote wallet:
- [Cardano.Wallet.RemoteClient](https://github.com/input-output-hk/plutus-apps/blob/main/plutus-pab/src/Cardano/Wallet/RemoteClient.hs)

### webserver

```
$ cabal run plutus-pab -- webserver
$ cabal exec plutus-pab-examples -- webserver --config plutus-pab.yaml.sample
```

#### Description
Expand All @@ -215,16 +217,16 @@ Serves the PAB user interface
### node-server

```
$ cabal run plutus-pab -- node-server
$ cabal exec plutus-pab-examples -- node-server --config plutus-pab.yaml.sample
```

#### Description

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

- chain-index
- webserver
- mock wallet
- wallet

#### Dependencies

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

```
$ cabal run plutus-pab -- chain-index
$ cabal exec plutus-pab-examples -- chain-index --config plutus-pab.yaml.sample
```

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

- plutus-pab.yaml
- mock node
- node

#### Source

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

```
$ cabal run plutus-pab -- default-logging-config
$ cabal exec plutus-pab-setup -- default-logging-config
```

#### Description
Expand Down

0 comments on commit d1b65be

Please sign in to comment.