diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9367caf..70d4fae2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,5 +84,4 @@ All support requests must be made via [our support team][3]. [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.mesh-api.org [14]: https://github.com/coinbase/mesh-sdk-go/security \ No newline at end of file diff --git a/Makefile b/Makefile index 14318ec4..5d4c626c 100644 --- a/Makefile +++ b/Makefile @@ -91,7 +91,7 @@ shellcheck: salus: docker run --rm -t -v ${PWD}:/home/repo coinbase/salus -release: shellcheck check-gen check-license check-format test lint salus +release: shellcheck check-license check-format lint salus mocks: rm -rf mocks; diff --git a/README.md b/README.md index 02efeb1d..136224ca 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,3 @@ - -

- - Mesh - -

Mesh SDK @@ -45,7 +39,7 @@ If you have a blockchain based on go-ethereum, we recommend that you use our [me This Golang project provides a [server package](https://github.com/coinbase/mesh-sdk-go/tree/master/server) that empowers a developer to write a full Mesh Data API server by only implementing an interface. This package automatically validates client requests and calls the functions you implement with pre-parsed requests (instead of in raw JSON). - If you plan to use a language other than Golang, you will need to either codegen a server (using [Swagger Codegen](https://swagger.io/tools/swagger-codegen) or [OpenAPI Generator](https://openapi-generator.tech/)) or write one from scratch. If you choose to write an implementation in another language, we ask that you create a separate repository in an SDK-like format for all the code you generate so that other developers can use it. You can add your repository to the list 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. Use this repository (mesh-sdk-go) for an example of how to generate code from this specification. + If you plan to use a language other than Golang, you will need to either codegen a server (using [Swagger Codegen](https://swagger.io/tools/swagger-codegen) or [OpenAPI Generator](https://openapi-generator.tech/)) or write one from scratch. If you choose to write an implementation in another language, we ask that you create a separate repository in an SDK-like format for all the code you generate so that other developers can use it. ### Installation Guide @@ -172,7 +166,7 @@ The core of any integration is syncing blocks reliably. The [syncer](https://git ### Parser -When reading the operations in a block, it's helpful to apply higher-level groupings to related operations, or match operations in a transaction to some set of generic descriptions (i.e., ensure there are two operations of equal but opposite amounts). The [parser](https://github.com/coinbase/mesh-sdk-go/tree/master/parser) empowers any integrator to build abstractions on top of the [building blocks](https://www.mesh-api.org/docs/mesh_principles.html#universal-transactions) that the Mesh API exposes. +When reading the operations in a block, it's helpful to apply higher-level groupings to related operations, or match operations in a transaction to some set of generic descriptions (i.e., ensure there are two operations of equal but opposite amounts). The [parser](https://github.com/coinbase/mesh-sdk-go/tree/master/parser) empowers any integrator to build abstractions on top of the building blocks that the Mesh API exposes. @@ -218,7 +212,7 @@ To validate `mesh-sdk-go`, [install `mesh-cli`](https://github.com/coinbase/mesh * `mesh-cli check:construction --configuration-file mesh-cli-conf/testnet/config.json` - This command validates the Construction API implementation. It also verifies transaction construction, signing, and submissions to the `testnet` network. * `mesh-cli check:data --configuration-file mesh-cli-conf/mainnet/config.json` - This command validates that the Data API implementation is correct, using the bitcoin `mainnet` node. It also ensures that the implementation does not miss any balance-changing operations. -Read the [How to Test your Mesh Implementation](https://www.mesh-api.org/docs/mesh_test.html) documentation for additional details. +Read the [How to Test your Mesh Implementation](https://docs.cdp.coinbase.com/mesh/docs/mesh-test/) documentation for additional details. ## Contributing @@ -231,24 +225,12 @@ You may contribute to the `mesh-sdk-go` project in various ways: Read our [Contributing](CONTRIBUTING.MD) documentation for more information. -When you've finished an implementation for a blockchain, share your work in the [ecosystem category of the community site](https://community.mesh-api.org/c/ecosystem). Platforms looking for implementations for certain blockchains will be monitoring this section of the website for high-quality implementations they can use for integration. Make sure that your implementation meets the [expectations](https://www.mesh-api.org/docs/node_deployment.html) of any implementation. - ## Documentation -You can find the Mesh API documentation at [mesh-api.org](https://www.mesh-api.org/docs/welcome.html). - -Check out the [Getting Started](https://www.mesh-api.org/docs/getting_started.html) section to start diving into Mesh. +You can find the Mesh API documentation [here](https://docs.cdp.coinbase.com/mesh/docs/api-reference/). -Our documentation is divided into the following sections: - -* [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) -* [Samples](https://www.mesh-api.org/docs/reference-implementations.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) +Check out the [Getting Started](https://docs.cdp.coinbase.com/mesh/docs/getting-started/) section to start diving into Mesh. ## Related Projects @@ -261,7 +243,7 @@ Our documentation is divided into the following sections: To help you with examples, we developed complete Mesh API sample 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 implementation samples than to write an implementation from scratch. -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. +You can also find community implementations for a variety of blockchains in the [mesh-ecosystem](https://github.com/coinbase/mesh-ecosystem) repository. ## License This project is available open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).