8000 Update MD files by 5A11 · Pull Request #155 · fetchai/cosmpy · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update MD files #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
This is the official list of Fetch.ai authors for copyright purposes.

* Ali Hosseini <ali.hosseini@fetch.ai> [5A11](https://github.com/5A11)
* Peter Bukva <peter.bukva@fetch.ai> [pbukva](https://github.com/pbukva)
* Jiri Vestfal <jiri.vestfal@fetch.ai> [MissingNO57](https://github.com/MissingNO57)
* Ed Fitzgerald <ed.fitzgerald@fetch.ai> [ejfitzgerald](https://github.com/ejfitzgerald)
* Oleg Panasevych <oleg.panasevych@n-cube.co.uk> [Panasevychol](https://github.com/panasevychol)
* Jiri Vestfal <jiri.vestfal@fetch.ai> [MissingNO57](https://github.com/MissingNO57)
* Lokman Rahmani <lokman.rahmani@fetch.ai> [lrahmani](https://github.com/lrahmani)
* Oleg Panasevych <oleg.panasevych@n-cube.co.uk> [Panasevychol](https://github.com/panasevychol)
* Peter Bukva <peter.bukva@fetch.ai> [pbukva](https://github.com/pbukva)
* Yuri Turchenkov <yuri.turchenkov@fetch.ai> [solarw](https://github.com/solarw)

47 changes: 16 additions & 31 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The easiest way to get set up for development is to install Python `>=3.7` and `

## Development commands

There are various makefile commands which are helpful during development. Some of the more prominent ones are listed below:
There are various makefile commands that help the development. Some of them are:

- For linting:
```bash
Expand All @@ -20,25 +20,22 @@ There are various makefile commands which are helpful during development. Some o
make mypy
make pylint
```
- For code security analysis:
```bash
make security
```

- To run tests:
```bash
make test
```

Before committing and opening a PR, use the above commands to run the checks locally. This saves CI hours and ensures you only commit clean code.

## Generating python types from Cosmos SDK protobuf schemas

This library uses python types which are generated (using [Google's Protocol Buffers](https://developers.google.com/protocol-buffers/) compiler) from protocol buffer schemas in the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) and [WasmD](https://github.com/CosmWasm/wasmd).

When updating the Cosmos SDK version supported by this library (see the version currently used under `COSMOS_SDK_VERSION` in [Makefile](#Makefile])), you will need to fetch its corresponding protobuf schemas and generate their associated python types, replacing the existing ones.
When updating the Cosmos-SDK version that is supported by this library (see the version currently used under `COSMOS_SDK_VERSION` in [Makefile](#Makefile])), you will need to fetch its corresponding protobuf schemas and generate their associated python types, replacing the existing ones.

>Note: This process has to be done only once when the Cosmos SDK version supported by this library is changed.
>Note: This process has to be done only once when the Cosmos-SDK version supported by this library is changed.

>Note: To generate python types from Cosmos SDK protobuf schemas, you will need [Google Protocol Buffers](https://developers.google.com/protocol-buffers/) compiler. A guide on how to install it can be found [here](https://fetchai.github.io/oef-sdk-python/user/install.html#protobuf-compiler).
>Note: To generate python types from Cosmos-SDK protobuf schemas, you will need [Google Protocol Buffers](https://developers.google.com/protocol-buffers/) compiler. A guide on how to install it can be found [here](https://fetchai.github.io/oef-sdk-python/user/install.html#protobuf-compiler).

* To regenerate the protobuf schema files, run the following:
```bash
Expand Down Expand Up @@ -74,29 +71,14 @@ The Makefile in this repo provides various useful commands that ease development
* `make liccheck`: checks dependencies and reports any license issues
* `make copyright-check`: checks that files have the correct copyright headers
* documentation:
* `make generate-docs`: generates documentation from the source code
* `make open-docs`: opens `index.html` page of the documentation (if on Linux or MacOS).

## To setup a local Stargate node

### Preliminaries
* `make docs`: generates documentation from the source code
* `make docs-live`: creates a live-reloading docs server on localhost.

You require Go version 16.0 or higher for your platform (see <a href="https://golang.org/doc/install" target="_blank">here</a>)
## To set up a local Fetchai node

### Setup a node

- Setup FetchD
```bash
bash scripts/setup_fetchd.sh
```
The script will ask for root permissions while setting up a node.

- Start the node
```bash
fetchd start
```
To set up a local Fetchai node refer to [this guide](https://docs.fetch.ai/ledger_v2/single-node-network/).

## To run a local Stargate node in docker
## To run a local Fetchai node in docker

### Preliminaries

Expand Down Expand Up @@ -139,7 +121,10 @@ You require [Docker](https://docs.docker.com/get-docker/) for your platform.

* Execute:
```bash
docker run -it --rm --entrypoint /scripts/<ENTRYPOINT_SCRIPT_NAME> -p 9090:9090 -p 1317:1317 -v <PATH_TO_ENTRYPOINT_SCRIPT>:/scripts/ fetchai/fetchd:0.9.0-rc4
docker run -it --rm --entrypoint /scripts/<ENTRYPOINT-SCRIPT-NAME> -p 9090:9090 -p 1317:1317 -v <PATH-TO-ENTRYPOINT-SCRIPT>:/scripts/ <FETCH-IMAGE-TAG>
```

where `<ENTRYPOINT_SCRIPT_NAME>` is the name of the entrypoint script (e.g.`fetchd_initialise.sh`) and `<PATH_TO_ENTRYPOINT_SCRIPT>` is the path to the directory you placed the script (e.g.`~/fetchd_docker/`).
where
* `<ENTRYPOINT-SCRIPT-NAME>` is the name of the entrypoint script (e.g.`fetchd_initialise.sh`)
* `<PATH-TO-ENTRYPOINT-SCRIPT>` is the path to the directory you placed the script (e.g.`~/fetchd_docker/`),
* `<FETCH-IMAGE-TAG>` is the tag of the FetchD docker image you want to run (e.g. `fetchai/fetchd:0.10.0` for Dorado)
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ Then navigate to the following URL in your browser:

Under the `examples` directory, you can find examples of basic ledger interactions using `cosmpy` e.g. transferring tokens, staking, deployinig and interacting with a smart contract, and performing atomic swaps.

## To contribute

Please see [CONTRIBUTING](CONTRIBUTING.md) and [DEVELOPING](DEVELOPING.md) guides.

## Extra Resources

* [Github Repo](https://github.com/fetchai/cosmpy)
Expand Down
0