search

fleet-sdk / docs

📄 Documentation for Fleet SDK
https://fleet-sdk.github.io/docs
MIT License
0 stars 2 forks source link

[Educational] Fleet-Tutorial + Bounties #8

Open kii-dot opened 4 months ago

kii-dot commented 4 months ago

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

Myestery commented 4 months ago

Hi @kii-dot I'll like to work on these

0xOptimistic commented 4 months ago

Hi, I want to work on it.

arobsn commented 4 months ago

Hey, it looks great!

A few notes:

Requirements

Guides must follow the Writing Guide referenced in the Contribution Guide.

Milestones

Milestones 1, 2, and 3 have already been completed.

arobsn commented 4 months ago

One more thing: I would like to propose multiple small sized chapters over a huge catch-all tutorial. I can put a structure in place so contributors can just edit .md files and add content.

kii-dot commented 4 months ago

@arobsn those are great suggestions. would you be able to help navigate this?

Myestery commented 3 months ago

Hello, @arobsn @kii-dot I was able to publish a page that should fix milestaone 4 However, for 5,6 I am a bit confused, does creating boxes mean calls to OutputBuilder ? Or is there some info I can read up on it

ladopixel commented 3 months ago

This application has been created with Chakra-ui using Create React App and Fleet SDK:

✅ Create token ✅ Send ERG ✅ Send tokens ✅ Send NFT ✅ Burn tokens

https://github.com/ladopixel/fleetERG