Welcome to the documentation of plasma-core!

Hello and welcome to the documentation of Plasma Group’s plasma-core! A quick note: plasma-core is not our Node.js client, plasma-client. Documentation for plasma-client is available at the plasma-client docs.

Developer Documentation

• What is plasma-core?
• Contributing
  • Contributing Guide and Code of Conduct
  • Getting Started as a Contributor
• Architecture
  • plasma-core 101
  • Architecture Diagram
  • External services
  • Internal services
• Extending plasma-core
  • What’s missing
• Reference
  • Running a Terminal
  • Installing Git
  • Installing Node.js

Specifications

• Plasma Chain Operator
  • Back to Basics
  • Plasma Magic
  • Decentralizing the Operator
• Coin ID Assignment
  • Coin IDs
  • Denominations
  • Examples
• Transactions Over Ranges
  • Transfers
  • Typed and Untyped Bounds
  • Atomic Transactions
  • Serialization
• Proof Structure and Verification
  • What are History Proofs?
  • Proof Structure
  • Proof Verification
• Smart Contract and Exit Games
  • Keeping Track of Deposits and Exits
  • Similarities to Plasma Cash
  • Block-specific Transactions
  • Per-coin Transaction Validity
  • Transaction Verification
  • Challenges That Immediately Block Exits
  • Optimistic Exits and Inclusion Challenges
  • Invalid-History Challenge
• Merkle Sum Tree Block Structure
  • Sum Tree Node Specification
  • Parent Calculation
  • Calculating a Branch’s Range
  • Parsing Transfers as Leaves
  • Branch Validity and Implicit NoTx
  • Atomic Multisends
• JSON-RPC Calls
  • pg_getBalance
  • pg_getBlock
  • pg_getTransaction
  • pg_sendTransaction
  • pg_sendRawTransaction
  • pg_getHeight
  • pg_getRecentTransactions
  • pg_getAccounts
  • pg_getTransactionsByAddress

Service API Reference

• ContractProvider
  • address
  • hasAddress
  • ready
  • web3
  • plasmaChainName
  • checkAccountUnlocked
  • getBlock
  • getNextBlock
  • getCurrentBlock
  • getOperator
  • getTokenAddress
  • listToken
  • getChallengePeriod
  • getTokenId
  • depositValid
  • deposit
  • startExit
  • finalizeExit
  • submitBlock
• OperatorService
  • getNextBlock
  • getEthInfo
  • getTransactions
  • getTransaction
  • sendTransaction
  • submitBlock
• JSONRPCService
  • getAllMethods
  • getMethod
  • handle
  • handleRawRequest
• ProofService
  • checkProof
• SyncService
• ChainService
  • getBalances
  • addDeposits
  • getExitsWithStatus
  • addExit
  • pickRanges
  • pickTransfers
  • startExit
  • finalizeExits
  • sendTransaction
  • loadState
  • saveState
• GuardService
• DBService
  • Backends
  • get
  • set
  • delete
  • exists