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

docs: update docs #46

Merged
merged 1 commit into from
Jan 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

🌍 Last version of application automatically deploys at [minter.supadupa.space](https://minter.supadupa.space) by pushing to `master` branch

📖 [Minter documentation](https://docs.supadupa.space/minter)

# Features

🆕 **Jetton deploy**:
Expand Down
49 changes: 49 additions & 0 deletions docs/DevTools/DeveloperGuide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Developer Guide for DevTools

## How ABI getting works?

__Participants__:

- "TON Verifier Registry" - TON Verifier smart contract that correspond contract state init `code` with "Source item" smart contract addres
- "Source item" - specific for `code` smart contract that stores IPFS url leading "Root source file"
- "Root source file" - JSON file with list of all source code file IPFS urls for specific contract
- "Source file" - source file item (e.g. ".pkg"/".tact"/".abi" file)

```mermaid
sequenceDiagram
actor user as User
participant ui as Minter UI
participant registry as "TON Verifier Registry"<br />smart contract
participant source_item as "Source item"<br />smart contract
participant ipfs_source_root as Root source file
participant ipfs_source_file as "Source file"

user ->> ui: HTTP GET /manage/{address}
activate ui

ui ->> registry: run getter "get_source_item_address"
activate registry
registry -->> ui: "Source item" smart contract address
deactivate registry

ui ->> source_item: run getter "get_source_item_data"
activate source_item
source_item -->> ui: "Root source file" IPFS url
deactivate source_item

ui ->> ipfs_source_root: fetch via IPFS
activate ipfs_source_root
ipfs_source_root -->> ui:
deactivate ipfs_source_root

loop Each file
ui ->> ipfs_source_file: fetch via IPFS
activate ipfs_source_file
ipfs_source_file -->> ui:
deactivate ipfs_source_file
end

ui -->> user: ABI

deactivate ui
```
27 changes: 27 additions & 0 deletions docs/DevTools/UserGuide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# User Guide for DevTools

## How to use DevTools

1. Open <i>SupaDupa</i><b>Minter</b> [main page](https://minter.supadupa.space)

2. Click to "Connect Wallet" button

![Main Page](UserGuide_ConnectWalletButton.png)

3. Model window with QR code will be open. Scan this code with your TON Wallet application (e.g. TON Keeper)

4. Fill in "Open contract by address" field with contract address you need and click "Search"

![Main Page](UserGuide_MainPage.png)

5. Browser will show loading bar. It could take some time. If loading is too long (more than minute, refresh page)

![Main Page](UserGuide_Loading.png)

6. When loading is finished, there will be page of DevTools application

![Main Page](UserGuide_DevToolsInterface.png)

7. In left menu choose contract message you need to send to contract, fill fields for it operation and click "Execute" button for creating transaction

![Main Page](UserGuide_DevToolsForm.png)
Binary file added docs/DevTools/UserGuide_ConnectWalletButton.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/DevTools/UserGuide_DevToolsForm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/DevTools/UserGuide_DevToolsInterface.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/DevTools/UserGuide_Loading.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/DevTools/UserGuide_MainPage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
74 changes: 25 additions & 49 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,27 @@
# Minter Docs

WORK IN PROGRESS!

## How ABI getting works?

__Participants__:

- "TON Verifier Registry" - TON Verifier smart contract that correspond contract state init `code` with "Source item" smart contract addres
- "Source item" - specific for `code` smart contract that stores IPFS url leading "Root source file"
- "Root source file" - JSON file with list of all source code file IPFS urls for specific contract
- "Source file" - source file item (e.g. ".pkg"/".tact"/".abi" file)

```mermaid
sequenceDiagram
actor user as User
participant ui as Minter UI
participant registry as "TON Verifier Registry"<br />smart contract
participant source_item as "Source item"<br />smart contract
participant ipfs_source_root as Root source file
participant ipfs_source_file as "Source file"

user ->> ui: HTTP GET /manage/{address}
activate ui

ui ->> registry: run getter "get_source_item_address"
activate registry
registry -->> ui: "Source item" smart contract address
deactivate registry

ui ->> source_item: run getter "get_source_item_data"
activate source_item
source_item -->> ui: "Root source file" IPFS url
deactivate source_item

ui ->> ipfs_source_root: fetch via IPFS
activate ipfs_source_root
ipfs_source_root -->> ui:
deactivate ipfs_source_root

loop Each file
ui ->> ipfs_source_file: fetch via IPFS
activate ipfs_source_file
ipfs_source_file -->> ui:
deactivate ipfs_source_file
end

ui -->> user: ABI

deactivate ui
```
__Feel free to improve or fix this docs.
Markdown files are stored [here](https://github.com/supadupadao/minter/tree/master/docs) in repo.__

Following documentation describes design of <i>SupaDupa</i><b>Minter</b> application. This application provides multiple features related to TON Blockchain and smart contracts on it.

### Contract DevTools

[See example](https://minter.supadupa.space/manage/kQC1I2HcAkUSfMCQCezbL9bVtC_kqnX-gQIToAqXJNTP7yVj)

Application provide auto generated UI for specified deployed smart contract. UI is generated based on smart contract ABI that loading from [TON Verifier](https://verifier.ton.org).Using this feature you can interact with TON smart contracts which doesn't have frontend.

It useful in following cases:

1. Testing your own smart contracts without having to create dApp frontend
2. Exploring operating principle of smart contracts in TON blockchain

Read more about this feature:

- [User guide](DevTools/UserGuide.md)

### Jetton deploy

[See example](https://minter.supadupa.space/deploy/jetton)


Loading