Skip to content

voidchain-net/voidchain-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

VoidChain API Documentation

Table of Contents

Introduction to VoidChain technology and architecture.

Installation and configuration guide for the Edge Trust Machine.

Public information query endpoints:

  • Get Edge Trust Machine ID
  • Entry Information Query
  • Node Query
  • Query Block List
  • Block Information Query
  • Block Transaction Query
  • Address Query
  • Rewards Query
  • Account Check
  • Token List Interface
  • Transaction Result Query

User authentication and account management:

  • Session ID
  • Register
  • Login
  • Import/Export Mnemonic
  • Import/Export Account Password
  • Import/Export Keystore
  • Change Password
  • Logout

Node administration interfaces:

  • Configure Management Password
  • Exit Vacuum Network

Content and address management:

  • Create Address
  • Update Address Content

Transaction testing and query operations.

Transaction execution endpoints:

  • Transfer
  • Distribute Transactions (Batch Transfer)
  • Deploy Contract
  • Execute Contract
  • Contract Function Code Query

Wallet locking mechanisms:

  • Lock Wallet
  • Query Lock Information
  • Unlock

Governance and proposal system:

  • TRC100 Address Query
  • Query Proposal Permission
  • Submit Proposal
  • Vote
  • Execute Proposal
  • Query Proposal
  • Delete Proposal
  • Query Vote Information

Metaspace management interfaces:

  • Apply for Static Metaspace
  • Get Metaspace Genesis Block
  • Confirm Metaspace Validity
  • Dynamic Metaspace Query
  • Deploy TRC100 Base Contract
  • Configure Incentive Token
  • Incentive Contract Query
  • Node Management (Add, Batch Add, Delete, Batch Delete, Query)

Asset transfer between metaspaces:

  • Cross-chain Transfer Out
  • Cross-chain Transfer In
  • Login VoidChain to Get Transaction Voucher
  • Login Third-party Exchange
  • Create Public Chain Private Address
  • Query Public Chain Private Address
  • Import/Export Public Chain Mnemonic
  • Deploy Public Chain Contract
  • Deploy Public Chain Token
  • Public Chain Information Query
  • Public Chain Token Details Query
  • Launch and Activate Public Chain
  • Query All Chain Information
  • Robot Address Query
  • Import/Export Public Chain Assets
  • Import/Export Asset Status Query
  • Broker Transaction
  • Query Cross-chain Metaspace Assets
  • Query Other Chain Assets

Blockchain event monitoring:

  • Set Monitoring
  • Query Transaction Actions
  • Blockchain Traversal Interface

Utility functions:

  • Get Content MD5
  • Query Machine Code

Complete keyword reference table.

Error code reference and notes.


API Communication

All API endpoints use JSON-RPC 3.0 protocol.

Base URL: http://127.0.0.1:8080 (local machine)

Request Format:

{
  "jsonrpc": "3.0",
  "method": "method_name",
  "params": ["param1", "param2"],
  "id": "session_id"
}

Response Format:

{
  "jsonrpc": "3.0",
  "id": "session_id",
  "result": {
    "ret": "0",
    "err": "",
    "content": {}
  }
}

Important Notes

  1. Token Decimals: VoidChain platform tokens use 9 decimal places. Add 9 zeros when transferring tokens.

  2. Daily Free Gas: Each account receives approximately 10 free gas operations daily, but must actively claim them.

  3. Gas Fee Priority: Gas fees are deducted from the free pool first. When exhausted, 1 platform coin is automatically purchased for approximately 10 operations worth of gas.

  4. Transaction Confirmation: Any operation returning a txhash field requires periodic status queries until completion.

Getting Started

  1. Download and install the Edge Trust Machine (see Setup Instructions)
  2. Configure chain.conf with your connection parameters
  3. Start the trust machine service
  4. Obtain a session ID (see Login and Registration)
  5. Begin making API calls

Support

For questions and support, please refer to the specific documentation sections above.

About

Official API documentation of Voidchain blockchain

Topics

Resources

Stars

Watchers

Forks