capsule-corp-ternoa / ternoa-doc Goto Github PK

Description

This section introduces our blockchain and infrastructure to people who are new to Ternoa.
The aim is to describe things without getting too much deep into developers notions.

Target: Everybody, from new employees to anyone in the community.
Some technicals web3 prerequisites are a must since we are directly talking about NFTs.

Todo

• #21
• #24
• #25
• #29

Description

This section is Indexer focused and will contain several subsections to understand how Indexer works.
We need to explain in details the difference with the Dictionary and how to use the Dictionary in pair with the Indexer to improve syncing performances.
Installation material guides is also super important, we have to explain a to run our own Indexer locally.

Todo

• Introduction: vision + subquery + architecture design choices
• Getting started + Contribution
• Queries
• Installation guidelines: node + docker + postgres usage
• Tutorial: create an new Entity
• References
  • Community references
  • Github Discussions

https://linktr.ee/ternoa_tech

Links to socials at the Top, Documentation Link, Ternoa SDK Repo, Reddit, Embed Vidéo

Todo

• Introduction: Ternoa building tools + glossary
• Get started
  • Prerequisites: wallet with alpha CAPS
  • Installation: ternoa-js library
  • Mint NFT
  • View NFT
  • Sold NFT
    ... structure by features with no separation between Indexer & SDK

To track :

• NPM Package installs
• Linktr.ee Clicks
• Github Contributions

Refacto format Events (add submenu)

Create a CoC page

Description

This section is SDK focused and will contain several subsections to understand how SDK works.
We need to explain the vision, our design choices and how to install and use it locally.

Todo

• Introduction: vision + architecture design choices
• Getting started + contribution
• Installation guidelines
• Workflow
• Events
• Cookbook
  • Utility Batch/BatchAll
  • Upload to IPFS
  • Wallet tx signing (Ternoa Wallet + Polkadot extension)
  • NFTs creation batching
  • Secret NFTs creation batching
• References
  • Community references
  • Github Discussions

References

• SDK README

Todo

• #26
• #27
• #28

Todo

• User flows
• TEE design
• Threat model
• Key management
• Multi-cluster design
• SGX Rewards

Todo

• Basic NFT
• Secret NFT
• Capsules
• Soulbound

References

• TIP 100: Basic NFT
• TIP 510: Secret NFT
• TIP 104: Soulbound Token
• Confluence: Basic NFT
• Confluence: Soulbound Token
• Confluence: Secret NFT
• Confluence: Capsule NFT

Todo

• Ternoa Interface Proposals (TIP)
• Ternoa Standard Proposals (TSP)

References

• Ternoa proposals READMER

Ternoa Documentation

All resources you'll need to build the future on Ternoa
Explore the docs »

View Demo · Report Bug · Discussions

About Ternoa

In 2018, the idea of Ternoa was born with the objective to create a technology that can store data forever, make it accessible only to its owner, and pass it along through time. After two years of R&D, Ternoa was launched in November 2020.

We've chosen the Polkadot ecosystem to develop our own blockchain to meet our requirements. Starting from Substrate, we've developed an innovative NFT we call "Capsule". This new NFT technology gives users a unique way to use NFT as proprietary decentralized data storage.

Our Non-Fungible Token (NFT) innovations helped us create a protocol dedicated to NFTs on the Polkadot ecosystem.

Today, Ternoa develops all NFTs basics on the Polkadot ecosystem, enabling innovative solutions.

Read our LitePaper

(back to top)

Built With

• Node JS
• Polkadot-JS API
• AXIOS
• BigNum JS
• Form-Data
• mime-types

(back to top)

Getting Started

To work and contribute on our documentation, you can clone our repo and run Docusaurus 2 following the instructions below.

Prerequisites

npm install yarn@latest -g

Installation

Ternoa Documentation is built using Docusaurus 2, a modern static website generator.

Init Project

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

(back to top)

Usage Examples

You can find useful examples of usecases. Additional screenshots, code examples, demos or links to more resources from the Ternoa community. We will highlight community works soon.

For your first examples you can check our CookBook

Time Capsule dApp is our most relevant use case on the Ternoa blockchain, check out here

For more examples, please refer to the Wiki

(back to top)

Docmap

• Ternoa Fundamentals
  • Core Blockchain
  • Offchain Components
  • TEE Enclaves
  • Ternoa NFT Primitives
  • Staking
• For Developers
  • Ternoa-JS SDK
  • Indexer
• For Node Operators

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the Ternoa community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have ideas or if you want to help by contributing to Ternoa Documentation, please fork the repo and create a pull request. You can also simply open an issue with the tag "Idea Proposal".
Don't forget to give the project a star ! Thanks again Fam !

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingTernoaFeature)
3. Commit your Changes (git commit -m 'Add some AmazingTernoaFeature')
4. Push to the Branch (git push origin feature/AmazingTernoaFeature)
5. Open a Pull Request

(back to top)

Contact

Capsule Corp Labs - @Ternoa_ - [email protected]

Project Link: Ternoa SDK

(back to top)

Acknowledgments

(back to top)

Description

Offchain components can be divided into 2 types: builder tools & applications.

• Builder tools are infrastructural tools to build on top of Ternoa chain.
• Applications includes native application build and maintained directly by the Ternoa team: Bridge, Wallet, Explorer, End-to-end test dApp for Ternoa-JS SDK

Todo

• #22
• #23

#81

Description

This section covers in detail our developer tools: Ternoa-JS SDK + Indexer, from our vision and design choices to installation and use. Notions are described in details with specific examples (code snippets, cookbook, tutorials).

Target: Developers with javascript experience.
Some technicals web3 prerequisites are a must since we are directly talking about NFTs.

Todo

• #31 @ipapandinas
• #32 @Victor-Salomon @ipapandinas
• #33 @Victor-Salomon @ipapandinas

Create a page to explain how to contribute on the doc and follow best practices.

Here an example : https://wiki.polkadot.network/docs/contributing

Description

This section explains how Ternoa staking works in general. Then it goes into details on how to setup and run a validator/public/sgx node.

Todo

• #39
• #40
• #41
  • #42
  • #43
• #44
  • #45
  • #46
• #47
  • #48
  • #49

References

• How to run a validator node on Ternoa
• Github Discussion: REFLEXION AROUND VALIDATORS

Todo

• Bridge
• Wallet
• Explorer
• End-to-end test dApp

References

• Bridge
• Wallet
• E2E-test-dApp README
• E2E-test-dApp homepage

Description

This overview aims to explain differences about SDK & Indexer to build on Ternoa.

Update links to docs pages on this welcome page :
https://docs.ternoa.network/intro

Todo

• Indexer
• SDK
• IPFS
• Dictionary

Under Ternoa General on docs add sections for the following content from Wiki:

• Joining Community
• Ambassador Program
• Accelerator Program
• Move 'Staking' to General

Create a "Staking" section in fundamentals and add a page "How to stake on Ternoa" with this content : https://wiki.ternoa.network/learn/staking/how-to-stake-on-ternoa

Todo

• Collections
• Marketplace
• Auctions
• Rental

References

• TIP 101: Collection
• TIP 200: Marketplace
• TIP 300: Auctions
• TIP 400: Rental NFT
• Confluence: Collection
• Confluence: Marketplace
• Confluence: Auctions
• Confluence: Rental NFT

We should detail differences balances in the Token section for developers.
Here is the explanaition from a Slack message:

Thank you for bringing up the issue of balance wording on the substrate. It can indeed be tricky to understand.
To answer your question, unfortunately, we cannot update the UI as we are using the public polkadot portal instance and do not have access to the code. Therefore, it is not possible to update the UI specifically for Ternoa.

For new builders, I suggest the following:
If they use the Polkadot Portal, they must understand that on screen 1:
Total balance = Free balance + Reserved balance
Transferrable balance = Free balance - Frozen balance
Locked balance = Frozen balance
Alternatively, they can use our Indexer and the AccountEntity where:
capsAmount refers to the transferrable balance
capsFrozen refers to the locked balance
capsTotal refers to the total balance

Todo

• Consensus
• Pallets
• Security
• Governance

References

• Ternoa Blockchain
• Lite Paper