LiquidApps Documentation
  • Introduction
  • 🧙‍♂️The DAPP Network
    • The DAPP Token
      • DAPP Token Overview
      • DAPP Tokens Tracks
      • Claiming DAPP Tokens
      • DAPP Tokens Distribution
      • Air-HODL
    • Cross Chain Bridges
    • Examples
      • Token bridge
      • Price Feed
      • Elemental Battles
      • LiquidChess
      • LiquidPortfolio
    • DAPP Network Resources
      • @liquidapps/dapp-client
        • vRAM
        • LiquidAccounts
        • DAPP Services
        • Air-Hodl
      • eosio-push-guarantee
      • Link Library
        • EOSIO Link
          • Tables
          • Crons
          • Macros
          • Variables
        • EVM Link - Solidity (Coming Soon)
  • ⚡Working with Zeus
    • Introduction
      • Requirements
      • Install Zeus and Unboxing
        • More on zeus-box.json
      • Get Started fast! (Zeus-IDE)
      • Docker CI/CD
      • Example Github Using Zeus
      • Getting started with AntelopeIO Contracts (formerly EOSIO)
    • Zeus Basics
      • Compiling Contracts
        • Clean CMake Files
      • Unit Testing
        • Printing Console
        • Fetching Table
        • Helper Functions
        • Example
      • Create ...
        • Contract/Unit Test
          • All DAPP Network Services
        • DSP Service
        • Contract Deployment
      • Import/Export Keys
      • Migrate Contract
      • Start local environment
        • Kill Services
      • Upgrade
      • Zeus RC File
      • Zeus Config File
    • Zeus Box Basics
      • Zeus Boxes Directory
        • Services
          • Oracles
        • Sample Boxes
        • Other Boxes
          • DAPP Network
          • SDKs
            • ETH-SDK
            • EOS SDK
          • Frontends
          • Extensions
          • Tests
          • Seeds
          • Microservices
          • Meta Boxes
          • Libraries
          • Game
          • EOS Framework
          • Economics
          • Templates
      • Add/Remove
      • Deploy
      • List Boxes
  • ⚙️DAPP Network Services
    • DAPP Network Services
      • vRAM
        • Getting Started Guide
          • Compile and Deploy
          • Staking for services
          • Test
          • Basic implementation
        • Smart Contract Macros
          • dapp::multi_index
        • Tools
          • DAPP Client Integration
            • get_vram_row
          • Zeus Commands
          • Scripts
            • Get table
            • Get ordered keys
        • Additional Features
          • Save load and reset dapp::multi_index data
          • Advanced Features
      • LiquidAccounts
        • Getting Started Guide
          • Compile and Deploy
          • Staking for services
          • Test
            • DAPP Client
          • Basic Implementation
          • DAPP Account
        • Smart Contract Macros
          • payload
          • VACCOUNTS_APPLY
          • require_vaccount
          • VACCOUNTS_DELAYED_CLEANUP
        • Tools
          • DAPP Client Integration
            • push_liquid_account_transaction
          • Zeus Commands
            • Zeus vaccounts push-action
          • Scripts
            • Deserialize Payload
        • Use between contracts
        • Use Between Chains
      • LiquidHarmony
        • Getting Started Guide
          • Compile and Deploy
          • Staking for services
          • Test
          • Basic Implementation
          • API DSP Key Storage
        • Smart Contract Macros
          • geturi
          • ORACLE_HOOK_FILTER
        • Creating an Oracle Request
          • HTTP/HTTPS GET/POST JSON
            • HTTP/HTTPS GET
            • HTTP/HTTPS GET JSON
            • HTTP/HTTPS POST
            • HTTP/HTTPS POST JSON
          • ECHO GET/POST JSON
            • ECHO GET
            • ECHO GET JSON
            • ECHO POST
            • ECHO POST JSON
          • Nodeos History Get
          • Sister Chain Fetch
            • sister_chain_block
            • sister_chain_history
            • sister_chain_info
            • sister_chain_last_irreversible
            • sister_chain_table_row
          • Foreign Chain Fetch
            • ethereum
              • endpoints
              • block_number
              • history
              • balance
              • storage
            • tron
              • endpoints
              • balance
              • block_number
              • block
              • transactions
              • transaction
            • cardano
              • endpoints
              • blocks
              • history
              • state
            • ripple
              • endpoints
              • balance
              • ledger
              • transactions
            • bitcoin
              • endpoints
              • balance
              • block
              • history
              • transaction
            • litecoin
              • endpoints
              • balance
              • block
              • history
              • transaction
            • bitcoin cash
              • endpoints
              • balance
              • block
              • history
              • transaction
          • Wolfram Alpha
          • Random Number
          • Stockfish
          • SQL
        • Additional Features
          • Pre geturi hook
          • Don't spend CPU condition
      • LiquidScheduler
        • Getting Started Guide
          • Compile and Deploy
          • Staking for Services
          • Basic Implementation
        • Smart Contract Macros
          • schedule_timer
          • remove_timer
          • timer_callback
          • start_interval
          • remove_interval
        • Additional Features
          • Don't spend CPU condition
      • LiquidStorage
        • Getting Started Guide
          • Compile and Deploy
          • Staking for Services
          • Test
          • Basic Implementation
        • Tools
          • Zeus Commands
            • zeus storage upload
            • zeus storage unpin
          • DAPP Client Integration
            • get_uri
            • unpin_public_file
            • upload_archive_to_liquidstorage
            • upload_file_to_liquidstorage
            • upload_public_file_from_vaccount
        • Example GET Static Web Page
      • LiquidLink
        • Getting Started Guide
          • Compile and Deploy
          • Staking for services
          • Test
          • Basic Implementation
        • Smart Contract Macros
          • svc_sign_signtrx
      • LiquidAuth
        • Getting Started Guide
          • Compile and Deploy
          • Staking for services
          • Test
          • Basic Implementation
        • Tools
          • DAPP Client Integration
            • invokeAuthedCall
      • DAPP Service Macros
        • CONTRACT_START
        • CONTRACT_END
        • DAPPSERVICES_ACTIONS
        • DAPPSERVICE_ACTIONS_COMMANDS
      • Additional Services
      • Smart Contract Console Log Syntax
      • Using on_notify with services
    • Packages and Staking
  • 👨‍🚀DAPP Service Providers
    • Introduction to DAPP Service Providers
    • DSPs
      • Architecture Overview
      • Setup DSP
        • Blockchain Account
        • EOSIO Node
          • Firehose Setup
        • IPFS
          • Adding peers
            • Reconnecting Peers Periodically
          • Bootsrapping from an existing IPFS Cluster
          • Running a private network
        • PostgreSQL Database Backend
          • How to wipe local database
        • Ethereum Virtual Machine Node Setup
        • DSP Node
          • Logs
            • Monitor all logs script
        • Register Package
          • Modify Package metadata
          • Enable/Disable Package
          • Update cost per action in QUOTA
          • More on Packages
          • Whitelist Stakers
        • Test Setup
        • Known attack vectors
      • DSP Maintenance
        • Upgrade DSP Node
        • Claim Rewards
        • Replay Contract
        • Cleanup IPFS and Oracle Entries
        • Consumer Pays CPU Permissions
      • DSP API Endpoints
        • Event
        • Version
        • vRAM
        • LiquidLink
        • LiquidStorage
        • LiquidAccounts
  • 👨‍💻DAPP NETWORK LABS
    • Introduction
    • DAPP Workers
    • EdgeDSPs
    • EdgeOS
  • 🌉CROSS CHAIN BRIDGES
    • Getting Started with LiquidBridge
      • EOSIO.token <> EOSIO.token Fungible Tokens
      • EOSIO.token <> ERC20 Fungible Tokens
        • EOSIO Side Setup
        • EVM Side Setup
          • Setup EVM Contracts
            • Setup EVM Token Contract
              • Initialize Token and Transfer Ownership
            • Setup EVM Tokenpeg Contract
            • Verify and Publish Source Code
              • token contract and overview
              • tokenpeg contract
        • Initialize EOSIO Side
        • Test bridge
      • EOSIO <> EOSIO Atomic Assets Non-Fungible Tokens
      • EOSIO Atomic Assets <> ERC721 Non-Fungible Tokens
        • EOSIO Side Setup
        • EVM Side Setup
          • Setup EVM ERC721 Contract
          • Setup EVM Atomictokenpeg Contract
          • Transfer Ownership
          • Verify Source Code
        • Initialize EOSIO Side
        • Test bridge
      • EOSIO Atomic Assets <> ERC1155 Non-Fungible Tokens
        • EOSIO Side Setup
        • EVM Side Setup
          • Setup Proxy Contract
          • Setup EVM ERC1155 Contract
          • Setup EVM ERC1155 Tradeable Contract
          • Transfer Ownership of ERC1155 contract to atomictokenpeg1155 contract
        • Initialize EOSIO Side
        • Test bridge
  • ⛓️LiquidX Stake Across Chains
    • Getting Started with LiquidX
      • Use DAPP Network Services
        • Smart Contract Steps
        • Add DSP on New Chain
        • Map Mainnet to New Chain
        • Map New Chain to Mainnet
      • Become a DSP on another chain
        • Editing config.toml file
        • Push DSP account mapping action
      • Example Chains to Add
        • CoVax
        • WAX
        • WAX Test
        • Telos
        • Telos Test
        • BOS
      • Add a Chain to LiquidX
        • Create accounts and set dappservicex contract
        • Register chain
  • 😷COVAX
    • Getting Started with CoVax Chain
      • Become a DAPP Service Provider
      • Become a Block Producer
  • 🗂️Blockchain Guides
    • Testnet Creation Guides
      • Create Binance Smart Chain Testnet Account
        • Add Binance Smart Chain Testnet Network to Metamask
        • Create EVM keypair
        • Get faucet funds
      • Create WAX Testnet Account
      • Creating Jungle 3 account
      • Create Mumbai Testnet Account (Matic-Polygon)
        • Get faucet funds
      • Creating CryptoKylin Account
      • Create Rinkeby Testnet Account
        • Change Metamask network to Rinkeby
        • Get faucet funds
    • Governance Guides
      • How to submit a proposal
      • How the Proposal System Works
      • Governance Rewards
      • How to Propose an MSIG
      • Update dappservices contract by msig
      • Setup MSIG Telegram Bot
      • Governance Contracts
      • Governance Frontend
      • Propose Payment by Msig
  • 🗒️Release Notes
    • Latest
    • History
      • 2.0.8191
      • 2.0.7966
      • 2.0.7931
      • 2.1.7848
      • 2.0.7735
      • 2.0.7661
      • 2.0.7644
      • 2.0.7622
      • 2.1.7420
      • 2.1.7301
      • 2.1.7111
      • 2.0.6808
      • 2.0.5328
      • 2.0.4719
      • 2.0.4002
      • 2.0.3107
      • 2.0.2812
      • 2.0.2527
  • 🙋‍♀️FAQs
    • Frequently Asked Questions The DAPP Token
    • Frequently Asked Questions DAPP Service Providers (DSPs)
    • Frequently Asked Questions vRAM
Powered by GitBook
On this page
  • enabled
  • min_unstake_period
  • package_json_uri
  • quota

Was this helpful?

  1. DAPP Service Providers
  2. DSPs
  3. Setup DSP
  4. Register Package

More on Packages

A deeper dive into an example of a package being registered

PreviousUpdate cost per action in QUOTANextWhitelist Stakers

Last updated 4 years ago

Was this helpful?

DAPP Service providers register their package with the dappservices:regpkg command. Examples can be seen on the .

Below we can see the structure of a new package that is created.

{
   "newpackage": {
      # API endpoint the DSP is reachable at, default PORT 3115
      "api_endpoint": "https://node1.dappfund.io",
      # packages are disabled when created and require the dappservices:enablepkg command
      "enabled": 0,
      # id
      "id": 0,
      # minimum stake required to receive designated QUOTA per package period
      "min_stake_quantity": "10.0000 DAPP",
      # min time in seconds before a stake can be refunded
      "min_unstake_period": 3600,
      # package name, must be 1-12 characters a-z, eosio name format
      "package_id": "fairfund1",
      # url of DSP JSON file, similar to BP JSON
      "package_json_uri": "https://dappfund.io/dsp-package.json",
      # period in seconds where QUOTA refills to 100%, example has 1 day in seconds, each day user will have 1 QUOTA
      "package_period": 86400,
      # DSP account name
      "provider": "thedappfund1",
      # QUOTA to provide per package period, more on QUOTA below
      "quota": "1.0000 QUOTA",
      # service name, more on this and where to find this below
      "service": "stakeservice"
   }
}

The following go into more detail on the settings above.

enabled

min_unstake_period

The greater of this and the remaining time in thepackage_period is the total unstake time. For example if you are 12 hours into a 24 hour package period and the min_unstake_period is an hour, you have to wait 12 hours to refund your stake.

package_json_uri

This is the link to the package json information to be standardized and used by DAPP Service Provider portals.

{
    "name": "pricefeed5m",
    "description": "Price feed oracle 5 minute interval",
    "dsp_json_uri": "https://dsp_provider.io/dsp.json",
    "logo":{
      "logo_256":"https://....",
      "logo_1024":"https://....",
      "logo_svg":"https://...."
    },
    "apis" {
      "ipfs":"ipfs.dsp_provider.io",
      "dsp_api":"dsp.dsp_provider.io",
      "state_history":"state.dsp_provider.io",
      "hyperion":"hyperion.dsp_provider.io",
      "dfuse":"dfuse.dsp_provider.io",
      "dfuse_dgraphql":"dfuse.dsp_provider.io",
      "dfuse_fire_hose":"dfuse.dsp_provider.io",
      "dfuse_push_guarantee":"dfuse.dsp_provider.io"
    },
    "contacts" [],
    "locations":[
        {
          "name": "Atlantis",
          "country": "ATL",
          "latitude": 2.082652,
          "longitude": 1.781132
        }
    ]
}
{
  "dsp_account_name": "eosnationftw",
  "org": {
    "candidate_name": "EOS Nation",
    "website": "https://eosnation.io",
    "ownership_disclosure": "https://eosnation.io/ownership-disclosure",
    "code_of_conduct": "https://steemit.com/eos/@eosnation/eos-nation-roadmap-on-values-community-project-timeline-finances-and-transparency",
    "email": "info@eosnation.io",
    "github_user": [
      "deniscarriere",
      "matthewdarwin"
    ],
    "chain_resources": "https://snapshots.eosnation.io",
    "branding": {
      "logo_256": "https://eosnation.keybase.pub/logo_256.png",
      "logo_1024": "https://eosnation.keybase.pub/logo_1024.png",
      "logo_svg": "https://eosnation.keybase.pub/logo.svg"
    },
    "location": {
      "name": "Canada",
      "country": "CA",
      "latitude": 45.425532,
      "longitude": -75.700269
    },
    "social": {
      "medium": "eosnationbp",
      "hive": "eosnation",
      "steemit": "eosnation",
      "twitter": "EOS_Nation",
      "facebook": "groups/EOSNation",
      "github": "EOS-Nation",
      "telegram": "EOSNation",
      "youtube": "channel/UCXgAY9DyooykrubRXw3xK1g",
      "reddit": "EOSNation",
      "keybase": "eosnation",
      "wechat": "Eosnation"
    }
  },
  "nodes": [
    {
      "location": {
        "name": "Canada",
        "country": "CA",
        "latitude": 45.425532,
        "longitude": -75.700269
      },
      "node_type": "query",
      "features": [
        "chain-api",
        "account-query"
      ],
      "api_endpoint": "http://api.eosn.io",
      "ssl_endpoint": "https://api.eosn.io"
    },
    {
      "location": {
        "name": "Canada",
        "country": "CA",
        "latitude": 45.425532,
        "longitude": -75.700269
      },
      "node_type": "seed",
      "p2p_endpoint": "peer.eosn.io:9876"
    },
    {
      "location": {
        "name": "Canada",
        "country": "CA",
        "latitude": 45.425532,
        "longitude": -75.700269
      },
      "node_type": "producer"
    },
    {
      "location": {
        "name": "Canada",
        "country": "CA",
        "latitude": 45.425532,
        "longitude": -75.700269
      },
      "node_type": "query",
      "features": [
        "chain-api",
        "dfuse"
      ],
      "ssl_endpoint": "https://eos.dfuse.eosnation.io"
    },
    {
      "location": {
        "name": "Canada",
        "country": "CA",
        "latitude": 45.425532,
        "longitude": -75.700269
      },
      "node_type": "query",
      "features": [
        "firehose"
      ],
      "ssl_endpoint": "https://eos.firehose.eosnation.io"
    }
  ]
}

quota

Each DSP service action, fetching a vRAM table row, performing an oracle request, scheduling a re-occurring action, each of these are examples where by default 0.0001 QUOTA is used. Let's show

service

{
    # this is the short name for the service, used in zeus commands
    "name": "oracle",
    # port service runs on
    "port": 13112,
    # alternative port to run on
    "alt": 26224,
    # this is what needs to be used for the "service" field when registering a package
    # this is also the contract that hosts the service and is included on usage billing
    "contract": "oracleservic",
    # pretty name of the service
    "prettyName": "LiquidHarmony",
    # wip,poc,beta,alpha
    "stage": "Beta",
    "version": "0.9",
    "description": "Web/IBC/XIBC/VCPU/SQL Services",
    # list of commands callable for the service
    "commands": {
        # main oracle calling function, all actions preceded with x (xgeturi)
        "geturi": {
            # if true, blocking will treat the command as a synchronous event
            # if false it will be treated as an asynchonous event
            "blocking": true,
            # broadcast to other DSPs being staked to by the consumer
            # triggers a promise.allSettled which awaits each DSPs response or timeout
            "broadcast": true,
            # specifies requested parameter for action
            "request": {
                "uri": "std::vector<char>"
            },
            # specifies callback response
            "callback": {
                "size": "uint32_t",
                "uri": "std::vector<char>",
                "data": "std::vector<char>"
            },
            # specify what data is required to signal a DSP to responsd to 
            "signal": {
                "size": "uint32_t",
                "uri": "std::vector<char>"
            }
        },
         # action to remove failed oracle rows
         "orcclean": {
             # does not rely on other context, perform async
            "blocking": false,
            "request": {
                "uri": "std::vector<char>"
            },
            "callback": {
                "size": "uint32_t",
                "uri": "std::vector<char>"
            },
            "signal": {
                "size": "uint32_t",
                "uri": "std::vector<char>"
            }
        }
    }
}

To enable you can visit bloks.io's block explorer to submit the dappservices:enablepkg action, this requires the package id, DSP name, and service name

The service name can be found in the model file of the service, let's go to the directory of services on . If we go into the /models/dapp-services/oracle.json we will see the following:

👨‍🚀
eosq block explorer
here
Github