Tutorials

The pages in this section of the documentation are aimed at the newcomer to the 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 customise 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. Installing Sidechain SDK
  • 1.1. Supported platforms
  • 1.2. Requirements
  • 1.3. Installing on Windows OS:
  • 1.4. Installing on Linux OS:
  • 1.5. Sidechain SDK Components:
• 2. Internal representation of a Blockchain
  • 2.1. Concept of a BOX
  • 2.2. Node Main elements & intro to a “NodeView”
• 3. The Cross-Chain Transfer Protocol
  • 3.1. Forward Transfer
  • 3.2. Backward Transfer
  • 3.3. Summary
• 4. Latus Consensus
  • 4.1. Consensus Epochs & Forging
  • 4.2. Default Latus consensus parameters
• 5. Node communication
  • 5.1. Default standard API
• 6. Base App
  • 6.1. Secret / Proof / Proposition
  • 6.2. Boxes
  • 6.3. Transactions
  • 6.4. Serialization
  • 6.5. SidechainNodeView
  • 6.6. Memory Pool
  • 6.7. Node wallet
  • 6.8. State
  • 6.9. History
  • 6.10. Network layer
  • 6.11. Physical storage
  • 6.12. User specific settings
  • 6.13. SidechainApp class
• 7. Sidechain SDK extension
  • 7.1. Data serialization
  • 7.2. Custom box creation
  • 7.3. Custom Box Data class creation
  • 7.4. Custom Box Data Serializer class creation
  • 7.5. Custom Box class creation
  • 7.6. Custom Box Serializer Class
  • 7.7. Specific actions for extension of Coin-box
  • 7.8. Transaction extension
  • 7.9. ApplicationState and Wallet
  • 7.10. Application Wallet
  • 7.11. Custom API creation
• 8. Car Registry Tutorial
  • 8.1. Car Registry App high level overview
  • 8.2. Car registry implementation
  • 8.3. Implementation of CarBoxData
  • 8.4. Implementation of CarBoxDataSerializer
  • 8.5. Implementation of CarBox
  • 8.6. Implementation of CarBoxSerializer
  • 8.7. Implementation of CarSellOrderData
  • 8.8. Implementation of CarSellOrderDataSerializer
  • 8.9. Implementation of CarSellOrder
  • 8.10. Extend API by creating new transactions Car creation transaction and Car sell Order transaction

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