The idea behind this chapter is to give the reader some initial concepts so that they can better follow the documentation and so that the documentation doesn't have to be repetitive about concepts.

Chapter Structure

Introduction

• Present the overall idea of the "Basic concepts" chapter

What's a box?

• Describe an Ergo Box in both conceptual and practical terms

Anatomy of a box

• Describe each property of a box (value, ergoTree, assets, and so on)
• Explain why value and assets#amount should be handled as integer rather than decimals.
• Briefly describe in a tip box how to use decimalize() and undecimalize() functions from @fleet-sdk/common package to represent box integers as decimals.

What's a transaction?

• Describe an Ergo Transaction in both conceptual and practical terms

Anatomy of a transaction

• Describe each property of a transaction (inputs, dataInputs, outputs, and transacionId)

Box lifecycle

• Describe how a box is created and destroyed by a transaction

I don't have any experience with TypeScript. So, I thought I'd try to run the examples. It seems to me that a soup to nuts installation and running guide would be helpful. I'm making notes to write this up, as I'm trying to figure it out. This is what I have thus far.

On Windows, I did the following:

As Admin in Powershell:

choco install nodejs-lts

Cmd.exe to check installation:

node -v
npm -v

Adding fleet:

npm install @fleet-sdk/core

Also updated npm:

npm install -g [email protected]

These are the prerequisites for creating a New Project > Typescript Console Application in Visual Studio.

On WSL Ubuntu on Windows, I did the following:

Install LTS, since the apt-get repo is too old
$ curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
$ sudo apt-get install nodejs
$ node --version
$ sudo npm install -g [email protected]
$ sudo npm install -g typescript

So, I then try doing some of the scripts in the tutorial and turn it to javascript:
$ tsc sample.ts

Them I get several errors that look like this:

../../../node_modules/@fleet-sdk/core/dist/esm/models/collections/collection.d.ts:1:56 - error TS2304: Cannot find name 'Iterable'.
scratch.ts:18:19 - error TS1378: Top-level 'await' expressions are only allowed when the 'module' option is set to 'es2022', 'esnext', 'system', 'node16', or 'nodenext', and the 'target' option is set to 'es2017' or higher.

What is this?

This issue describes a skeleton roadmap for the tutorial that will serve future developers in joining the ecosystem.

Goal

To build out a tutorial/course that provides developers clarity on utilizing fleet-sdk.

Basic Milestones

At the end of the tutorial, developers should be able to:
(Note that this is a non-exhaustive list, meaning there can be more as we go, please comment for suggested tutorial)

1. Use Fleet-SDK to create send transactions to user-wallets
2. Mint tokens based on EIP token standards
3. burn tokens
4. Retrieve boxes from explorer and parsing as input boxes/data inputs for tx usage
5. Create boxes with contracts
6. Create boxes with injected variables, explanation of injected variables
7. Create boxes with registers, its utility in contracts and txs, explanation of registers
8. Utilizing Data inputs for txs, how to utilize it, and its pros and cons, explanation of data inputs
9. Using compile time constants in contracts, and what compile time constants, explanation of compile time constants
10. Parsing txs as reduced txs for ergopay consumptions, explanation of reducedTxs and ergopay
11. Examples - Single interaction Txs, multi-interaction txs

Tutorial requirements

Each tutorial should be:

1. Succinct and straight to the point
2. Explanation of the tool that is used (for example, the tool that is used in the data input section would be the data input)
3. Contains code examples that can be plug and play
4. Contains StackBlitz like this whenever necessary: stackblitz code for easier comprehension of implementation.

Bounties

[ ] - 50 SigUSD for Milestone.1, MileStone.2, MileStone.3
[ ] - 100 USD for Milestone.4
[ ] - 75 SigUSD for MileStone.5 and MileStone.6
[ ] - 100 SigUSD for MileStone.7
[ ] - 100 SigUSD for MileStone.8
[ ] - 125 SigUSD for MileStone.9
[ ] - 150 SigUSD for MileStone.10
[ ] - 125 SigUSD per examples in MileStone.11

Tutorial structure/skeleton

• Tutorial
• -- Basics
• -- -- Send Transactions to Wallets
• -- -- Mint tokens
• -- -- Burn tokens
• -- Box Retrieval from Blockchain
• -- -- Retrieving boxes from blockchain (from addresses and from tokenId, and converting json to inputBoxes)
• -- eUTxOs
• -- -- Smart Contracts (ErgoScript)
• -- -- Injected Variables
• -- -- Registers
• -- -- Data Inputs
• -- -- Compile time constants
• -- ReducedTxs
• -- -- Reduced Txs and ErgoPay
• -- Examples - Single interaction
• -- -- Time Lock
• -- Examples - Multi interaction
• -- -- Please suggest