SUMMARY.md

Summary

• Introduction

• Getting Started

  • Requirements
  • Useful Skills
  • Install the Interbit SDK
  • Create your first Interbit app
  • Run your Interbit app
  • Troubleshooting

• Key Concepts

  • Covenants
  • Actions
  • Application State
  • Smart Contracts
  • Root Saga
  • Determinism
  • Chain Joins
  • Configuration and Manifest File
  • Hypervisor

• Examples

  • Initializing a Chain
  • Determinism
  • Template App Walk-through
  • To-do List App
  • A Simple Interbit Platform
    • Platform Structure
    • Configure the Example
    • Run the Example Locally
    • Platform Operation

• Architecture

  • Chain Joins: How They Work
  • Chain Topology
    • Key Considerations
    • Topology Patterns
  • Permission Model

• Reference

  • interbit

    • Constants

    • Configuration Selectors

      • getAdminValidators()
      • getApps()
      • getChains()
      • getChainByAlias()
      • getChainCovenant()
      • getChainJoins()
      • getChainValidators()
      • getJoinTypeForChain()
      • getCovenants()
      • getPeers()
      • joinTypes

    • configureChains()

    • configureJoins()

    • connectToPeers()

    • create()

    • createChains

      • createChainsFromConfig()
      • createChainsFromManifest()

    • deploy()

    • deployCovenants()

    • generateDeploymentDetails()

    • generateManifest()

    • getConfig()

    • getManifest()

    • joinChains()

    • Manifest Selectors

      • getApps()
      • getBlockMasterByAlias()
      • getChainIdByAlias()
      • getChains()
      • getCovenantHashByAlias()
      • getCovenants()
      • getGenesisBlockByAlias()
      • getGenesisBlocks()
      • getPeers()
      • getRootChildren()

    • packCovenants()

    • setRootChainManifest()

    • start()

    • startInterbit()

    • updateIndexHtmls()

    • validateConfig()

  • interbit-cli

    • Configuration file

      • staticChain{}
        • joins{}
      • covenant{}
      • app{}

    • Manifest file

      • app{}
      • deployment{}

    • build

    • create

    • deploy

    • start

  • interbit-covenant-tools

    • validate()

  • interbit-ui-components

    • Contributing

    • Functions

      • formatDate()
      • formatDateTime()

    • React components

      • UIKit
        • LinkBar

  • interbit-ui-tools

    • actionCreators
    • actionTypes
    • chainDispatch
    • chainUpdated
    • middleware
    • reducer
    • rootSaga
    • Selectors
    • Chain Sponsorship

• Report bugs

• Glossary