forked from IBM-Blockchain-Archive/marbles
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5245d27
commit 54cce2f
Showing
3 changed files
with
124 additions
and
93 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| # Configuration | ||
|
|
||
| Configuration of marbles happens with two files. | ||
| These files can be found in the folder `<marbles directory>/config`. | ||
|
|
||
| 1. Config File | ||
| - This is the file that has settings for the marble company you are pretending to be. | ||
| - Such as a the name of your marbles company, list of marble owners, what port this marbles app should use, etc.. | ||
| - It can be found in `<marbles directory>/config/marbles1.json`. | ||
| - You only need to edit/create 1 file. | ||
| - Create a new file for each Marble company you want to pretend to be. | ||
|
|
||
| 1. Credential File | ||
| - This file has settings for your network. | ||
| - This can be found in `<marbles>/config/blockchain_creds1.json`. | ||
| - You only need to edit/create 1 file. | ||
| - Use seperate files for seperate blockchain networks. | ||
|
|
||
|
|
||
|
|
||
| ### Config File Example: | ||
|
|
||
| ```json | ||
| { | ||
| "cred_filename": "blockchain_creds4.json", | ||
| "use_events": true, | ||
| "keep_alive_secs": 120, | ||
| "company": "United Marbles", | ||
| "usernames": [ | ||
| "amy", | ||
| "alice", | ||
| "ava" | ||
| ], | ||
| "port": 3001, | ||
| "last_startup_hash": "db9c62e3b6a3dabfd1d108a99342185f1cac92c7" | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| - cred_filename - The name of the `Credential File` to use for your network. See the `Credential File` section for details. | ||
| - use_events - When `true` it will use EventHub.js in the SDK to be notified when tx are committed to the ledger. When `false` it will wait/sleep for a block to be created | ||
| - keep_alive_secs - How often to periodically re-enroll in seconds. This keeps the gRPC connections alive. | ||
| - company - The name of your marbles company | ||
| - usernames - The list of marbles owners that should be created on initial startup | ||
| - port - The port to use when hosting the marbles application | ||
| - last_start_hash - You do not need to modify/create this field. Its created internally when marbles runs successfull. Its a hash of the network credentials file. Its used to detect when you are trying to re-run marbles with a new network and we should go through the full initial startup. | ||
|
|
||
|
|
||
|
|
||
| ### Creds File Example: | ||
|
|
||
| ```json | ||
| { | ||
| "credentials": { | ||
| "network_id": "FakeNetworkId", | ||
| "orderers": [ | ||
| { | ||
| "discovery": "grpc://localhost:7050", | ||
| "msp_id": "Org1MSP" | ||
| } | ||
| ], | ||
| "cas": [ | ||
| { | ||
| "api": "http://localhost:7054", | ||
| "msp_id": "Org1MSP", | ||
| "users": [ | ||
| { | ||
| "enrollId": "admin", | ||
| "enrollSecret": "adminpw" | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "peers": [ | ||
| { | ||
| "discovery": "grpc://localhost:7051", | ||
| "events": "grpc://localhost:7053", | ||
| "msp_id": "Org1MSP" | ||
| } | ||
| ], | ||
| "app": { | ||
| "channel_id": "mychannel", | ||
| "chaincode_id": "marbles", | ||
| "chaincode_version": "v0", | ||
| "block_delay": 1000 | ||
| }, | ||
| "tls_common_name": null, | ||
| "tls_certificate": "-----BEGIN CERTIFICATE----- <removed> -----END CERTIFICATE-----\r\n" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| - network_id - The main purpose of this is to detect when people try to use the default file w/o any editing! Set it to anything other than `FakeNetworkId`. | ||
| - orderers - An Array. Must have at least 1 entry. You can add more, but currently only the first one will be used. | ||
| - discovery - The gRPC url to reach the orderer. It must include the port. | ||
| - msp_id - The ID associated with the orderer. See fabric documentation for MSP information. | ||
| - cas - An Array. Must have at least 1 entry. You can add more, but currently only the first one will be used. | ||
| - api - The gRPC url to reach the ca. It must include the port. | ||
| - msp_id - The ID associated with the ca. | ||
| - users - An array of object containing the `enrollId` and `enrollSecret`. | ||
| - enrollId - A registered user's id on the CA. Can be found in the CA's yaml file. | ||
| - enrollSecret - A registered user's secret on the CA. Can be found in the CA's yaml file. | ||
| - peers - An array. Must have at least 1 entry. You can add more, but currently only the first one will be used. | ||
| - discovery - The gRPC url to reach the peer. It must include the port. | ||
| - events - The gRPC url to reach event endpoint of the peer. It must include the port and it is different than the discovery port! | ||
| - msp_id - The ID associated with the peer. | ||
| - app - This is an object | ||
| - channel_id - Name of the channel where marbles chaincode has been instantiated. | ||
| - chaincode_id - Name of the chaincode installed. | ||
| - chaincode_version - Version of the chaincode installed. | ||
| - block_delay - Time in ms for a block to be created by the orderer. This is a setting in the orderer's yaml. | ||
| - tls_common_name - Only needed when using self signed certs. It will override the common name. | ||
| - tls_certificate - Can be either the complete PEM file that has line breaks encoded as `\r\n` **OR** a relative file path to a PEM file inside the `config` folder. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters