Skip to main content

README

PATH
Path API & Toolkit Harness

Grove logo

warning

🚧 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:

  1. Dependent (Step Aside): Let clients use Grove's Portal directly. For example, if you do not provide the services the customer is looking for.

  2. 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.

  3. PATH Hybrid (Full Stack): Use PATH so you can provide the client with a customized end-to-end experience but also settle traffic on Pocket Network yourself without relying on Grove's infrastructure at all.

  4. Independent (On Your Own): Use your own stack to settle traffic on your own infrastructure, independent of Grove, PATH or Pocket 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:

ModeYour Backend InfrastructureYour Gateway FrontendYour Gateway uses PATHCustomer uses Grove's PortalTraffic Settled on Pocket NetworkDescription / Example
1. Dependent (Step Aside)Customers go to Grove's Portal for direct access
2. Grove Hybrid (Frontend)Customers go to your frontend but use Grove's Portal API backend behind the scenes
3. PATH Hybrid (Full Stack)Customers go to your frontend but use PATH's features (e.g. Quality-of Service) and settle traffic on Pocket network directly
4. Independent (On Your Own)Customers go to your frontend and dependent on your gateway and infrastructure across the whole stack