Tutorials

The pages in this section of the documentation are aimed at the newcomer to the Horizen Sidechain SDK. They’re designed to help you get started quickly, and show how easy it is to work with the sidechain SDK as a developer who wants to customize it and get it working according to their own requirements.

These tutorials take you step-by-step through some key aspects of this work. They’re not intended to explain the topics in depth, or provide reference material, but they will leave you with a good idea of what is possible to achieve in just a few steps, and how to go about it.

Once you’re familiar with the basics presented in these tutorials, you’ll find the more in-depth coverage of the same topics in the How-to section.

The tutorials follow a logical progression, starting from installation of Horizen Sidechain SDK and the creation of a brand new project, and build on each other, so it’s recommended to work through them in the order presented here.

• 1. Before you start
  • 1.1. Why a Sidechain?
• 2. Installing the Horizen Sidechain SDK
  • 2.1. Supported Platforms
  • 2.2. Requirements
  • 2.3. Installing on Windows
  • 2.4. Installing on Linux
• 3. Internal Representation of a Blockchain
  • 3.1. Concept of a Box
  • 3.2. Node Main Elements & Intro to a “NodeView”
    • 3.2.1. NodeViewHelper
    • 3.2.2. Box Unique ID & Transactions
• 4. The Cross-Chain Transfer Protocol
  • 4.1. Forward Transfer
  • 4.2. Backward Transfer
  • 4.3. Ceased Sidechain Withdrawal
  • 4.4. Circuit with key rotation
  • 4.5. Summary
• 5. Latus Consensus
  • 5.1. Consensus Epochs & Forging
  • 5.2. Default Latus consensus parameters
  • 5.3. Fee redistribution
• 6. Node communication
  • 6.1. API authentication
• 7. Base App
  • 7.1. Secret / Proof / Proposition
  • 7.2. Boxes
  • 7.3. Transactions
  • 7.4. Serialization
  • 7.5. SidechainNodeView
  • 7.6. Memory Pool
  • 7.7. Node wallet
  • 7.8. State
  • 7.9. History
  • 7.10. Network layer
  • 7.11. Physical storage
  • 7.12. User-specific settings
  • 7.13. SidechainApp class
  • 7.14. Remote Key Manager configuration
• 8. Sidechains SDK extension
  • 8.1. Custom box creation
  • 8.2. BoxSerializer and BoxDataSerializer
  • 8.3. Specific actions for extension of Coin-box
  • 8.4. Transaction extension
    • 8.4.1. Transactions that process Coins
  • 8.5. Custom Proof / Proposition creation
  • 8.6. Application State
  • 8.7. Application Wallet
  • 8.8. Sidechain Application Stopper
  • 8.9. Custom API creation
  • 8.10. Backup and restore procedure
    • 8.10.1. Backup procedure
    • 8.10.2. Restore procedure
  • 8.11. Logging
    • 8.11.1. Default log configuration
    • 8.11.2. Customized log configuration
  • 8.12. Fork Configuration
• 9. Car Registry Tutorial
  • 9.1. Car Registry App High-Level Overview
  • 9.2. User stories:
  • 9.3. Boxes
    • 9.3.1. BoxData
    • 9.3.2. BoxSerializer and BoxDataSerializer
  • 9.4. Transactions
  • 9.5. Custom proof and proposition
  • 9.6. Application state
  • 9.7. Application wallet
  • 9.8. Application Stopper
  • 9.9. API extension

Either way, you’ll be able to find support and help from the numerous friendly members of the Horizen community, on our Discord channel #sidechains