Skip to content

Commit da075f7

Browse files
MaximStanciu8MaximStanciu8
authored
Merge pull request #370 from Dominikkq/patch-1
Update README.md
2 parents f429763 + 21ab20f commit da075f7

File tree

1 file changed

+3
-286
lines changed

1 file changed

+3
-286
lines changed

‎federator/README.md

+3-286
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Federator
22

3-
Presents the event and necesary information to validate it on the other network
3+
Presents the event and necesary information to validate it on the other network.
44
The federator is an off-chain process which performs voting actions to validate transactions between a Mainchain (source) and a Sidechain (target) network. These transactions are obtained from the Bridge contract on the Mainchain using event logs and voted in the Sidechain through a Federation contract. Once all required signers (federators) vote for a transaction the Federation contract starts the process to release the funds on the Sidechain.
55
The federators will be the owners of the contracts willing to allow to cross their tokens, and by doing so staking they reputation.
66

77
## Config
88

99
Go to /federator/config copy `config.sample.js` file and rename it to `config.js` set mainchain and sidechain to point to the json files of the networks you are using, for example rsktestnet-kovan.json and kovan.json, `make sure to set the host parameter of those files`. Add a value to the key `FEDERATOR_KEY` in the .env file, and add the private key of the member of the Federation contract, also you can define a general retry attempts number for the failed processes in the application by setting the value of the key `ENV_DEFAULT_ATTEMPTS` to the number of attempts that you desire, you can use 0 for infinite attempts, if no attempt is provided the default value is 3. The members of the federation are controled by the MultiSig contract, same that is owner of the Bridge and AllowedTokens contracts.
1010
You will also need to add an [etherscan api key](https://etherscan.io/myapikey) in this config file.
11+
> Please also note that the private node of RSKj should be running and synced with public one.
1112
## Usage
1213

1314
Run `npm install` to install the dependencies, make sure you followed the previous config step. Then to start the service run `npm start` which will start a single federator that listen to both networks. Check the logs to see that everything is working properly.
@@ -20,7 +21,7 @@ In order to test with multiple federators, ensure they're added as members of th
2021

2122
## Run a Federator
2223

23-
### config
24+
### Config
2425

2526
To run the federator using Docker, go to the /federator/config folder and rename `config.sample.js` to `config.js`. In that file you will determine the networks the federate must be listening to, for example for the bridge in testnet a federator config.js will look like
2627

@@ -122,287 +123,3 @@ This endpoint is introduced, in order to better monitor health status on the Fed
122123

123124
### Skip HTTPS check
124125
- As an developer you can set in config.js the property `checkHttps: false` to skip the HTTPS check on the host url config
125-
126-
# Datadog
127-
128-
## Datadog metric tracking
129-
130-
A `DATADOG_API_KEY` environment variable should be available for this to work (**only an error log will let you know if this is not configured - the app will run either way**).
131-
This should be a valid API key associated to the Datadog account in which you're going to be tracking the metrics.
132-
Example for setting it: `export DATADOG_API_KEY=08e436512591258b12bf1781ebe`
133-
134-
## Running a local Datadog agent
135-
136-
If you're interested in the metrics to be tracked in a particular account (might be a personal test account), you can follow the instructions [here](https://docs.datadoghq.com/agent/docker/?tab=standard).
137-
Either way, at the time of writing this (mid-October 2021), running a Docker container as follows should suffice:
138-
```
139-
docker run -d --name dd-agent -v /var/run/docker.sock:/var/run/docker.sock:ro -v /proc/:/host/proc/:ro -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro -e DD_API_KEY=08e436512591258b12bf1781ebe -e DD_SITE="datadoghq.com" -e DD_DOGSTATSD_NON_LOCAL_TRAFFIC="true" gcr.io/datadoghq/agent:7
140-
```
141-
142-
## Datadog dashboard metadata
143-
144-
The following is a basic dashboard that collects metrics tracked by the Federators - just copying it and pasting it into a new timeboard in Datadog should be enough for it to look like the following:
145-
![image](https://user-images.githubusercontent.com/7085857/137196235-dbdc5877-8072-4390-857a-f937ce0122fd.png)
146-
147-
```json
148-
{
149-
"title": "Federator PoC",
150-
"description": "",
151-
"widgets": [{
152-
"id": 3267013605690894,
153-
"definition": {
154-
"title": "Heartbeat",
155-
"type": "group",
156-
"show_title": true,
157-
"layout_type": "ordered",
158-
"widgets": [{
159-
"id": 3281955858405340,
160-
"definition": {
161-
"title": "Main chain heartbeat",
162-
"title_size": "16",
163-
"title_align": "left",
164-
"type": "query_table",
165-
"requests": [{
166-
"formulas": [{
167-
"alias": "latest block",
168-
"conditional_formats": [],
169-
"limit": {
170-
"count": 500,
171-
"order": "desc"
172-
},
173-
"cell_display_mode": "number",
174-
"formula": "query1"
175-
}],
176-
"response_format": "scalar",
177-
"queries": [{
178-
"query": "min:interoperability.token_bridge.heartbeat.main_chain.emission{*} by {host,address,fed_version,node_info,chain_id}",
179-
"data_source": "metrics",
180-
"name": "query1",
181-
"aggregator": "last"
182-
}]
183-
}],
184-
"has_search_bar": "auto"
185-
}
186-
}, {
187-
"id": 4101321670212740,
188-
"definition": {
189-
"title": "Main chain latest block processed",
190-
"title_size": "16",
191-
"title_align": "left",
192-
"type": "query_value",
193-
"requests": [{
194-
"formulas": [{
195-
"formula": "query1"
196-
}],
197-
"response_format": "scalar",
198-
"queries": [{
199-
"query": "avg:interoperability.token_bridge.heartbeat.main_chain.emission{*}",
200-
"data_source": "metrics",
201-
"name": "query1",
202-
"aggregator": "avg"
203-
}]
204-
}],
205-
"autoscale": false,
206-
"precision": 0
207-
}
208-
}, {
209-
"id": 1917582770012226,
210-
"definition": {
211-
"title": "Side chain heartbeat",
212-
"title_size": "16",
213-
"title_align": "left",
214-
"type": "query_table",
215-
"requests": [{
216-
"formulas": [{
217-
"alias": "latest block",
218-
"conditional_formats": [],
219-
"limit": {
220-
"count": 500,
221-
"order": "desc"
222-
},
223-
"cell_display_mode": "number",
224-
"formula": "query1"
225-
}],
226-
"response_format": "scalar",
227-
"queries": [{
228-
"query": "min:interoperability.token_bridge.heartbeat.side_chain.emission{*} by {host,address,fed_version,node_info,chain_id}",
229-
"data_source": "metrics",
230-
"name": "query1",
231-
"aggregator": "last"
232-
}]
233-
}],
234-
"has_search_bar": "auto"
235-
}
236-
}, {
237-
"id": 577916112954332,
238-
"definition": {
239-
"title": "Side chain latest block processed",
240-
"title_size": "16",
241-
"title_align": "left",
242-
"type": "query_value",
243-
"requests": [{
244-
"formulas": [{
245-
"formula": "query1"
246-
}],
247-
"response_format": "scalar",
248-
"queries": [{
249-
"query": "avg:interoperability.token_bridge.heartbeat.side_chain.emission{*}",
250-
"data_source": "metrics",
251-
"name": "query1",
252-
"aggregator": "avg"
253-
}]
254-
}],
255-
"autoscale": false,
256-
"precision": 0
257-
}
258-
}]
259-
}
260-
}, {
261-
"id": 6945469758716188,
262-
"definition": {
263-
"title": "ERC721",
264-
"type": "group",
265-
"show_title": true,
266-
"layout_type": "ordered",
267-
"widgets": [{
268-
"id": 8265548757769668,
269-
"definition": {
270-
"title": "Votes per address and chain id",
271-
"title_size": "16",
272-
"title_align": "left",
273-
"show_legend": true,
274-
"legend_layout": "auto",
275-
"legend_columns": ["avg", "min", "max", "value", "sum"],
276-
"type": "timeseries",
277-
"requests": [{
278-
"formulas": [{
279-
"formula": "query1"
280-
}],
281-
"response_format": "timeseries",
282-
"on_right_yaxis": false,
283-
"queries": [{
284-
"query": "sum:interoperability.token_bridge.federator.voting{type:erc721} by {address,chain_id,result}.as_count()",
285-
"data_source": "metrics",
286-
"name": "query1"
287-
}],
288-
"style": {
289-
"palette": "dog_classic",
290-
"line_type": "solid",
291-
"line_width": "normal"
292-
},
293-
"display_type": "bars"
294-
}],
295-
"yaxis": {
296-
"include_zero": true,
297-
"scale": "linear",
298-
"label": "",
299-
"min": "auto",
300-
"max": "auto"
301-
},
302-
"markers": []
303-
}
304-
}, {
305-
"id": 878136284410596,
306-
"definition": {
307-
"title": "Votes per address and chain id",
308-
"title_size": "16",
309-
"title_align": "left",
310-
"type": "query_table",
311-
"requests": [{
312-
"formulas": [{
313-
"formula": "query1",
314-
"limit": {
315-
"count": 500,
316-
"order": "desc"
317-
}
318-
}],
319-
"response_format": "scalar",
320-
"queries": [{
321-
"query": "sum:interoperability.token_bridge.federator.voting{type:erc721} by {address,chain_id,result}.as_count()",
322-
"data_source": "metrics",
323-
"name": "query1",
324-
"aggregator": "sum"
325-
}]
326-
}]
327-
}
328-
}]
329-
}
330-
}, {
331-
"id": 3588165781267182,
332-
"definition": {
333-
"title": "ERC20",
334-
"type": "group",
335-
"show_title": true,
336-
"layout_type": "ordered",
337-
"widgets": [{
338-
"id": 3218485023565918,
339-
"definition": {
340-
"title": "Votes per address and chain id",
341-
"title_size": "16",
342-
"title_align": "left",
343-
"show_legend": true,
344-
"legend_layout": "auto",
345-
"legend_columns": ["avg", "min", "max", "value", "sum"],
346-
"type": "timeseries",
347-
"requests": [{
348-
"formulas": [{
349-
"formula": "query1"
350-
}],
351-
"response_format": "timeseries",
352-
"on_right_yaxis": false,
353-
"queries": [{
354-
"query": "sum:interoperability.token_bridge.federator.voting{type:erc20} by {address,chain_id}.as_count()",
355-
"data_source": "metrics",
356-
"name": "query1"
357-
}],
358-
"style": {
359-
"palette": "dog_classic",
360-
"line_type": "solid",
361-
"line_width": "normal"
362-
},
363-
"display_type": "area"
364-
}],
365-
"yaxis": {
366-
"include_zero": true,
367-
"scale": "linear",
368-
"label": "",
369-
"min": "auto",
370-
"max": "auto"
371-
},
372-
"markers": []
373-
}
374-
}, {
375-
"id": 2598946470976434,
376-
"definition": {
377-
"title": "Votes per address and chain id",
378-
"title_size": "16",
379-
"title_align": "left",
380-
"type": "query_table",
381-
"requests": [{
382-
"formulas": [{
383-
"formula": "query1",
384-
"limit": {
385-
"count": 500,
386-
"order": "desc"
387-
}
388-
}],
389-
"response_format": "scalar",
390-
"queries": [{
391-
"query": "sum:interoperability.token_bridge.federator.voting{type:erc20} by {address,chain_id,result}.as_count()",
392-
"data_source": "metrics",
393-
"name": "query1",
394-
"aggregator": "sum"
395-
}]
396-
}]
397-
}
398-
}]
399-
}
400-
}],
401-
"template_variables": [],
402-
"layout_type": "ordered",
403-
"is_read_only": false,
404-
"notify_list": [],
405-
"reflow_type": "auto",
406-
"id": "wsr-524-c9q"
407-
}
408-
```

0 commit comments

Comments
 (0)