{"id":13512383,"url":"https://github.com/coinbase/mesh-specifications","last_synced_at":"2025-04-05T02:12:00.968Z","repository":{"id":39028437,"uuid":"259654517","full_name":"coinbase/mesh-specifications","owner":"coinbase","description":"Specification files for the Mesh Blockchain Standard","archived":false,"fork":false,"pushed_at":"2024-07-09T22:19:25.000Z","size":492,"stargazers_count":329,"open_issues_count":11,"forks_count":96,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-03-29T01:13:15.216Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coinbase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-28T14:06:01.000Z","updated_at":"2025-03-28T20:43:30.000Z","dependencies_parsed_at":"2024-06-12T22:22:59.189Z","dependency_job_id":"fd57f64d-ed83-452f-b1d3-634cab3db711","html_url":"https://github.com/coinbase/mesh-specifications","commit_stats":null,"previous_names":["coinbase/mesh-specifications"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinbase%2Fmesh-specifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinbase%2Fmesh-specifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinbase%2Fmesh-specifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coinbase%2Fmesh-specifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coinbase","download_url":"https://codeload.github.com/coinbase/mesh-specifications/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247276189,"owners_count":20912288,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T03:01:47.982Z","updated_at":"2025-04-05T02:12:00.946Z","avatar_url":"https://github.com/coinbase.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"\u003ch3 align=\"center\"\u003e\n   Mesh Specifications\n\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\nThis repository contains all specification files used to generate code for the Mesh API.\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\nBuild once. \nIntegrate your blockchain everywhere.\n\u003c/p\u003e\n\n## Overview\n\nMesh is an open-source specification and set of tools that makes integrating with blockchains simpler, faster, and more reliable. The Mesh API is specified in the [OpenAPI 3.0 format](https://www.openapis.org).\n\nRequests and responses can be crafted with auto-generated code using [Swagger Codegen](https://swagger.io/tools/swagger-codegen) or [OpenAPI Generator](https://openapi-generator.tech), are human-readable (easy to debug and understand), and can be used in servers and browsers.\n\n## Installation\n\nNo installation is required, as the repository only includes specification files.\n\n## Documentation\n\nYou can find the Mesh API documentation [here](https://docs.cdp.coinbase.com/mesh/docs/welcome/). \n\n\n## Contributing\n\nYou may contribute to the `mesh-specifications` project in various ways:\n\n* [Asking Questions](CONTRIBUTING.md/#asking-questions)\n* [Providing Feedback](CONTRIBUTING.md/#providing-feedback)\n* [Reporting Issues](CONTRIBUTING.md/#reporting-issues)\n\nRead our [Contributing](CONTRIBUTING.MD) documentation for more information.\n\n## Related Projects\n\n* [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.\n* [mesh-cli](https://github.com/coinbase/mesh-cli) — Use the `mesh-cli` tool to test your Mesh API implementation. The tool also provides the ability to look up block contents and account balances.\n\n### Reference Implementations\n\nTo 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.\n\nYou can also find community implementations for a variety of blockchains in the [mesh-ecosystem](https://github.com/coinbase/mesh-ecosystem) repository. \n\n## Specification Development\n\nWhile working on improvements to this repository, we recommend that you use these commands to check your code:\n\n* `make deps` to install dependencies\n* `make gen` to generate the specification files\n* `make check-valid` to ensure specification is valid\n* `make release` to check if code passes all tests run by CircleCI\n\n### Adding New CurveTypes or SignatureTypes\n\nUnlike the [Data API](https://docs.cdp.coinbase.com/mesh/docs/api-data/) where there are no global type constraints (e.g., you can specify any operation type), the [Construction API](https://docs.cdp.coinbase.com/mesh/docs/api-construction/) has a clearly enumerated list of supported curves and signatures. Each one of these items has a clearly specified format that all implementations should expect to receive.\n\nIf a curve or signature you are employing is not enumerated in the [specification](https://docs.cdp.coinbase.com/mesh/docs/api-reference/), you will need to open a PR against the specification to add it along with the standard format it will be represented in.\n\nIt is up to the caller of a Construction API implementation to implement key generation and signing for a particular [`CurveType:SignatureType`](https://docs.cdp.coinbase.com/mesh/docs/objects/#signature). There is a `keys` package in [mesh-sdk-go](https://github.com/coinbase/mesh-sdk-go) that is commonly used by callers and anyone in the community can implement additional schemes there.\n\n## License\n\nThis project is available open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).\n\n© 2022 Coinbase","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoinbase%2Fmesh-specifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoinbase%2Fmesh-specifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoinbase%2Fmesh-specifications/lists"}