Skip to content

Commit 129304d

Browse files
LadyChristinadimkarakostas
authored andcommitted
Update links with new repo name
1 parent dd6f2f7 commit 129304d

File tree

7 files changed

+27
-27
lines changed

7 files changed

+27
-27
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
All Submissions:
22

3-
* [ ] Have you followed the guidelines in our [Contributing documentation](https://blockchain-technology-lab.github.io/pooling-analysis/contribute)?
3+
* [ ] Have you followed the guidelines in our [Contributing documentation](https://blockchain-technology-lab.github.io/consensus-decentralization/contribute)?
44
* [ ] Have you verified that there aren't any other open Pull Requests for the same update/change?
55
* [ ] Does the Pull Request pass all tests?
66

@@ -35,7 +35,7 @@ All Submissions:
3535
- [ ] TezosMapping
3636
- [ ] Did you enable the parser for the new ledger in `src/parse.py`?
3737
- [ ] Did you enable the mapping for the new ledger in `src/map.py`?
38-
- [ ] Did you document support for the new ledger as described in our [Contributing documentation](https://blockchain-technology-lab.github.io/pooling-analysis/contribute)?
38+
- [ ] Did you document support for the new ledger as described in our [Contributing documentation](https://blockchain-technology-lab.github.io/consensus-decentralization/contribute)?
3939

4040
### Update Mapping Support Information Submissions:
4141

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repository provides a CLI tool for analyzing the block production of various blockchains and measuring their
44
subsequent levels of decentralization. Please refer to the project's
5-
[documentation pages](https://blockchain-technology-lab.github.io/pooling-analysis/) for details on its architecture,
5+
[documentation pages](https://blockchain-technology-lab.github.io/consensus-decentralization/) for details on its architecture,
66
required input, produced output, and more.
77

88
Currently, the supported blockchains are:
@@ -19,7 +19,7 @@ Currently, the supported blockchains are:
1919

2020
To install the tool, simply clone this project:
2121

22-
git clone https://github.com/Blockchain-Technology-Lab/pooling-analysis.git
22+
git clone https://github.com/Blockchain-Technology-Lab/consensus-decentralization.git
2323

2424
The [requirements file](requirements.txt) lists the dependencies of the project.
2525
Make sure you have all of them installed before running the scripts. To install
@@ -34,7 +34,7 @@ Place all raw data (which could be collected from BigQuery for example) in the `
3434
`<project_name>_raw_data.json` (e.g. `bitcoin_raw_data.json`). By default, there
3535
is a (very small) sample input file for some supported projects. To use the
3636
samples, remove the prefix `sample_`. For more extended raw data and instructions on how to retrieve it, see
37-
[here](https://blockchain-technology-lab.github.io/pooling-analysis/data/).
37+
[here](https://blockchain-technology-lab.github.io/consensus-decentralization/data/).
3838

3939
Run `python run.py --ledgers <ledger_1> <ledger_n> --timeframe <timeframe>` to produce a csv of the mapped data.
4040
Note that both arguments are optional, so it's possible to omit one or both of them (in which case the default values
@@ -68,7 +68,7 @@ You can contribute to the tool in one of the following ways:
6868
- Add a new metric.
6969

7070
For detailed information on how to contribute see the relevant [documentation
71-
page](https://blockchain-technology-lab.github.io/pooling-analysis/contribute/).
71+
page](https://blockchain-technology-lab.github.io/consensus-decentralization/contribute/).
7272

7373
## Maintainers
7474

@@ -82,5 +82,5 @@ people in the above list.
8282

8383
## License
8484

85-
The code of this repository is released under the [MIT License](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/LICENSE).
85+
The code of this repository is released under the [MIT License](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/LICENSE).
8686
The documentation pages are released under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).

docs/contribute.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ In the directory `mapping_information`, there exist three folders (`addresses`,
1515
`<project_name>.json`, if there exist such information for the new ledger (for
1616
more details on what type of information each folder corresponds to see the
1717
[mapping
18-
documentation](https://blockchain-technology-lab.github.io/pooling-analysis/mappings/)).
18+
documentation](https://blockchain-technology-lab.github.io/consensus-decentralization/mappings/)).
1919

2020
### Parser and mapping
2121

@@ -49,18 +49,18 @@ module scripts. Specifically:
4949
new parser or mapping class was created for the project, simply assign the suitable class (e.g. DefaultParser or
5050
DefaultMapping) to the project's name in the corresponding dictionary.
5151
- If you create a new parser/mapping, you should also add unit
52-
tests [here](https://github.com/Blockchain-Technology-Lab/pooling-analysis/tree/main/tests)
52+
tests [here](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/tree/main/tests)
5353

5454
### Documentation
5555

5656
Finally, you should include the new ledger in the documentation pages;
5757
specifically:
5858

59-
- add the ledger in the list of supported ledgers in the repository's main [README file](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/README.md)
60-
- add the ledger in the list of supported ledgers in the [index documentation page](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/docs/index.md)
61-
- document the new ledger's parser in the [corresponding documentation page](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/docs/parsers.md)
62-
- document how the new ledger's data is retrieved in the [corresponding documentation page](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/docs/data.md);
63-
if Google BigQuery is used, add the new query to [queries.yaml](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/queries.yaml)
59+
- add the ledger in the list of supported ledgers in the repository's main [README file](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/README.md)
60+
- add the ledger in the list of supported ledgers in the [index documentation page](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/docs/index.md)
61+
- document the new ledger's parser in the [corresponding documentation page](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/docs/parsers.md)
62+
- document how the new ledger's data is retrieved in the [corresponding documentation page](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/docs/data.md);
63+
if Google BigQuery is used, add the new query to [queries.yaml](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/queries.yaml)
6464

6565
### Data
6666

@@ -75,7 +75,7 @@ information about a supported ledger's mapping, you should open a Pull Request.
7575
This can be done either via console or as follows, via the browser:
7676

7777
- Open the file that you want to change (e.g., for Bitcoin, follow
78-
[this link](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/mapping_information/identifiers/bitcoin.json))
78+
[this link](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/mapping_information/identifiers/bitcoin.json))
7979
on your browser.
8080
- Click `Edit this file`.
8181
- Make your changes in the file.
@@ -116,7 +116,7 @@ the filename above) and any parameter values it might require to the file
116116
`config.yaml`, under `metrics`.
117117

118118
Fourth, you should add unit tests for the new metric
119-
[here](https://github.com/Blockchain-Technology-Lab/pooling-analysis/tree/main/tests).
119+
[here](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/tree/main/tests).
120120

121121
Finally, you should update the [corresponding documentation
122-
page](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/docs/metrics.md)
122+
page](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/docs/metrics.md)

docs/data.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,17 +89,17 @@ AND timestamp > '2018-12-31'
8989

9090
Instead of executing each of these queries separately on the BigQuery console and saving the results manually, it is
9191
also possible to automate the process using
92-
a [script](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/src/collect_data.py) and collect all
92+
a [script](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/src/collect_data.py) and collect all
9393
relevant data in one go. Executing this script will run all queries
94-
in [this file](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/queries.yaml), so you can also
94+
in [this file](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/queries.yaml), so you can also
9595
control which queries are run by adding them to or removing them from the file (or turning them into comments by
9696
adding a `#` in front of each relevant line).
9797

9898
IMPORTANT: the script uses service account credentials for authentication, therefore before running it, you need to
9999
generate the relevant credentials from Google, as described
100100
[here](https://developers.google.com/workspace/guides/create-credentials#service-account) and save your key in the
101101
root directory of the project under the name 'google-service-account-key.json'. There is a
102-
[sample file](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/google-service-account-key-SAMPLE.json)
102+
[sample file](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/google-service-account-key-SAMPLE.json)
103103
that you can consult, which shows what your credentials are supposed to look like (but note that this is for
104104
informational purposes only, this file is not used in the code).
105105

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This is the documentation for the Consensus Decentralization Analysis tool devel
44
Blockchain Technology Lab. The tool is responsible for analyzing the block production of various blockchains and measuring their
55
subsequent levels of decentralization.
66

7-
The relevant source code is available on [GitHub](https://github.com/Blockchain-Technology-Lab/pooling-analysis).
7+
The relevant source code is available on [GitHub](https://github.com/Blockchain-Technology-Lab/consensus-decentralization).
88

99
## Overview
1010
The tool consists of the following modules:
@@ -43,7 +43,7 @@ We intend to add more ledgers to this list in the future.
4343
## Contributing
4444

4545
This is an open source project licensed under the terms and conditions of the
46-
[MIT license](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/LICENSE) and
46+
[MIT license](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/LICENSE) and
4747
[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
4848
Everyone is welcome to contribute to it by proposing or implementing their
4949
ideas. Example contributions include, but are not limited to, reporting
@@ -54,8 +54,8 @@ license.
5454

5555
When making changes in the code, contributors are required to fork the project's repository first and then issue a pull
5656
request with their changes. Each PR will be reviewed before being merged to the main branch. Bugs can be reported
57-
in the [Issues](https://github.com/Blockchain-Technology-Lab/pooling-analysis/issues) page.
57+
in the [Issues](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/issues) page.
5858
Other comments and ideas can be brought up in the project's
59-
[Discussions](https://github.com/Blockchain-Technology-Lab/pooling-analysis/discussions).
59+
[Discussions](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/discussions).
6060

6161
For more information on how to make specific contributions, see [How to Contribute](contribute.md).

docs/setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
To install the consensus decentralization analysis tool, simply clone this GitHub repository:
66

7-
git clone https://github.com/Blockchain-Technology-Lab/pooling-analysis.git
7+
git clone https://github.com/Blockchain-Technology-Lab/consensus-decentralization.git
88

99
The tool is written in Python 3, therefore a Python 3 interpreter is required in order to run it locally.
1010

11-
The [requirements file](https://github.com/Blockchain-Technology-Lab/pooling-analysis/blob/main/requirements.txt) lists
11+
The [requirements file](https://github.com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/requirements.txt) lists
1212
the dependencies of the project.
1313
Make sure you have all of them installed before running the scripts. To install
1414
all of them in one go, run the following command from the root directory of the

mapping_information/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ information about a supported ledger's mapping, you should open a Pull Request.
166166
This can be done either via console or as follows, via the browser:
167167

168168
- Open the file that you want to change (e.g., for Bitcoin, follow [this link](https://github.
169-
com/Blockchain-Technology-Lab/pooling-analysis/blob/main/mapping_information/identifiers/bitcoin.json)) on
169+
com/Blockchain-Technology-Lab/consensus-decentralization/blob/main/mapping_information/identifiers/bitcoin.json)) on
170170
your browser.
171171
- Click `Edit this file`.
172172
- Make your changes in the file.

0 commit comments

Comments
 (0)