Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/centrifuge/pod

Go implementation of Centrifuge POD (Private Off-chain Data) node
https://github.com/centrifuge/pod

centrifuge ethereum fintech golang supply-chain

Last synced: about 1 month ago
JSON representation

Go implementation of Centrifuge POD (Private Off-chain Data) node

Host: GitHub
URL: https://github.com/centrifuge/pod
Owner: centrifuge
License: mit
Created: 2018-01-18T01:11:23.000Z (almost 7 years ago)
Default Branch: main
Last Pushed: 2024-04-10T15:26:32.000Z (9 months ago)
Last Synced: 2024-06-20T14:29:44.898Z (7 months ago)
Topics: centrifuge, ethereum, fintech, golang, supply-chain
Language: Go
Homepage: https://docs.centrifuge.io/build/p2p-node/
Size: 18.1 MB
Stars: 76
Watchers: 16
Forks: 39
Open Issues: 74
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Centrifuge POD (P2P Node)

[![Tests](https://github.com/centrifuge/pod/actions/workflows/tests.yml/badge.svg?branch=develop)](https://github.com/centrifuge/pod/actions/workflows/tests.yml)

[![GoDoc Reference](https://godoc.org/github.com/centrifuge/pod?status.svg)](https://godoc.org/github.com/centrifuge/pod)

[![codecov](https://codecov.io/gh/centrifuge/pod/branch/main/graph/badge.svg)](https://codecov.io/gh/centrifuge/pod)

[![Go Report Card](https://goreportcard.com/badge/github.com/centrifuge/pod)](https://goreportcard.com/report/github.com/centrifuge/pod)

This repository contains the Go implementation of the Centrifuge POD (Private Off-chain Data) protocol. It connects to other nodes via libp2p and uses [Centrifuge Chain](https://github.com/centrifuge/centrifuge-chain) for on-chain interactions.

**Getting help:** Head over to our documentation at [docs.centrifuge.io](http://docs.centrifuge.io) to learn how to setup a node and interact with it. If you have any questions, feel free to join our [discord](https://centrifuge.io/discord)

## Pre-requisites

- Go >= 1.18.x

- Node: 10.15.1

- Npm: 6.xx

- Truffle 5.1.29

- jq(https://stedolan.github.io/jq/)

- flock

## Fetch dependencies

To fetch the dependencies, run `make install-deps`.

## Install Node

To install, run `make install` will compile project to binary `centrifuge` and be placed under `GOBIN`.

Ensure `GOBIN` is under `PATH` to call the binary globally.

## Running tests

There 4 different flavours of tests in the project

- Unit tests(unit)

- Integration tests(integration)

- Environment tests(testworld): spins up multiple PODs and local ethereum and centrifuge chains

To run all the tests:

- `make run-unit-tests`

- `make run-integration-tests`

- `make run-testworld-tests`

## Deploying locally

If you like to deploy all the dependencies including node, please follow below steps

### Create config file and Start centrifuge node locally:

To start centrifuge node locally, follow the steps below:

- Start the local test environment

- Run `make start-local-node`

  - This will start a local centrifuge node and create a config if not present already

  - The default config file will be placed under `~/centrifuge/testing`.

  - If you like to recreate config, then run `recreate_config=true make start-local-node`

## API definitions

Node APIs are published to swagger hub.

For the latest APIs, please see here: [APIs](https://app.swaggerhub.com/apis/centrifuge.io/cent-node/)