ONEST Starter Pack
  • Introduction
    • ONEST- Focus Areas
    • Core Principles
    • Roles You Can Play
  • Join the network
  • Network Observability
    • Introduction
    • Telemetry Implementation
    • Transaction Dashboard
  • Learn
    • Beckn Protocol - Video Library
      • Chapter 1: Open Networks as a Digital Marketplace
      • Chapter 2: Beckn – An open protocol for decentralized commerce
      • Chapter 3: Beckn Ecosystem Architecture
      • Chapter 4: Specification and Support Layer
      • Chapter 5: Transaction Layer
      • Chapter 6: Implementing Beckn Protocol
      • Chapter 7: Network Topologies
      • Chapter 8: Beckn API Overview
      • Chapter 9: Example of a Retail Transaction
      • Chapter 10: Example of a Logistics Transaction
      • Chapter 11: Example of a Transaction using Interactive UI
    • Getting started on DSEP - Video Library
      • Chapter 1: Understanding Challenges in the Ecosystem
      • Chapter 2: Open Networks for Skilling and Education
      • Chapter 3: DSEP Overview
      • Chapter 4: DSEP Specification and Network Architecture
      • Chapter 5: DSEP APIs
      • Chapter 6: DSEP Schema
      • Courses and Training Transaction Workflow
      • Mentorships and Coaching Transaction Workflow
      • Scholarships and Grants Transaction Workflow
      • Internships and Jobs Transaction Workflow
    • Reference Implementation Guides
      • Financial Support (DSEP 1.0)
      • Skilling Experience (DSEP 1.0)
        • Course with scholarship
      • Work Opportunities (DSEP 2.0)
      • Suggested Form Structure for xInput
    • Understanding the APIs
    • Developing the APIs
      • Work Opportunities (DSEP 2.0)
      • Financial support, Skilling (DSEP 1.0)
    • Integration of Adaptors
      • Protocol Server
        • Introduction & Features
        • Architecture
        • Installation
        • Testing
        • Generate Keys
        • Local Tunnelling and Nginx Setup
        • FAQs
      • Job Manager
      • Profile Manager
      • AI Matching Engine
  • Community
    • Contribution Guide
    • Discussion Forum
    • Cohort calls
    • Issues Board
  • HELP
    • FAQs
Powered by GitBook
On this page
  • Setup Videos
  • Pre-requisites
  • Infra Requirements:
  • Installation

Was this helpful?

Edit on GitHub
  1. Learn
  2. Integration of Adaptors
  3. Protocol Server

Installation

Last updated 9 months ago

Was this helpful?

Setup Videos

Mode
Video Link

BAP Mode Setup

BAP Mode Testing

BPP Mode Setup

BPP Mode Testing

Pre-requisites

  • Docker version 20.10 or above ()

Infra Requirements:

2 CPU, 8GB RAM - Ubuntu

Installation

  1. Go to the root path (~/) in your system and clone this .

git clone https://github.com/ONEST-Network/protocol-server.git
cd protocol-server
git checkout master
  1. Run below command to configuration, docker, shell scripts files to root(`~/`) path. Following are the file that will be copied: deploy-bap.sh, deploy-bpp.sh, default-bap-client.yml, default-bap-network.yml, default-bpp-client.yml, default-bpp-network.yml, docker_data/docker_compose.yaml

bash setup.sh
  1. Go to docker_data directory and run docker command.

cd ~/protocol-server/docker
docker-compose up -d
  1. If sandbox registration is not done, Follow the steps Generate Keys to generate key pairs that will be used in registry entry and follow Join the networkto register.

  2. Update the client and network server configuration by following below setups:

For BAP:

  • In the BAP Client and BAP Network codebases, update the ~/default-bap-client.yml and ~/default-bap-network.yml file with the following values:

    • Private Key: Copy the private key of your participant.

    • Public Key: Copy the public key of your participant.

    • Use the Registry lookup API to get the subscriber id, subscriber url and unique key .

      curl --location 'https://sandbox.onest.network/onest/lookup' \
      --header 'Content-Type: application/json' \
      --data '{
          "country": "IND",
          "type":"BAP"
      }'

    • Subscriber ID: Get using registry lookup API

    • Subscriber URI: Get using registry lookup API

    • Unique Key: Get using registry lookup API

    • Registry URL: https://sandbox.onest.network/onest

For BPP:

  • In the BPP Client and BPP Network codebases, update the ~/default-bpp-client.yml and ~/default-bpp-network.yml file with the following values:

    • Private Key: Copy the private key of your participant.

    • Public Key: Copy the public key of your participant.

    • Use the Registry lookup API to get the subscriber id, subscriber url and unique key.

      curl --location 'https://sandbox.onest.network/onest/lookup' \
      --header 'Content-Type: application/json' \
      --data '{
          "country": "IND",
          "type":"BPP"
      }'

    • Subscriber ID: Get using registry lookup API

    • Subscriber URI: Get using registry lookup API

    • Unique Key: Get using registry lookup API

    • Registry URL: https://sandbox.onest.network/onest

    • Webhook URL: The endpoint URL of your service the hosts protocol APIs like search, on_search etc.

  1. After making the changes in configuration files, run the below commands to create bap/bpp client and network docker containers:

  • Execute ./deploy-bap.sh file to deploy the BAP Client and Network.

  • Execute ./deploy-bpp.sh file to deploy the BPP Client and Network.

  1. Test the protocol server by following the steps in Testingsection.

For PM2 Deployment

For PM2 deployment you need to git clone protocol-server four times to setup the BAP Client and Network and BPP Client and Network. Then copy ~/default-bap-client.yml and ~/default-bap-network.yml to config directory in respective git clone directory of BAP Client and Network. Also copy ~/default-bpp-client.yml and ~/default-bpp-network.yml to config directory in respective git clone directory of BPP Client and Network.

After configuration, Protocol Server can be run as below.

To run the instance in Development Mode (For Debug Purposes):

npm run dev

To run the instance in Production Mode:

npm i -g pm2
pm2 start ecosystem.config.js

setup guide
repository
https://www.loom.com/share/daec8556ddb74a65a893fd67d862b805?sid=fb24a0af-49a3-4c66-bf5a-e0a16389b8f1
https://www.loom.com/share/0cda9a05ab824ce288a82319155377f3?sid=339a4707-b4bb-43ff-81ba-d6e047d62945
https://www.loom.com/share/b320e436e5c04a529f1133a4f1f42c0a?sid=cc0e5fe7-95ba-41c2-9729-7b41c8328f4d
https://www.loom.com/share/37311b91bef747959a59420612a64a68?sid=df35c0cc-703d-4852-b87e-df7a690eea8e