Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Core concepts chapter #10

Open
arobsn opened this issue Jul 24, 2024 · 0 comments
Open

Core concepts chapter #10

arobsn opened this issue Jul 24, 2024 · 0 comments

Comments

@arobsn
Copy link
Member

arobsn commented Jul 24, 2024

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 "Core 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
@arobsn arobsn changed the title Basic concepts chapter Core concepts chapter Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant