Packages • Development • Docs • Contributing • Security • License
The Graph is an indexing protocol for querying networks like Ethereum, IPFS, Polygon, and other blockchains. Anyone can build and Publish open APIs, called subgraphs, making data easily accessible.
This repository is a Yarn workspaces monorepo containing the following packages:
| Package | Latest version | Description |
|---|---|---|
| contracts |  |
Contracts enabling the open and permissionless decentralized network known as The Graph protocol. |
| sdk |  |
TypeScript based SDK to interact with the protocol contracts |
To set up this project you'll need git and yarn installed. Note that Yarn v4 is required to install the dependencies and build the project.
From your command line:
# Enable Yarn v4
corepack enable
yarn set version stable
# Clone this repository
$ git clone https://github.com/graphprotocol/contracts
# Go into the repository
$ cd contracts
# Install dependencies
$ yarn
# Build projects
$ yarn buildTo version a package, run the following command from the root of the repository:
# Change directory to the package you want to version
$ cd packages/<package-name>
# Bump the version
$ yarn version <major|minor|patch>Note on cross referenced packages: Bumping the version of a package that is cross referenced by another package will automatically bump the dependency version in the other package. For example, if you bump the version of sdk from 0.0.1 to 0.0.2, the required version of sdk in the contracts package will automatically be bumped to 0.0.2. Depending on the nature of the change you might need to bump (and publish) a new version of the contracts package as well.
Packages are published and distributed via NPM. To publish a package, run the following command from the root of the repository:
# Publish the package
$ yarn npm publish --access public --tag <tag>Alternatively, there is a GitHub action that can be manually triggered to publish a package.
Coming soon
For now, each package has its own README with more specific documentation you can check out.
Contributions are welcomed and encouraged! You can do so by:
- Creating an issue
- Opening a PR
If you are opening a PR, it is a good idea to first go to The Graph Discord or The Graph Forum and discuss your idea! Discussions on the forum or Discord are another great way to contribute.
If you find a bug or security issue please go through the official channel, The Graph Security Bounties on Immunefi. Responsible disclosure procedures must be followed to receive bounties.
Copyright © 2021 The Graph Foundation
Licensed under GPL license.