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.

Sign up for GitHub

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

Jump to bottom

First draft of the offchain component tutorial #955

Merged
merged 7 commits into from
Oct 11, 2023
Merged

First draft of the offchain component tutorial #955

merged 7 commits into from
Oct 11, 2023

Conversation

dubbelosix
Copy link
Contributor

Description

Adding TUTORIAL.md which explains the process of creating offchain processing and storage for the sov-nft-module
The tutorial covers

  • Basic setup (installing postgres, creating the necessary tables)
  • Creating offchain.rs and creating the functions encoding the offchain functionality to update the three tables - collections, nfts, top_owners
  • Explains how to use the offchain macro
  • Adding the offchain feature to the necessary crates to ensure it can be used for demo-rollup
  • Using the nft-utils script to create some collections and nfts to see the results of the offchain functions

@preston-evans98
Copy link
Member

This looks really nice. Great work!

@dubbelosix dubbelosix marked this pull request as ready for review October 3, 2023 05:27
cemozerr
cemozerr approved these changes Oct 4, 2023
View reviewed changes
Copy link
Member

@cemozerr cemozerr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Left a few comments.

module-system/module-implementations/sov-nft-module/TUTORIAL.md Outdated Show resolved Hide resolved
module-system/module-implementations/sov-nft-module/TUTORIAL.md Outdated Show resolved Hide resolved
module-system/module-implementations/sov-nft-module/TUTORIAL.md Outdated Show resolved Hide resolved
@cemozerr
Copy link
Member

cemozerr commented Oct 4, 2023

Also, can we add a reading time widget as in the Demo rollup?

@codecov
Copy link

codecov bot commented Oct 5, 2023 •
edited
Loading

Codecov Report

Merging #955 (4c10279) into nightly (52c33ae) will decrease coverage by 0.1%.
The diff coverage is n/a.

see 2 files with indirect coverage changes

@dubbelosix dubbelosix added this pull request to the merge queue Oct 11, 2023
Merged via the queue into nightly with commit 88d41d5 Oct 11, 2023
13 checks passed
@dubbelosix dubbelosix deleted the dub/offchain_documentation branch October 11, 2023 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cemozerr cemozerr cemozerr approved these changes

@neysofu neysofu neysofu approved these changes

@citizen-stig citizen-stig Awaiting requested review from citizen-stig

@preston-evans98 preston-evans98 Awaiting requested review from preston-evans98

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dubbelosix @preston-evans98 @cemozerr @neysofu