README
¶
PATH
Path API & Toolkit Harness
Overview
PATH (Path API & Toolkit Harness) is an open source framework for enabling access to a decentralized supply network. It provides various tools and libraries to streamline the integration and interaction with decentralized protocols.
This repo is maintained by the Pocket Network community, and is used to service the free Public RPC endpoints. The backend and portal should be considered opinionated examples of interfacing with the Pocket Network protocol. You are welcome to fork and remix however you like.
Documentation
The source code for the documentation is available in the docs directory.
Support
For Bug Reports and Enhancement Requests, please open an Issue.
Portal DB
The portal DB is the source of truth for running a SaaS using PATH to deploy RPC endpoints and related services.
See the following docs for more information:
License
This project is licensed under the MIT License; see the LICENSE file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package gateway implements components for operating a gateway service.
|
Package gateway implements components for operating a gateway service. |
|
package message defines the terminology required for sharing data between multiple PATH instances.
|
package message defines the terminology required for sharing data between multiple PATH instances. |
|
qos
package qos provides the functionality required for messaging (seriliaizing, sharing, etc...) QoS data between multiple PATH instances.
|
package qos provides the functionality required for messaging (seriliaizing, sharing, etc...) QoS data between multiple PATH instances. |
|
package metrics provides functionality for metrics collection and export via Grafana As of PR #72, it uses Grafana as the metrics exporting system.
|
package metrics provides functionality for metrics collection and export via Grafana As of PR #72, it uses Grafana as the metrics exporting system. |
|
protocol
Package protocol handles exporting of all protocol-related observation based metrics.
|
Package protocol handles exporting of all protocol-related observation based metrics. |
|
protocol/shannon
Package shannon provides functionality for exporting Shannon protocol metrics to Prometheus.
|
Package shannon provides functionality for exporting Shannon protocol metrics to Prometheus. |
|
qos
Package qos handles exporting of all qos-related metrics.
|
Package qos handles exporting of all qos-related metrics. |
|
reputation
Package reputation provides functionality for exporting reputation system metrics to Prometheus.
|
Package reputation provides functionality for exporting reputation system metrics to Prometheus. |
|
network
|
|
|
concurrency
Buffer Pool for High-Concurrency HTTP Processing ================================================
|
Buffer Pool for High-Concurrency HTTP Processing ================================================ |
|
package observation defines all the structures used to communicate all aspects of an observation by each component of PATH.
|
package observation defines all the structures used to communicate all aspects of an observation by each component of PATH. |
|
portal-db
|
|
|
sdk/go
module
|
|
|
The package protocol defines the basic concepts of any protocol that can be used by a gateway for serving user requests as relays.
|
The package protocol defines the basic concepts of any protocol that can be used by a gateway for serving user requests as relays. |
|
crypto
package crypto contains all the cryptographic functionality required by Shannon.
|
package crypto contains all the cryptographic functionality required by Shannon. |
|
noop
package noop implements a noop QoS module, enabling a gateway operator to support services which do not yet have a QoS implementation.
|
package noop implements a noop QoS module, enabling a gateway operator to support services which do not yet have a QoS implementation. |
|
solana
solana package provides the support required for interacting with the Solana blockchain through the gateway.
|
solana package provides the support required for interacting with the Solana blockchain through the gateway. |
|
Package reputation provides endpoint reputation tracking and scoring.
|
Package reputation provides endpoint reputation tracking and scoring. |
|
storage
Package storage provides storage backend implementations for reputation scores.
|
Package storage provides storage backend implementations for reputation scores. |
|
Request package is responsible for parsing and forwarding user requests.
|
Request package is responsible for parsing and forwarding user requests. |
Click to show internal directories.
Click to hide internal directories.