# grid

**Repository Path**: hyperledger/grid

## Basic Information

- **Project Name**: grid
- **Description**: Grid provides reference implementations of supply-chain-centric items – data types, data models, smart contracts, and more – that are anchored on existing open standards and industry best practices.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 16
- **Forks**: 0
- **Created**: 2021-07-27
- **Last Updated**: 2025-06-14

## Categories & Tags

**Categories**: blockchain

**Tags**: None

## README

# Hyperledger Grid

Hyperledger Grid [has moved](https://github.com/hyperledger/toc/issues/82) to [End of life status](https://toc.hyperledger.org/governing-documents/project-lifecycle.html#end-of-life).

## Previous content

Hyperledger Grid is a platform for building supply chain solutions that include
distributed ledger components. It provides a growing set of tools that
accelerate development for supply chain smart contracts and client interfaces.

This project is not an implementation of a distributed ledger or a client
application. Instead, Hyperledger Grid provides supply-chain-focused libraries,
data models, and software development kits (SDKs) as modular, reusable
components.

The Hyperledger Grid project includes several repositories:

- [This repository](https://github.com/hyperledger/grid) contains core
  components such as supply-chain-centric data types and smart permissioning
  code.

- The [grid-contrib](https://github.com/hyperledger/grid-contrib) repository
  contains example domain models and reference implementations for smart
  contracts (also called "transaction families").

- The [grid-rfcs](https://github.com/hyperledger/grid-rfcs) repository
  contains RFCs (requests for comments) for proposed and approved changes to
  Hyperledger Grid.

- The [grid-docs](https://github.com/hyperledger/grid-docs) repository
  contains the source files for the Grid documentation and website
  hosted at [grid.hyperledger.com](https://grid.hyperledger.org).

## Project Status

Hyperledger Grid is currently in the
[incubation](https://tsc.hyperledger.org/project-lifecycle.html)
stage of the Hyperledger product lifecycle.
The [Hyperledger Grid
proposal](https://docs.google.com/document/d/1b6ES0bKUK30E2iZizy3vjVEhPn7IvsW5buDo7nFXBE0/)
was accepted in December, 2018.


## How to Participate

We welcome contributors, both organizations and individuals, to help shape
project direction, contribute ideas, provide use cases, and work on specific
tools and examples. Please [join the
discussion](https://grid.hyperledger.org/community/join_the_discussion.html).

## Building Grid

Grid is built using latest stable [rust](https://www.rust-lang.org/), which
you should install via [rustup](https://rustup.rs/).

To install the remaining dependencies using a package manager, run one of the
following commands.

Homebrew (OS X):
```bash
brew install openssl zeromq pkg-config protobuf libpq
```

APT (Ubuntu):
```bash
apt install \
    build-essential \
    pkg-config \
    libssl-dev \
    protobuf-compiler \
    libsqlite3-dev \
    libpq-dev \
    libsasl2-dev \
    libxml2-dev \
    libzmq3-dev \
    openssl
```

Once you have the prerequisites installed, run `cargo build` from the root
directory. This command builds all of the Grid components, including `gridd`
(the grid daemon), the CLI, and all of the smart contracts in the `contracts`
directory.

To build individual components, run `cargo build` in the component directories.
For example, to build only the grid-cli, navigate to `cli`, then run
`cargo build`.

### Building with Docker

To build Grid using Docker, run `docker-compose build` from the root directory.
This command builds Docker images for all of the Grid components, including
`gridd` (the grid daemon), the CLI, and all of the smart contracts in the
`contracts` directory.

To build individual components using Docker, run
`docker-compose build <component>` from the root directory. For example, to
build only the grid-cli, run `docker-compose build grid-cli`.

To use Docker to build Grid with experimental features enabled, set an
environment variable in your shell before running the build commands. For
example: `export 'CARGO_ARGS= --features experimental'`. To go back to
building with default features, unset the environment variable:
`unset CARGO_ARGS`

## More Information

- [Hyperledger Grid website](https://grid.hyperledger.org)
- [Documentation](https://grid.hyperledger.org/docs/)
- [Hyperledger Grid mailing list](https://lists.hyperledger.org/g/grid)
- [#grid discussion channel](https://chat.hyperledger.org/channel/grid)
- [Hyperledger Grid project overview](https://www.hyperledger.org/projects/grid)
  at [hyperledger.org](https://www.hyperledger.org)


## License

Hyperledger Grid software is licensed under the [Apache License Version
2.0](LICENSE) software license.

The Hyperledger Grid documentation in the
[grid-docs](https://github.com/hyperledger/grid-docs) repository is licensed
under a Creative Commons Attribution 4.0 International License (CC BY 4.0).
You may obtain a copy of the license at
<http://creativecommons.org/licenses/by/4.0/>.