LogoLogo
PAO DocsCommunity DocsDeveloper DocsPeerplays.com
  • Infrastructure Documentation
  • The Basics
    • Peerplays Node Types
    • Hardware Requirements
    • Obtaining private keys for cli_wallet
    • Using the CLI Wallet
      • CLI Wallet Fundamentals
      • CLI Commands for All Nodes
      • CLI Commands for Witnesses
      • CLI Commands for SONs
        • Updated CLI commands for SON voting
      • Deriving Keys using CLI Wallet
    • Auto-Starting a Node
    • Backup Servers
    • Obtaining Your First Tokens
    • Updating a Witness Node
    • How to create a Peerplays Account?
  • Advanced Topics
    • Private Testnets
      • Peerplays QA environment
      • Private Testnets - Manual Install
    • Reverse Proxy for Enabling SSL
    • Enabling Elasticsearch on a Node
    • Introduction to Faucet
  • Witnesses
    • What is a Witness node?
    • Installation Guides
      • Build and Install
      • Docker Install
      • GitLab Artifact Install
    • How to become a block producing witness?
    • Other Ways to configure a witness node
      • Peerplays API nodes & Installation Guide
      • Configuring Witness Node as Delayed Node
    • What's Next?
  • Sidechain Operator Nodes (SONs)
    • Installation Guides
      • Manual Install
      • Docker Install
      • SON Configuration - Version 1.5.19
      • SON configuration - Version 1.6.0
      • Bitcoin-SONs Sanity Checks
      • ETH-SONs Configuration & Installation
      • Existing SON node upgrade
  • Bookie Oracle Suite (BOS)
    • Introduction to BOS
    • BOS Installation
      • Installing MongoDB
      • Installing Redis
      • Configuration of bos-auto
      • Spinning Up bos-auto
    • BookieSports
      • Installing Bookiesports
      • Synchronizing BOS with BookieSports
      • BookieSports Module Contents
        • Sub Modules
      • Schema
      • Naming Scheme
    • Manual Intervention Tool (MINT)
      • Installing MINT
      • Introduction
  • DATA PROXIES
    • Introduction to Data Proxies
    • How Data Proxies Work
    • Data Proxy Set Up
  • COUCH POTATO
    • Installation
    • Functional Requirements
      • Flow Diagrams
      • Home Page
      • Create Account
      • Dashboard
        • Header
        • Sports Tabs
        • League Tabs
        • Calendar
        • Notifications
        • Replay
        • Account Menu
      • Game Selector
      • Change Password
    • Help
      • User Guide
        • Introduction
        • Home Page
        • Creating an Account
        • Dashboard
          • Replay
          • Account Menu
            • Change Password
        • Game Selector
    • Database
      • Schema
      • Objects
        • Tables
        • Views
    • API
      • Using the API
      • API Reference
        • Objects
        • Error Codes
      • BOS Schema
    • Proxy Payment Considerations
  • Other Documentation
    • Peerplays Home
    • Community Docs
    • Developer Docs
    • Site Reliability Engineering
Powered by GitBook
On this page
  • What is a Faucet?
  • What is the necessity of a Faucet?
  • Where does Faucet fit into the Peerplays infrastructure?
  • Who runs Faucet?
  • How to Install Faucet?
  • What are the features of Faucet?

Was this helpful?

Export as PDF
  1. Advanced Topics

Introduction to Faucet

What is a Faucet?

A faucet is an API service and associated blockchain account, controlled by an automated script, that listens for new account creation requests. As a response, the faucet will register a new account on the chain for the recipient. In some cases, the faucet might also send a small amount of token to the new account to cover the transaction fees or other needs.

What is the necessity of a Faucet?

  • A Faucet acts as a platform to allow any User to self-create an account even before they have funds to pay the fees for account creation.

  • A Faucet is significant in the process of onboarding new Users to the Peerplays blockchain and other related chains (Example: Testnet Chains).

Where does Faucet fit into the Peerplays infrastructure?

Any wallet or blockchain-connected application or service that offers its users free account registration will need to rely on a faucet. In order to request new account creation, the wallet or other blockchain-enabled application communicates with the Faucet API. The Faucet runs as an API endpoint to connect with the application. As the User's client software handles the Faucet, there is no necessity for the user to directly connect with Faucet.

Who runs Faucet?

  1. Anyone can run Faucet.

  2. PBSA runs faucet as public service to facilitate on-boarding requests.

  3. Private parties executing private business logic on-chain, who might want to run their own faucet exclusive to their users.

How to Install Faucet?

What are the features of Faucet?

  • Direct account creation

  • Fund transfer

  • Send PPY/token for account creation

PreviousEnabling Elasticsearch on a NodeNextWhat is a Witness node?

Last updated 2 years ago

Was this helpful?

PBSA maintains the Faucet installation guide. Click the below link to learn the steps in detail,

https://gitlab.com/PBSA/tools-libs/faucet