Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Rename Mesh #418

Merged
merged 1 commit into from
Jun 12, 2024
Merged

Rename Mesh #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to rosetta-cli
# Contributing to mesh-cli

## Code of Conduct

Expand All @@ -10,11 +10,11 @@ You can contribute to this repository by asking questions, providing feedback, a

### Asking Questions

Submit your questions via the [Rosetta Community boards][13].
Submit your questions via the [Mesh Community boards][13].

### Providing Feedback

You can also use the [Rosetta Community boards][13] to provide feedback.
You can also use the [Mesh Community boards][13] to provide feedback.

### Reporting Issues

Expand Down Expand Up @@ -72,17 +72,17 @@ All support requests must be made via [our support team][3].
© 2022 Coinbase

<!-- Before adding link 15, populate link 4. One you do that, please erase this note. --->
[1]: https://github.com/coinbase/rosetta-cli/issues
[1]: https://github.com/coinbase/mesh-cli/issues
[2]: https://chris.beams.io/posts/git-commit/#seven-rules
[3]: https://support.coinbase.com/customer/en/portal/articles/2288496-how-can-i-contact-coinbase-support-
<!--- [4]: link removed --->
[5]: https://github.com/coinbase/rosetta-cli/issues/new/choose
[6]: https://github.com/coinbase/rosetta-cli/issues/new?assignees=&labels=bug&template=bug_report.md&title=
[7]: https://github.com/coinbase/rosetta-cli/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
[8]: https://github.com/coinbase/rosetta-cli/pulls
[9]: https://github.com/coinbase/rosetta-cli/compare
[5]: https://github.com/coinbase/mesh-cli/issues/new/choose
[6]: https://github.com/coinbase/mesh-cli/issues/new?assignees=&labels=bug&template=bug_report.md&title=
[7]: https://github.com/coinbase/mesh-cli/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
[8]: https://github.com/coinbase/mesh-cli/pulls
[9]: https://github.com/coinbase/mesh-cli/compare
[10]: https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request#creating-an-issue
[11]: https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request#creating-a-pull-request
[12]: https://hackerone.com/coinbase
[13]: https://community.rosetta-api.org
[14]: https://github.com/coinbase/rosetta-cli/security
[13]: https://community.mesh-api.org
[14]: https://github.com/coinbase/mesh-cli/security
68 changes: 34 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
<p align="center">
<a href="https://www.rosetta-api.org">
<img width="90%" alt="Rosetta" src="https://www.rosetta-api.org/img/rosetta_header.png">
<a href="https://www.mesh-api.org">
<img width="90%" alt="Mesh" src="https://www.mesh-api.org/img/mesh_header.png">
</a>
</p>
<h3 align="center">
Rosetta CLI
Mesh CLI
</h3>
<p align="center">
CLI to validate the correctness of Rosetta API implementations
CLI to validate the correctness of Mesh API implementations
</p>
<p align="center">
<a href="https://circleci.com/gh/coinbase/rosetta-cli/tree/master"><img src="https://circleci.com/gh/coinbase/rosetta-cli/tree/master.svg?style=shield" /></a>
<a href="https://coveralls.io/github/coinbase/rosetta-cli"><img src="https://coveralls.io/repos/github/coinbase/rosetta-cli/badge.svg" /></a>
<a href="https://goreportcard.com/report/github.com/coinbase/rosetta-cli"><img src="https://goreportcard.com/badge/github.com/coinbase/rosetta-cli" /></a>
<a href="https://github.com/coinbase/rosetta-cli/blob/master/LICENSE.txt"><img src="https://img.shields.io/github/license/coinbase/rosetta-cli.svg" /></a>
<a href="https://circleci.com/gh/coinbase/mesh-cli/tree/master"><img src="https://circleci.com/gh/coinbase/mesh-cli/tree/master.svg?style=shield" /></a>
<a href="https://coveralls.io/github/coinbase/mesh-cli"><img src="https://coveralls.io/repos/github/coinbase/mesh-cli/badge.svg" /></a>
<a href="https://goreportcard.com/report/github.com/coinbase/mesh-cli"><img src="https://goreportcard.com/badge/github.com/coinbase/mesh-cli" /></a>
<a href="https://github.com/coinbase/mesh-cli/blob/master/LICENSE.txt"><img src="https://img.shields.io/github/license/coinbase/mesh-cli.svg" /></a>
</p>

The `rosetta-cli` tool is used by developers to test the correctness of their Rosetta API implementations. The CLI also provides the ability to look up block contents and account balances.
The `mesh-cli` tool is used by developers to test the correctness of their Mesh API implementations. The CLI also provides the ability to look up block contents and account balances.

## Installation

To download a binary for the latest release, run:
```
curl -sSfL https://raw.githubusercontent.com/coinbase/rosetta-cli/master/scripts/install.sh | sh -s
curl -sSfL https://raw.githubusercontent.com/coinbase/mesh-cli/master/scripts/install.sh | sh -s
```

The binary will be installed inside the `./bin` directory (relative to the directory where you ran the installation command).
Expand All @@ -32,11 +32,11 @@ _Downloading binaries from the Github UI will cause permission errors on Mac._
### Installing in a Custom Location
To download the binary into a specific directory, run:
```
curl -sSfL https://raw.githubusercontent.com/coinbase/rosetta-cli/master/scripts/install.sh | sh -s -- -b <relative directory>
curl -sSfL https://raw.githubusercontent.com/coinbase/mesh-cli/master/scripts/install.sh | sh -s -- -b <relative directory>
```

### Run via Docker
Running the following command will start a Docker container and present CLI for the Rosetta API.
Running the following command will start a Docker container and present CLI for the Mesh API.
```
docker run -it [image-name] [command]
```
Expand All @@ -47,42 +47,42 @@ docker run -v "$(pwd):/data" -it [image-name] check:data --configuration-file /d
```

## Key Sign Tool
Rosetta CLI comes with a handy key sign tool for local testing. Please refer to this [README](./cmd/README.md) on how to use it.
Mesh CLI comes with a handy key sign tool for local testing. Please refer to this [README](./cmd/README.md) on how to use it.

## Updates and Releases

We recommend that you continually update your installation to the latest release as soon as possible. The latest release notes are available in our [Community](https://community.rosetta-api.org) board under the [Release](https://community.rosetta-api.org/c/releases/13) category.
We recommend that you continually update your installation to the latest release as soon as possible. The latest release notes are available in our [Community](https://community.mesh-api.org) board under the [Release](https://community.mesh-api.org/c/releases/13) category.

You can also view releases and change log information in the [Releases](https://github.com/coinbase/rosetta-cli/releases) section of this repository.
You can also view releases and change log information in the [Releases](https://github.com/coinbase/mesh-cli/releases) section of this repository.

## Documentation

You can find the Rosetta API documentation at [rosetta-api.org](https://www.rosetta-api.org/docs/welcome.html)
You can find the Mesh API documentation at [mesh-api.org](https://www.mesh-api.org/docs/welcome.html)

For more information on the rosetta-cli tool, read our [The rosetta-cli tool](https://www.rosetta-api.org/docs/rosetta_cli.html) documentation.
For more information on the mesh-cli tool, read our [The mesh-cli tool](https://www.mesh-api.org/docs/mesh_cli.html) documentation.

For more information on how to test your implementation file with the `rosetta-cli` tool, read our [How to Test Your Rosetta Implementation](https://www.rosetta-api.org/docs/rosetta_test.html) documentation.
For more information on how to test your implementation file with the `mesh-cli` tool, read our [How to Test Your Mesh Implementation](https://www.mesh-api.org/docs/mesh_test.html) documentation.

Our documentation is divided into the following sections:

* [Product Overview](https://www.rosetta-api.org/docs/welcome.html)
* [Getting Started](https://www.rosetta-api.org/docs/getting_started.html)
* [Rosetta API Spec](https://www.rosetta-api.org/docs/Reference.html)
* [Testing](https://www.rosetta-api.org/docs/rosetta_cli.html)
* [Best Practices](https://www.rosetta-api.org/docs/node_deployment.html)
* [Repositories](https://www.rosetta-api.org/docs/rosetta_specifications.html)
* [Product Overview](https://www.mesh-api.org/docs/welcome.html)
* [Getting Started](https://www.mesh-api.org/docs/getting_started.html)
* [Mesh API Spec](https://www.mesh-api.org/docs/Reference.html)
* [Testing](https://www.mesh-api.org/docs/mesh_cli.html)
* [Best Practices](https://www.mesh-api.org/docs/node_deployment.html)
* [Repositories](https://www.mesh-api.org/docs/mesh_specifications.html)

## Contributing

You may contribute to the `rosetta-cli` project in various ways:
You may contribute to the `mesh-cli` project in various ways:

* [Asking Questions](CONTRIBUTING.md/#asking-questions)
* [Providing Feedback](CONTRIBUTING.md/#providing-feedback)
* [Reporting Issues](CONTRIBUTING.md/#reporting-issues)

Read our [Contributing](CONTRIBUTING.MD) documentation for more information.

## rosetta-cli Tool Development
## mesh-cli Tool Development

While working on improvements to this repository, we recommend that you use these commands to check your code:

Expand All @@ -92,13 +92,13 @@ While working on improvements to this repository, we recommend that you use thes
* `make release` to run one last check before opening a PR
* `make compile version=RELEASE_TAG` to generate binaries

If you are developing on both the `rosetta-cli` and `rosetta-sdk-go` repositories, use [go.mod replace](https://golang.org/ref/mod#go-mod-file-replace) to reference local changes:
If you are developing on both the `mesh-cli` and `mesh-sdk-go` repositories, use [go.mod replace](https://golang.org/ref/mod#go-mod-file-replace) to reference local changes:
```
replace "github.com/coinbase/rosetta-sdk-go" v0.6.8 => "<PATH TO LOCAL rosetta-sdk-go>"
replace "github.com/coinbase/mesh-sdk-go" v0.6.8 => "<PATH TO LOCAL mesh-sdk-go>"
```
### Release
* When we release a new rosetta-cli version, please update the version number to follow [PR](https://github.com/coinbase/rosetta-cli/pull/334) so that `rosetta-cli version` command can print the correct value.
* Create binaries and upload all the binaries in the new release tag (e.g. https://github.com/coinbase/rosetta-cli/releases/tag/v0.7.7)
* When we release a new mesh-cli version, please update the version number to follow [PR](https://github.com/coinbase/mesh-cli/pull/334) so that `mesh-cli version` command can print the correct value.
* Create binaries and upload all the binaries in the new release tag (e.g. https://github.com/coinbase/mesh-cli/releases/tag/v0.7.7)
* Ensure `$GOPATH/bin` is added to `$PATH`
* Run `make compile version=<New Version>`
* All the binaries will be created in the `bin` folder and should have extension as `tar.gz` and new version number
Expand Down Expand Up @@ -128,14 +128,14 @@ _Note: MacOS users, if you face `ulimit: setrlimit failed: invalid argument` er

## Related Projects

* [`rosetta-sdk-go`](https://github.com/coinbase/rosetta-sdk-go) — The `rosetta-sdk-go` SDK provides a collection of packages used for interaction with the Rosetta API specification. Much of the SDK code is generated from this, the [`rosetta-specifications`](https://github.com/coinbase/rosetta-specifications) repository.
* [`rosetta-specifications`](https://github.com/coinbase/rosetta-specifications) — The `rosetta-specifications` repository generates the SDK code in the [`rosetta-sdk-go`](https://github.com/coinbase/rosetta-sdk-go) repository.
* [`mesh-sdk-go`](https://github.com/coinbase/mesh-sdk-go) — The `mesh-sdk-go` SDK provides a collection of packages used for interaction with the Mesh API specification. Much of the SDK code is generated from this, the [`mesh-specifications`](https://github.com/coinbase/mesh-specifications) repository.
* [`mesh-specifications`](https://github.com/coinbase/mesh-specifications) — The `mesh-specifications` repository generates the SDK code in the [`mesh-sdk-go`](https://github.com/coinbase/mesh-sdk-go) repository.

### Reference Implementations

To help you with examples, we developed complete Rosetta API reference implementations for [Bitcoin](https://github.com/coinbase/rosetta-bitcoin) and [Ethereum](https://github.com/coinbase/rosetta-ethereum). Developers of Bitcoin-like or Ethereum-like blockchains may find it easier to fork these reference implementations than to write an implementation from scratch.
To help you with examples, we developed complete Mesh API reference implementations for [Bitcoin](https://github.com/coinbase/mesh-bitcoin) and [Ethereum](https://github.com/coinbase/mesh-ethereum). Developers of Bitcoin-like or Ethereum-like blockchains may find it easier to fork these reference implementations than to write an implementation from scratch.

You can also find community implementations for a variety of blockchains in the [rosetta-ecosystem](https://github.com/coinbase/rosetta-ecosystem) repository, and in the [ecosystem category](https://community.rosetta-api.org/c/ecosystem) of our community site.
You can also find community implementations for a variety of blockchains in the [mesh-ecosystem](https://github.com/coinbase/mesh-ecosystem) repository, and in the [ecosystem category](https://community.mesh-api.org/c/ecosystem) of our community site.


## License
Expand Down
12 changes: 6 additions & 6 deletions cmd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
## Key Sign Tool

Rosetta CLI has a key sign tool, which you can use to sign and verify various curves supported
by rosetta-specifications. This should only be used for local development. Never share private keys anywhere.
Mesh CLI has a key sign tool, which you can use to sign and verify various curves supported
by mesh-specifications. This should only be used for local development. Never share private keys anywhere.

### Usage
#### Key Generate
```
rosetta-cli key:gen --curve-type secp256k1
mesh-cli key:gen --curve-type secp256k1
```
Curve Type options are specified by [rosetta-specifications](https://github.com/coinbase/rosetta-specifications/blob/master/models/CurveType.yaml)
Curve Type options are specified by [mesh-specifications](https://github.com/coinbase/mesh-specifications/blob/master/models/CurveType.yaml)
#### Sign
```
rosetta-cli key:sign --configuration-file config.json
mesh-cli key:sign --configuration-file config.json
```

A sample config file is located [here](../examples/configuration/sign.json)
Expand All @@ -24,7 +24,7 @@ Required fields includes

#### Verify
```
rosetta-cli key:verify --configuration-file verify.json
mesh-cli key:verify --configuration-file verify.json
```
A sample config file is located [here](../examples/configuration/verify.json)

Expand Down
Loading