Koinos documentation

Quickstart

• Running a Koinos node
  • Installing on macOS/Linux
  • Installing on Windows
  • Managing a node
• Microservice options
  • Chain
  • Mempool
  • Block Store
  • P2P
  • Block Producer
  • Transaction Store
  • JSON-RPC
  • Contract Meta Store
• Block production
  • Proof-of-Burn basics
  • Prerequisites
  • Retrieving your address and key
  • Registering your key and burning
  • Configuring the block producer
  • Producing blocks
• Developer guide
  • C++ projects
    • Dependencies
    • Building projects
    • Running unit tests
  • Golang projects
    • Building projects
    • Running unit tests
• Contract developer guide
  • Official SDKs
  • AssemblyScript SDK
    • Creating new contracts with the Assemblyscript SDK
    • Modifying the template contract
    • Building the contract
  • C++ SDK
    • Retrieving dependencies
    • Building the C++ SDK
  • Using the Koinos C++ SDK
• Using the Koinos CLI
  • Installing and starting the CLI
  • Basic usage
  • Wallet creation & management
  • Other useful commands
  • Smart contract management
  • Transaction sessions
  • Non-interactive mode

RPC

• Protocol Documentation
  • Table of Contents
  • koinos/rpc/contract_meta_store/contract_meta_store_rpc.proto
    • contract_meta_store_request
    • contract_meta_store_response
    • get_contract_meta_request
    • get_contract_meta_response
  • koinos/rpc/rpc.proto
    • error_response
    • reserved_rpc
  • koinos/rpc/transaction_store/transaction_store_rpc.proto
    • get_transactions_by_id_request
    • get_transactions_by_id_response
    • transaction_store_request
    • transaction_store_response
  • koinos/rpc/chain/chain_rpc.proto
    • chain_request
    • chain_response
    • get_account_nonce_request
    • get_account_nonce_response
    • get_account_rc_request
    • get_account_rc_response
    • get_chain_id_request
    • get_chain_id_response
    • get_fork_heads_request
    • get_fork_heads_response
    • get_head_info_request
    • get_head_info_response
    • get_resource_limits_request
    • get_resource_limits_response
    • read_contract_request
    • read_contract_response
    • submit_block_request
    • submit_block_response
    • submit_transaction_request
    • submit_transaction_response
  • koinos/rpc/block_store/block_store_rpc.proto
    • add_block_request
    • add_block_response
    • block_store_request
    • block_store_response
    • get_blocks_by_height_request
    • get_blocks_by_height_response
    • get_blocks_by_id_request
    • get_blocks_by_id_response
    • get_highest_block_request
    • get_highest_block_response
  • koinos/rpc/p2p/p2p_rpc.proto
    • get_gossip_status_request
    • get_gossip_status_response
    • p2p_request
    • p2p_response
  • koinos/rpc/mempool/mempool_rpc.proto
    • check_pending_account_resources_request
    • check_pending_account_resources_response
    • get_pending_transactions_request
    • get_pending_transactions_response
    • mempool_request
    • mempool_response
    • pending_transaction
  • Scalar Value Types
• JSON-RPC
  • Descriptor files
  • Examples
    • Get block
    • Get head block

Architecture & design

• Microservice architecture
  • Koinos cluster
• Interprocess communication
  • RPC
  • Broadcast
• Serialization
  • Protocol buffers
  • Canonicity
• Contract ABI
• System calls
  • Overriding system calls

Step-by-step guides

• Using the faucet on Discord
• Smart contract custom types
  • Setting up the project
  • Defining custom types
  • Writing the implementation
  • Compiling the smart contract
  • Creating the ABI file
  • Uploading and interaction
• Deploying a token contract
  • Building the token contract
  • Uploading the token contract
  • Utilizing the token
  • Customizing the token