⚙️ Ternoa SDK

It's the easiest and fastest way to build on top of the Ternoa Chain. Based on Javascript and the Polkadot.js API, it offers developers a seamless experience in the Domain of Web 3.

You can start by familiarizing yourself with the architecture and playing around with the ternoa.js test-dapp to get a good grasp of the Ternoa SDK.

Lastly, don’t forget to have a good time, that's like the most important thing. Cheers 🍻

Table of Contents

• Introduction
  • Contribution Guidelines
  • Error Reporting
• Installation
• Quick Start
  • On Chain Events
  • SDK Design
    • Event Design Format
    • Events Handled
• Code Architecture
  • Handlers architecture
    • Response format
    • Initialize an API Instance
  • Examples
    • Create an Account
    • Create an NFT with Keyring
    • Create an NFT (full flow)
• Documentation
  • Wiki
  • Typescript documentation
  • End-to-end test dApp
  • Github repository
• Development
  • Build
  • Generating Documentation
  • Testing
  • Code Style
  • Build And Run With Podman
    • Tips to Run with Podman
    • Remove Container After Exit
    • Persistent Storage
    • Run The Container And Access Its Shell
    • Create A Detached Instance And Access Its Shell
    • Create A Development Environment
• License

Introduction

Ternoa is a Decentralised, Open source, NFT-centric Layer 1 blockchain that is multi-chain by design and aims to provide a technical stack to build scalable and secure NFTs with native support for advanced features.

For Builders By Builders

NFTs native to our chain can be minted using High-level programming languages and doesn't require smart contract functionality.

Native support for Advanced Features

With native support for Secret NFTs, Delegating and Lending, Transaction Batching and much more, you might want to give it a try.

Ecosystem

Our ecosystem of NFT-based dApps keeps growing day after day. Our SDK relies upon the most popular high-level languages, allowing us to tap into the world’s largest pool of existing developers, thereby minimizing the transition period.

Contribution Guidelines

As Ternoa-js is an open-source SDK, feel free to interact with the tools and libraries, log issues, create pull requests or leave feedback. We welcome and greatly appreciate your contribution.

If you’re interested in contributing to the Ternoa SDK, we recommend you inspect our contribution guidelines.

If you want to learn how to use the Ternoa SDK, the test-dapp is the perfect place to familiarize yourself with our architecture and contribute to its development.

Error Reporting

If you encounter any errors along the way, technical or otherwise. Let us know and we'll deal with it swiftly. It'll help us further improve the overall experience for our users.

• Open a discussion of type General in the discussions section if you encounter any unexpected behaviour.
• Open a Bug report using the bug template if the bug persists.
• If you can, suggest a fix in a pull request to resolve that issue.

Make sure to document the error properly, keeping in mind that the better you describe it, the easier it is to deal with.

Installation

Pre-requisites: Node.js

Install the latest stable version of the ternoa-js library by running this command:

npm install ternoa-js
Copy

This package provides TypeScript types, but you will need TypeScript version 4.2 or higher to use them properly.

You can test out our upcoming features in our Beta @beta or Release candidate @rc versions. These versions aren't stable and might contain some technical errors. versions are for internal and public testing only whereas