feat: initial `r/gh` realm #1134

moul · 2023-09-16T13:38:40Z

This PR initiates the new r/github realm, overseen by an oracle to transition offchain information onchain.

While this is foundational and will be augmented with new features, I welcome feedback on the codebase. Reviewers, please advise if we should merge as is and refine later, or if it would be preferable to transition this to a draft PR for continued development.

Addresses #1133

Related with gnolang/game-of-realms#3

cc @gnolang/devrels @gnolang/tokenomics

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests
Added new benchmarks to generated graphs, if any. More info here.

Signed-off-by: Manfred Touron <[email protected]>

codecov · 2023-09-18T13:51:07Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (61f3ada) 47.08% compared to head (517a002) 47.08%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1134   +/-   ##
=======================================
  Coverage   47.08%   47.08%           
=======================================
  Files         365      365           
  Lines       61156    61156           
=======================================
  Hits        28793    28793           
  Misses      30011    30011           
  Partials     2352     2352

Flag	Coverage Δ
gnovm-_test.cmd	`45.89% <ø> (ø)`
gnovm-_test.gnolang.native	`63.09% <ø> (ø)`
gnovm-_test.gnolang.other	`16.63% <ø> (ø)`
gnovm-_test.gnolang.pkg0	`17.98% <ø> (ø)`
gnovm-_test.gnolang.pkg1	`8.21% <ø> (ø)`
gnovm-_test.gnolang.pkg2	`9.87% <ø> (ø)`
gnovm-_test.gnolang.realm	`41.68% <ø> (ø)`
gnovm-_test.gnolang.stdlibs	`53.53% <ø> (ø)`
gnovm-_test.pkg	`25.96% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

harry-hov · 2023-09-28T16:12:57Z

examples/gno.land/r/gh/gno.mod

@@ -0,0 +1 @@
+module gno.land/r/gh


missing require?

Suggested change

module gno.land/r/gh

module gno.land/r/gh

require "gno.land/p/demo/avl" v0.0.0-latest

gno lint should complain?

anyways gno mod tidy implementation is complete. CI will start complaining about this soon.

@harry-hov: We need a solution to eliminate those comments. The gno mod process should be fully automated, from creation to clarity in CI feedback. Please ensure it's streamlined so you don't have to review this aspect in future PRs. Otherwise, we might just bypass the need for gno.mod and switch to automatic detection.

MichaelFrazzy · 2023-10-01T23:28:13Z

I really love this idea, it'll also give a home to some of the Python scripts that are being messed around with. I always figured everything would eventually need to be ported over to Gno, in Python we have GitHub CI calculating different averages and other additional metrics/statistics if that'd be helpful to try to bring over into this instead. Or after a certain point should pulling a wider range of stats like that be its own system? Maybe it'd be overkill to provide too many categories by default via an oracle?

I also still agree that initially just creating a database itself based on both GitHub and blockchain metrics will be ideal, with point rewards staying largely manual. Could lead to a bunch of cool systems down the road and something like this would make facilitating and experimenting with all of that way easier. If nothing else it'll lead to some cool data study ideas! Maybe one day leading to further automations as enough training data is built up, and a great building block well before that.

What are your thoughts in terms of how the metrics themselves/database should be stored or output for use elsewhere? Maybe even a Chainstack-style RPC that can return the data in a bunch of different formats?

MichaelFrazzy

Just to make sure I'm reading it correctly, we'd be creating our own oracle from scratch and assigning it to an address within this code? Seems like it'd give us some really cool possibilities even beyond what I was initially thinking.

thehowl · 2023-10-13T00:08:51Z

examples/gno.land/r/gh/accounts.gno

+// Account represents a GitHub user account or organization.
+type Account struct {
+	id   string
+	name string
+	kind string
+}


Hmm. What about having types User, Organization, and type Handle interface { Name() string; URL() string; assertHandle() }? Or Namespace

thehowl · 2023-10-13T00:10:26Z

examples/gno.land/r/gh/issues_prs.gno

+
+/*
+// IssueOrPR represents a GitHub issue or pull request
+type IssueOrPR struct {


For this, I think we should have type Issue and type PR, which embeds Issue, Issue implements type Referencer interface { Reference() string }, returns "#1134"

(feel free to ignore, I think the comment makes it clear that you want to tackle this in another PR)

thehowl · 2023-10-13T00:15:10Z

examples/gno.land/r/gh/accounts.gno

+
+// Account represents a GitHub user account or organization.
+type Account struct {
+	id   string


thehowl · 2023-10-13T00:17:18Z

examples/gno.land/r/gh/accounts.gno

+}
+
+func (a Account) String() string {
+	// XXX: better idea?


either @handle or markdown representation?

thehowl · 2023-10-13T00:19:00Z

examples/gno.land/r/gh/oracle.gno

+
+func OracleLastUpdated() time.Time { return lastUpdateTime }
+
+func OracleUpsertAccount(id, name, kind string) {


Upsert feels sql-y, when under the hood we just have a k-v. Can we not do Set?

thehowl · 2023-10-13T00:20:09Z

examples/gno.land/r/gh/repos.gno

+	id        string
+	owner     *Account
+	name      string
+	isPrivate bool


if it's private, the oracle probably shouldn't know about it, right?

thehowl · 2023-10-13T00:21:54Z

examples/gno.land/r/gh/oracle.gno

+	parts := strings.Split(id, "/")
+	if len(parts) != 2 {
+		panic("invalid id")
+	}
+	ownerID := parts[0]
+	name := parts[1]


add util func, de-duplicate from above?

thehowl · 2023-10-13T00:22:23Z

examples/gno.land/r/gh/oracle.gno

+	accounts.Set(id, account)
+}
+
+func OracleUpsertRepo(id string, isPrivate, isFork bool) {


thehowl · 2023-10-13T00:23:48Z

examples/gno.land/r/gh/oracle.gno

+	accounts       avl.Tree    // uri -> Account
+	repos          avl.Tree    // uri -> Repo
+	issueOrPRs     avl.Tree    // uri -> IssueOrPR


they're not uris

MichaelFrazzy · 2023-10-19T22:41:20Z

@waymobetta

moul · 2023-10-20T14:54:47Z

Related with #1265

@jaekwon

## Current Status ```console $ cd ./misc/list-gnophers $ ./main.sh ``` ```csv 1617467419,[email protected],./examples/gno.land/p/demo/flow/flow.gno 1651096034,[email protected],./examples/gno.land/p/demo/grc/grc721/igrc721.gno 1673524438,[email protected],./examples/gno.land/p/demo/grc/grc721/basic_nft.gno 1677669053,[email protected],./examples/gno.land/p/demo/grc/grc1155/basic_grc1155_token.gno 1678259597,[email protected],./examples/gno.land/r/demo/deep/very/deep/render.gno 1678709422,[email protected],./examples/gno.land/r/demo/groups/group.gno 1684921090,[email protected],./examples/gno.land/p/demo/merkle/merkle.gno 1687179019,[email protected],./examples/gno.land/r/x/nir1218_evaluation_proposal/category.gno 1687263124,[email protected],./examples/gno.land/p/demo/microblog/microblog.gno ``` ## Future Plans - Translate into GitHub usernames. - Share the gnopher list on `r/gh` (#1134). - Create a new `r/gnoland/gnophers` page with the following features: - Add a widget on `r/gnoland/home` displaying the "latest gnophers." - Create a helper function like `r/gnoland/gnophers.NumberByAddr("g1u7y667z64x2h7vc6fmpcprgey4ck233jaww9zq`) -> `(2 int)` to use this info on other meta profiles, such as the future "gnolinkedin" mixing facts and personal presentation (gnolang/game-of-realms#5). - Create a `r/gnoland/gnophers:username` route that returns a badge with the username, gnopher number, "gnopher since <date>," and a `gnoface` (#690). - Stop checking and order t-shirts for the first 100 official gnophers. ### Example Gnopher Badges ```markdown # @jaekwon proudly became the 1st gnopher on Oct 3, 2021. ||||||| ////////\ | | | ~ . | )| X X |. | | | C | | | | __/ | | | \~~~~~~~/ Gnopher#1 ``` ```markdown # @moul proudly became the 2nd gnopher on May 24, 2022. ||||||| ////////\ | | | ~ . | )| X X |. | | | C | | | | __/ | | | \~~~~~~~/ Gnopher#2 ``` cc @gnolang/devrels Signed-off-by: moul <[email protected]>

```console $ cd ./misc/list-gnophers $ ./main.sh ``` ```csv 1617467419,[email protected],./examples/gno.land/p/demo/flow/flow.gno 1651096034,[email protected],./examples/gno.land/p/demo/grc/grc721/igrc721.gno 1673524438,[email protected],./examples/gno.land/p/demo/grc/grc721/basic_nft.gno 1677669053,[email protected],./examples/gno.land/p/demo/grc/grc1155/basic_grc1155_token.gno 1678259597,[email protected],./examples/gno.land/r/demo/deep/very/deep/render.gno 1678709422,[email protected],./examples/gno.land/r/demo/groups/group.gno 1684921090,[email protected],./examples/gno.land/p/demo/merkle/merkle.gno 1687179019,[email protected],./examples/gno.land/r/x/nir1218_evaluation_proposal/category.gno 1687263124,[email protected],./examples/gno.land/p/demo/microblog/microblog.gno ``` - Translate into GitHub usernames. - Share the gnopher list on `r/gh` (gnolang#1134). - Create a new `r/gnoland/gnophers` page with the following features: - Add a widget on `r/gnoland/home` displaying the "latest gnophers." - Create a helper function like `r/gnoland/gnophers.NumberByAddr("g1u7y667z64x2h7vc6fmpcprgey4ck233jaww9zq`) -> `(2 int)` to use this info on other meta profiles, such as the future "gnolinkedin" mixing facts and personal presentation (gnolang/game-of-realms#5). - Create a `r/gnoland/gnophers:username` route that returns a badge with the username, gnopher number, "gnopher since <date>," and a `gnoface` (gnolang#690). - Stop checking and order t-shirts for the first 100 official gnophers. ```markdown ||||||| ////////\ | | | ~ . | )| X X |. | | | C | | | | __/ | | | \~~~~~~~/ Gnopher#1 ``` ```markdown ||||||| ////////\ | | | ~ . | )| X X |. | | | C | | | | __/ | | | \~~~~~~~/ Gnopher#2 ``` cc @gnolang/devrels Signed-off-by: moul <[email protected]> SetTokenURI wip

@jaekwon

## Current Status ```console $ cd ./misc/list-gnophers $ ./main.sh ``` ```csv 1617467419,[email protected],./examples/gno.land/p/demo/flow/flow.gno 1651096034,[email protected],./examples/gno.land/p/demo/grc/grc721/igrc721.gno 1673524438,[email protected],./examples/gno.land/p/demo/grc/grc721/basic_nft.gno 1677669053,[email protected],./examples/gno.land/p/demo/grc/grc1155/basic_grc1155_token.gno 1678259597,[email protected],./examples/gno.land/r/demo/deep/very/deep/render.gno 1678709422,[email protected],./examples/gno.land/r/demo/groups/group.gno 1684921090,[email protected],./examples/gno.land/p/demo/merkle/merkle.gno 1687179019,[email protected],./examples/gno.land/r/x/nir1218_evaluation_proposal/category.gno 1687263124,[email protected],./examples/gno.land/p/demo/microblog/microblog.gno ``` ## Future Plans - Translate into GitHub usernames. - Share the gnopher list on `r/gh` (gnolang#1134). - Create a new `r/gnoland/gnophers` page with the following features: - Add a widget on `r/gnoland/home` displaying the "latest gnophers." - Create a helper function like `r/gnoland/gnophers.NumberByAddr("g1u7y667z64x2h7vc6fmpcprgey4ck233jaww9zq`) -> `(2 int)` to use this info on other meta profiles, such as the future "gnolinkedin" mixing facts and personal presentation (gnolang/game-of-realms#5). - Create a `r/gnoland/gnophers:username` route that returns a badge with the username, gnopher number, "gnopher since <date>," and a `gnoface` (gnolang#690). - Stop checking and order t-shirts for the first 100 official gnophers. ### Example Gnopher Badges ```markdown # @jaekwon proudly became the 1st gnopher on Oct 3, 2021. ||||||| ////////\ | | | ~ . | )| X X |. | | | C | | | | __/ | | | \~~~~~~~/ Gnopher#1 ``` ```markdown # @moul proudly became the 2nd gnopher on May 24, 2022. ||||||| ////////\ | | | ~ . | )| X X |. | | | C | | | | __/ | | | \~~~~~~~/ Gnopher#2 ``` cc @gnolang/devrels Signed-off-by: moul <[email protected]>

@jaekwon

## Current Status ```console $ cd ./misc/list-gnophers $ ./main.sh ``` ```csv 1617467419,[email protected],./examples/gno.land/p/demo/flow/flow.gno 1651096034,[email protected],./examples/gno.land/p/demo/grc/grc721/igrc721.gno 1673524438,[email protected],./examples/gno.land/p/demo/grc/grc721/basic_nft.gno 1677669053,[email protected],./examples/gno.land/p/demo/grc/grc1155/basic_grc1155_token.gno 1678259597,[email protected],./examples/gno.land/r/demo/deep/very/deep/render.gno 1678709422,[email protected],./examples/gno.land/r/demo/groups/group.gno 1684921090,[email protected],./examples/gno.land/p/demo/merkle/merkle.gno 1687179019,[email protected],./examples/gno.land/r/x/nir1218_evaluation_proposal/category.gno 1687263124,[email protected],./examples/gno.land/p/demo/microblog/microblog.gno ``` ## Future Plans - Translate into GitHub usernames. - Share the gnopher list on `r/gh` (gnolang#1134). - Create a new `r/gnoland/gnophers` page with the following features: - Add a widget on `r/gnoland/home` displaying the "latest gnophers." - Create a helper function like `r/gnoland/gnophers.NumberByAddr("g1u7y667z64x2h7vc6fmpcprgey4ck233jaww9zq`) -> `(2 int)` to use this info on other meta profiles, such as the future "gnolinkedin" mixing facts and personal presentation (gnolang/game-of-realms#5). - Create a `r/gnoland/gnophers:username` route that returns a badge with the username, gnopher number, "gnopher since <date>," and a `gnoface` (gnolang#690). - Stop checking and order t-shirts for the first 100 official gnophers. ### Example Gnopher Badges ```markdown # @jaekwon proudly became the 1st gnopher on Oct 3, 2021. ||||||| ////////\ | | | ~ . | )| X X |. | | | C | | | | __/ | | | \~~~~~~~/ Gnopher#1 ``` ```markdown # @moul proudly became the 2nd gnopher on May 24, 2022. ||||||| ////////\ | | | ~ . | )| X X |. | | | C | | | | __/ | | | \~~~~~~~/ Gnopher#2 ``` cc @gnolang/devrels Signed-off-by: moul <[email protected]>

moul self-assigned this Sep 16, 2023

github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Sep 16, 2023

moul changed the title ~~dev/moul/gh oracle~~ GitHub oracle foundations Sep 16, 2023

moul mentioned this pull request Sep 16, 2023

META GitHub oracle & r/gh #1133

Open

moul changed the title ~~GitHub oracle foundations~~ feat: r/github foundations Sep 16, 2023

moul changed the title ~~feat: r/github foundations~~ feat: initial r/gh realm Sep 16, 2023

feat: add foundations for a github oracle

8760b6a

Signed-off-by: Manfred Touron <[email protected]>

moul force-pushed the dev/moul/gh-oracle branch from 8a8ea33 to 8760b6a Compare September 16, 2023 20:20

moul marked this pull request as ready for review September 16, 2023 20:27

moul requested a review from a team as a code owner September 16, 2023 20:27

moul added 2 commits September 16, 2023 22:44

chore: fixup

277b4ef

Signed-off-by: Manfred Touron <[email protected]>

Merge branch 'master' into dev/moul/gh-oracle

76eaaa0

moul added this to the 🌟 main.gno.land (wanted) milestone Sep 16, 2023

Merge branch 'master' into dev/moul/gh-oracle

5b6cdf7

Merge branch 'master' into dev/moul/gh-oracle

517a002

harry-hov reviewed Sep 28, 2023

View reviewed changes

moul requested review from gfanton, waymobetta, leohhhn and MichaelFrazzy September 29, 2023 06:32

MichaelFrazzy approved these changes Oct 3, 2023

View reviewed changes

thehowl self-requested a review October 12, 2023 16:18

thehowl mentioned this pull request Oct 12, 2023

Minutes: GitHub Review Meetings [every Thursday] gnolang/meetings#18

Open

3 tasks

thehowl reviewed Oct 13, 2023

View reviewed changes

moul requested a review from MichaelFrazzy October 19, 2023 22:20

moul mentioned this pull request Oct 20, 2023

chore: add misc/list-gnophers and .mailmap #1265

Merged

moul mentioned this pull request Oct 25, 2023

chore: add tshirt-size labels for worx effort estimation #1292

Closed

5 tasks

n0izn0iz mentioned this pull request Mar 18, 2024

Teritori's Builder Journey gnolang/hackerspace#7

Open

Kouteki modified the milestones: 🌟 main.gno.land (wanted), ⏭️Next after mainnet Oct 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: initial `r/gh` realm #1134

feat: initial `r/gh` realm #1134

moul commented Sep 16, 2023 •

edited

Loading

codecov bot commented Sep 18, 2023 •

edited

Loading

harry-hov Sep 28, 2023

harry-hov Sep 28, 2023

moul Sep 29, 2023

MichaelFrazzy commented Oct 1, 2023 •

edited

Loading

MichaelFrazzy left a comment •

edited

Loading

thehowl Oct 13, 2023

thehowl Oct 13, 2023

thehowl Oct 13, 2023

thehowl Oct 13, 2023

thehowl Oct 13, 2023

thehowl Oct 13, 2023

thehowl Oct 13, 2023

thehowl Oct 13, 2023

thehowl Oct 13, 2023

MichaelFrazzy commented Oct 19, 2023

moul commented Oct 20, 2023


		func OracleLastUpdated() time.Time { return lastUpdateTime }

		func OracleUpsertAccount(id, name, kind string) {

feat: initial r/gh realm #1134

Are you sure you want to change the base?

feat: initial r/gh realm #1134

Conversation

moul commented Sep 16, 2023 • edited Loading

codecov bot commented Sep 18, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MichaelFrazzy commented Oct 1, 2023 • edited Loading

MichaelFrazzy left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MichaelFrazzy commented Oct 19, 2023

moul commented Oct 20, 2023

feat: initial `r/gh` realm #1134

feat: initial `r/gh` realm #1134

moul commented Sep 16, 2023 •

edited

Loading

codecov bot commented Sep 18, 2023 •

edited

Loading

MichaelFrazzy commented Oct 1, 2023 •

edited

Loading

MichaelFrazzy left a comment •

edited

Loading