https://github.com/bbengfort/rvasp
Robot VASP for TRISA demonstration and integration
https://github.com/bbengfort/rvasp
Last synced: over 1 year ago
JSON representation
Robot VASP for TRISA demonstration and integration
- Host: GitHub
- URL: https://github.com/bbengfort/rvasp
- Owner: bbengfort
- License: mit
- Created: 2020-10-06T10:23:02.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-11-24T15:56:44.000Z (over 5 years ago)
- Last Synced: 2025-02-08T17:45:54.523Z (over 1 year ago)
- Language: Python
- Size: 142 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rVASP
**Robot VASP for TRISA demonstration and integration**
This is a simple gRPC server that implements a UI workflow and messaging framework to demonstrate sending and receiving transactions using the TRISA InterVASP protocol. The server was built to support a demonstration UI that requires a streaming interface so that a live message flow is achieved. However, the communication protocol between rVASPs also demonstrates how implementers might go about writing InterVASP services in their own codebases. The architecture is as follows:
## Generating Protocol Buffers
To regenerate the Go and Python code from the protocol buffers:
```
$ go generate ./...
```
This will generate the Go code in `pb/` and the Python code in `pb/rvaspy`. Alternatively you can manually generate the code to specify different directories using the following commands:
```
$ protoc -I . --go_out=plugins=grpc:. api.proto
$ python -m grpc_tools.protoc -I . --python_out=./rvaspy --grpc_python_out=./rvaspy api.proto
```
## Quick Start
To get started using the rVASP, you can run the local server as follows:
```
$ go run ./cmd/rvasp serve
```
The server should now be listening for TRISADemo RPC messages. To send messages using the python API, make sure you can import the modules from `rvaspy` - the simplest way to do this is to install the package in editable mode as follows:
```
$ pip install -e ./rvaspy/
```
This will use the `setup.py` file in the `rvaspy` directory to install the package to your `$PYTHON_PATH`. Because it is in editable mode, any time you regenerate the protocol buffers or pull the repository, the module should be updated on the next time you import. An example script for using the package is as follows:
```python
import rvaspy
api = rvaspy.connect("localhost:4434")
cmds = [
api.account_request("robert@bobvasp.co.uk"),
api.transfer_request("robert@bobvasp.co.uk", "mary@alicevasp.us", 42.99)
]
for msg in api.stub.LiveUpdates(iter(cmds)):
print(msg)
```
Note that the `RVASP` api client is not fully implemented yet.
## Containers
We are currently not using a container repository, so to build the docker images locally, please run the following steps in order:
1. Build the root Docker image tagged as `trisacrypto/rvasp:latest`
2. Build the alice, bob, and evil containers in `containers/`, tagging them appropriately
3. Use `docker-compose` to run the three rVASPs locally
To simplify the build process, we have added a script that builds all 4 images. You can execute the building script as follows:
```
$ ./containers/rebuild.sh
```
Then all that's needed is to run `docker-compose up` to get the robot VASPs running locally.