LogoLogo
PAO DocsCommunity DocsInfrastructure DocsPeerplays.com
  • Developer Documentation
  • API Reference
    • Peerplays Core API
      • Popular API Calls
      • Account History
      • Asset API
      • Block API
      • Crypto API
      • Database API
      • Network Broadcast API
      • Network Nodes API
      • Orders API
    • Wallet API
      • Account Calls
      • Asset Calls
      • Blockchain Inspection
      • General Calls
      • Governance
      • Privacy Mode
      • Trading Calls
      • Transaction Builder
      • Wallet Calls
    • Bookie API
      • General Calls
      • Listeners
      • Tournaments
  • Peerplays API Libraries
    • Python Peerplays
      • Installation
      • Creating an Account
      • Creating a Peerplays Wallet
      • NFT API
      • Marketplace API
      • Role Based Permissions API
  • Development Guides
    • Creating User Issued Assets
    • Introduction to Permissions
    • NFT Minting
    • Calculating Costs
  • The Cookbook
    • NFTs for Staking Creator Tokens
  • Tools and Integrations
    • PeerID
      • 1.0.0
        • Infrastructure
          • Deployment on a Linux Serve
          • Deployment to AWS ECS
            • Building the Docker Images
            • Storing Secrets in Amazon Parameter Store to use in ECS
            • Creating the Task Definition
            • Creating the Cluster
            • Creating the Service
        • Development
          • How does PeerID work without storing the keys ?
          • Authentication with PeerID
          • Brain Storming
          • Software Requirements
      • Authentication with PeerID
      • Requirements Specification
    • Random Number Generator
      • RNG Technical Summary
      • RNG API
  • Supporting & Reference Docs
    • Peerplays Development FAQs
    • Sidechain Operator Node (SON) Development
      • Generic Sidechain Docs
        • Quick joining GLADIATOR
        • Changes to Peerplaysjs-lib
        • Requirements Specification
        • Low Level Designs
          • bitcoin-deposit-handling-lld
          • bitcoin-operations-draft
          • bitcoin-sidechain-handler-lld
          • bitcoin-sidechain-multisig-bitcoin-wallet-and-bitcoin-addresses-pw
          • bitcoin-withdrawal-handling-lld
          • btc-address-scripting-mechanism
          • comparison-between-scenarios-for-handling-deposits-and-withdrawals
          • exchange-rate-list
          • generic-sidechain-deposit-hld
          • generic-sidechain-high-level-design
          • generic-sidechain-listener-hld
          • generic-sidechain-withdrawal-hld
          • refund-btc-mechanism
          • son-configuration
          • son-consensus-communication-and-transaction-signing-on-chain-lld
          • son-de-register-proposals-lld
          • son-objects-and-operators
          • son-rewards-lld
          • son-voting-lld
          • son-wallet-list_sons-lld
          • creation of a multi-sig bitcoin address lld
          • claiming initial son vesting lld
          • changeover and SON maintenance scenarios lld
          • user-sidechain-addresses-mapping
          • wallet-commands-for-son
        • Functional Specs
          • SON Configuration
          • SON rewards
          • SON Voting and Consensus
          • SONs switchover scenarios
          • SON Status Operations & Monitoring
          • Proposals
          • SON Smart Contracts
      • Bitcoin Sidechain Docs
        • Functional Specs
          • btc-refunds
          • voting-and-consensus
          • son-switchover
          • son-rewards
          • son-proposals
          • son-configuration
          • heartbeat-monitoring
          • BTC Transaction Processing & Signing
          • Bitcoin Withdrawal Handling
          • Bitcoin Deposit Handling
          • SON Multisig Bitcoin Wallet
      • Hive Sidechain Docs
        • Functional Specs
          • HIVE Deposit Handling
          • HIVE Withdrawal Handling
    • Peerplays DEX Development
      • Peerplays NEX
        • Functional Specifications
          • NEX-FS01 Dashboard Page
            • NEX-FS12 ETH-SONs Deposit/Withdraw Functionality
          • NEX-FS02 Login and Account Creation
          • NEX-FS03 Menus and Nav
          • NEX-FS04 Notifications
          • NEX-FS05a Market Page (alpha)
          • NEX-FS05 Market Page
          • NEX-FS06 Profile Page
          • NEX-FS07 Wallet Functions
          • NEX-FS08 App Settings
          • NEX-FS09 Blockchain Page
          • NEX-FS10 GPOS Page
          • NEX-FS11 WhaleVault Integration
      • Requirements Specification
      • Functional Specs
        • Asset Info Page and Asset Lists
        • Dashboard
        • Exchange Page
        • Login and Account Creation
        • User Account Page
        • Voting Page
    • SPK Network
      • Functional Specs
        • Claimdrop Snapshot Functional Specification
        • Initial Claimdrop Functional Specification
    • NFT Development
      • NFT Store
        • NFT Store User Stories
        • NFT Store UI HLD
        • NFT Store Requirements Specification
        • Functional Specifications
          • APP-FS01 App Header
          • APP-FS02 App Body
          • APP-FS03 App Footer
          • APP-FS04 App Navigation
          • APP-FS05 Wallet Functions
          • APP-FS06 App Home Page
          • APP-FS07 Account Page
          • APP-FS08 Browse View
        • App Page List
        • Requirement Traceability Matrix
    • Operation IDs List
    • Sidechain Flow Diagram (HIVE coin)
    • Sidechain Flow Diagram (Bitcoin)
    • Sidechain Flow Diagram (Ethereum coin)
    • TradeHands Explorer
      • User Personas
      • User stories
      • APP-FS01 Detailed View
      • Draft: APP-FS02 Front Page
      • APP-FS03 Collection Details Page
    • Grafana
      • Grafana Installation
      • Install Grafana Behind reverse proxy
      • Loki Installation
      • Promtail agent Installation
      • Grafana Explorer
    • NEX Deployment & Configuration
      • NEX Deployment
      • NEX - Blockchain API configuration
      • Deploying NEX in a HA scenario
    • API Node
      • MarketCap API
    • TOTO Application
      • FS-Subscription Plan
      • FS-Achievements
  • Development Workflow Docs
    • Development Workflow
  • Other Documentation
    • Peerplays Home
    • Community Docs
    • Infrastructure Docs
    • Site Reliability Engineering
Powered by GitBook
On this page
  • Introduction
  • API Categories
  • Features
  • Configuration
  • 1. Hardware Requirement
  • A. Peerplays Mainnet
  • B. Peerplays Testnet
  • 2. Update the config.ini file
  • 3. Start the node
  • Peerplays API nodes

Was this helpful?

Export as PDF
  1. Supporting & Reference Docs

API Node

Introduction

The API node is the node with the open RPC port. They provide a gateway to blockchain function by exposing the API. It is the Application Programming interface to interact with the blockchain. The main purpose of the API node is to provide data and functionality of any desired information.

API Categories

  1. Blockchain API - To query blockchain data such as accounts, assets, trading history, etc., It doesn't require private keys to access the information

  2. CLI Wallet API - The private keys are required to interact with the blockchain with new transaction.

Features

  • The API node runs on the Peerplays core software.

  • It keep tracks of the node state.

  • The API node is involved in the P2P communication with the nodes that are sharing the block transaction.

  • API ports helps the client to view the function of the node.

  • The public facing API node needs more RAM as the data retrieval and storage will be on large scale.

  • API node is different that the block producer as the API node functionality is only to return requested data about the node for client.

  • API node is the public window to access the details.

Configuration

The public API node can be configured by modifying the rpc-endpoint details on the witness node. Below are requirements to configure a API on the witness node,

1. Hardware Requirement

The hardware requirements for installing and operating the API node is given below

A. Peerplays Mainnet

The following detail explain the minimum requirements for running a Peerplays API node on Mainnet:

Node Type

CPU

Storage

Bandwidth

OS

API (Full)

1 Cores

4GB

100GB SSD

1Gbps

Ubuntu 20.04

B. Peerplays Testnet

The following detail what should be considered the minimum requirements for running a API node on Testnet:

Node Type

CPU

Storage

Bandwidth

OS

API (Full)

4 Cores

8GB

50GB SSD

1Gbps

Ubuntu 20.04

The prerequisites to run a RPC is to have a full node or a wallet running and listening to Port 8090, locally.

To make the node listen Port 8090, make the following changes in the config.ini file of any new/existing witness node.

2. Update the config.ini file

The value of existing rpc-endpoint should be update with the below input and restart the node to reflect the changes.

rpc-endpoint = 0.0.0.0:8090

Now, the node become a Full node and it will be available to read any API calls to provide the desired output.

The installation guide to install witness node is available in the below location,

3. Start the node

./witness_node

Peerplays API nodes

The list of Peerplays mainnet API node maintained as GitHub gist is mentioned below

const endpoints = [
    'wss://ca.peerplays.info/',
    'wss://de.peerplays.xyz/',
    'wss://pl.peerplays.org/',
    'ws://96.46.48.98:18090',
    'wss://peerplaysblockchain.net/mainnet/api',
    'ws://witness.serverpit.com:8090',
    'ws://api.i9networks.net.br:8090',
    'wss://node.mainnet.peerblock.trade'
];
PreviousDeploying NEX in a HA scenarioNextMarketCap API

Last updated 1 year ago

Was this helpful?

Memory

Memory

For all nodes: The memory requirements shown in the table above are adequate to operate the node. Building and installing the node from source code (as with the manual install) will require more memory. If the system memory is too low, there may be errors during the build and install process. See for more details. Using Docker or GitLab artifacts for installations don't have this limitation because they use pre-built binaries.

Installing vs Operating
⚠️
⚠️
LogoInstallation GuidesPeerplays Infrastructure Docs