Skip to content

Commit

Permalink
Added network specific example configurations. Slightly changed the r…
Browse files Browse the repository at this point in the history
…eadme file. (#52)

Co-authored-by: Noctunus <[email protected]>
  • Loading branch information
Noctunus and Noctunus authored Oct 2, 2024
1 parent 44f96a6 commit ccc84c2
Show file tree
Hide file tree
Showing 5 changed files with 184 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ Currently [release-9](https://github.com/chain4travel/camino-messenger-protocol/

## Examples and Docker Support

The repository includes examples demonstrating the setup of gRPC servers and clients under the `examples` folder. Additionally, Dockerfiles and a docker-compose.yml file are provided to simplify the deployment of a provider, distributor bot, and a partner plugin application that mocks responses.
The repository includes examples demonstrating the setup of gRPC servers and clients under the `examples` folder. Additionally, Dockerfiles and a docker-compose.yml file are provided to simplify the deployment of a provider, distributor bot, and a partner plugin application that mocks responses.

> [!Note]
> If docker-compose.yml is used, please check volumes. The configuration filepath should be `cmb-config/config.yaml`.
> If docker-compose.yml is used, please check volumes. The configuration filepath should be `cmb-config/config.yaml`. An example can be copied over from examples/config/ and modified.

## Getting Started
Expand Down
91 changes: 91 additions & 0 deletions examples/config/camino-messenger-bot-distributor-camino.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# This example is made for development purposes - for production see docker-compose.yml

# Lower level logging for local development
developer_mode: true

### Tracing
#tracing_enabled: true
#tracing_host: localhost
#tracing_port: 4317
#tracing_insecure: true
#tracing_cert_file: server-cert.pem
#tracing_key_file: server-key.pem

### Matrix

# Private key to be used to login to Matrix Server. This should be in hex format
# without the 0x prefix.
matrix_key: YOUR_PRIVATE_KEY_HEX

# Hostname of the Matrix Server
matrix_host: dev.messenger.chain4travel.com

# Local DB file to store Matrix data
matrix_store: distributor-matrix.db

# Timeout in milliseconds to wait for responses on Matrix Server
response_timeout: 10000

### Bot RPC Configuration

# Listen on this port for RPC requests from the partner plugin (or Postman during
# development)
rpc_server_port: 9090
# TLS configuration
rpc_unencrypted: true
rpc_server_cert_file: server-cert.pem
rpc_server_key_file: server-key.pem

### Partner Plugin (NOT USED FOR DISTRIBUTOR BOT)
# Partner Plugin hostname and port, should be reachable from this machine.
#
# Bot tries to connect to this host and port to relay messages that it receives from
# the distributors through Matrix Server
#partner_plugin_host: localhost
#partner_plugin_port: 50051
# TLS configuration
#partner_plugin_unencrypted: true
# Required if partner_plugin_unencrypted is false
#partner_plugin_ca_file: ca-cert.pem

### C-Chain (EVM)

# Used for signing transactions on the c-chain, can be same as the matrix_key. This
# address needs to have some funds to pay for transaction fees on the C-Chain. This
# should be in hex format without the 0x prefix.
evm_private_key: YOUR_PRIVATE_KEY_HEX

# C-Chain RPC URL
rpc_url: wss://api.camino.network/ext/bc/C/ws

# matrix application service bot address
network_fee_recipient_bot_address: 0xbeb027D2f439805E17EAA16Da26c1FCa68a30232

# matrix application service cm account address
network_fee_recipient_cm_account: 0x16DFfB3911BB0b1B53eF4d774804381f0B38B5d7

cheque_expiration_time: 18144000 # 7 months

min_cheque_duration_until_expiration: 15552000 # 6 months

cash_in_period: 86400 # 1 day

### Booking Token

# Booking Token contract address. This address will be used for minting, buying of Booking Tokens
booking_token_address: "0xe2b8c92B6519d1A2020dA0A5fBbA99a43A2c0922"

# Address of the CM Account that the bot belongs to
cm_account_address: 0xYOUR_CM_ACCOUNT_ADDRESS


### Database

# Database name.
db_name: camino_messenger_bot

# Path to database file.
db_path: distributor-bot.db

# Path to migrations dir with sql up/down scripts. Schema is mandatory.
migrations_path: file://./migrations
91 changes: 91 additions & 0 deletions examples/config/camino-messenger-bot-supplier-camino.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# This example is made for development purposes - for production see docker-compose.yml

# Lower level logging for local development
developer_mode: true

### Tracing
#tracing_enabled: true
#tracing_host: localhost
#tracing_port: 4317
#tracing_insecure: true
#tracing_cert_file: server-cert.pem
#tracing_key_file: server-key.pem

### Matrix

# Private key to be used to login to Matrix Server. This should be in hex format
# without the 0x prefix.
matrix_key: YOUR_PRIVATE_KEY_HEX

# Hostname of the Matrix Server
matrix_host: dev.messenger.chain4travel.com

# Local DB file to store Matrix data
matrix_store: supplier-matrix.db

# Timeout in milliseconds to wait for responses on Matrix Server
response_timeout: 10000

### Bot RPC Configuration

# Listen on this port for RPC requests from the partner plugin (or Postman during
# development)
rpc_server_port: 9090
# TLS configuration
rpc_unencrypted: true
rpc_server_cert_file: server-cert.pem
rpc_server_key_file: server-key.pem

### Partner Plugin

# Partner Plugin hostname and port, should be reachable from this machine.
#
# Bot tries to connect to this host and port to relay messages that it receives from
# the distributors through Matrix Server
partner_plugin_host: localhost
partner_plugin_port: 50051
# TLS configuration
partner_plugin_unencrypted: true
# Required if partner_plugin_unencrypted is false
partner_plugin_ca_file: ca-cert.pem

### C-Chain (EVM)

# Used for signing transactions on the c-chain, can be same as the matrix_key. This
# address needs to have some funds to pay for transaction fees on the C-Chain. This
# should be in hex format without the 0x prefix.
evm_private_key: YOUR_PRIVATE_KEY_HEX

# C-Chain RPC URL
rpc_url: wss://api.camino.network/ext/bc/C/ws

# matrix application service bot address
network_fee_recipient_bot_address: 0xbeb027D2f439805E17EAA16Da26c1FCa68a30232

# matrix application service cm account address
network_fee_recipient_cm_account: 0x16DFfB3911BB0b1B53eF4d774804381f0B38B5d7

cheque_expiration_time: 18144000 # 7 months

min_cheque_duration_until_expiration: 15552000 # 6 months

cash_in_period: 86400 # 1 day

### Booking Token

# Booking Token contract address. This address will be used for minting, buying of Booking Tokens
booking_token_address: "0xe2b8c92B6519d1A2020dA0A5fBbA99a43A2c0922"

# Address of the CM Account that the bot belongs to
cm_account_address: 0xYOUR_CM_ACCOUNT_ADDRESS

### Database

# Database name.
db_name: camino_messenger-bot

# Path to database file.
db_path: supplier-bot.db

# Path to migrations dir with sql up/down scripts. Schema is mandatory.
migrations_path: file://./migrations

0 comments on commit ccc84c2

Please sign in to comment.