README
PATH
Path API & Toolkit Harness

🚧 This documentation is still under construction 🚧
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.
Getting Started
PATH
Start by going through the PATH Walkthrough. to learn how PATH works, how to configure it and how to run it locally.
Envoy
Start by going through the Envoy Walkthrough. to learn how our Envoy integration works, how to configure it and how to run it locally.
Is PATH for me?
If you're a Web2 Gateway Provider, you have four modes of operation to choose from:
-
Dependent (Step Aside): Let clients use Grove's Portal directly. For example, if you do not provide the services the customer is looking for.
-
Grove Hybrid (Frontend): Provide a custom front-end experience and build your own gateway infrastructure but leverage Grove's Portal API behind the scenes. For example, if you want want to build your own business logic around quality-of-service, load balancing, authentication as well as building your own front-end.
-
PATH Hybrid (Full Stack): Use
PATH
so you can provide the client with a customized end-to-end experience but also settle traffic onPocket Network
yourself without relying onGrove
's infrastructure at all. -
Independent (On Your Own): Use your own stack to settle traffic on your own infrastructure, independent of
Grove
,PATH
orPocket Network
.
Here's the information reorganized into a table and nodes section:
Implementation Mode Comparison
If you're a Web2 Gateway Provider, you can use this table to understand you preferable mode of operation:
Mode | Your Backend Infrastructure | Your Gateway Frontend | Your Gateway uses PATH | Customer uses Grove's Portal | Traffic Settled on Pocket Network | Description / Example |
---|---|---|---|---|---|---|
1. Dependent (Step Aside) |