feat(stdlibs/std)!: namespace minted coins with realm path #875

r3v4s · 2023-06-07T09:36:53Z

Previous & Related PR

Description

BREAKING CHANGE: banker will not use raw(input) denom for minting

Currently, there is a bug that additional coins are mintable using banker.
Lots of discussing were made in #393, this PR include following.

It aims to use pkg_path that called (banker or Mint) as prefix for denom(Similar to IBC Spec)

ibc_denom := 'ibc/' + hash('path' + 'base_denom')
denom_in_this_pr := '{pkg_path}:denom'

2. As @piux2 mentioned here currently gno has very inflexible format regexp for denom
-- Changed to same as Cosmos's regex, but without capitals

### is some issue about using std.GetOrigCaller or std.PrevRealm
Some of you might be wonder why I made some packaged called istd, I made a issue: #876
Update: After @thehowl's native binding PR, doesn't need this kind of work around

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

Maintainers Checklist

Checked that the author followed the guidelines in CONTRIBUTING.md
Checked the conventional-commit (especially PR title and verb, presence of BREAKING CHANGE: in the body)
Ensured that this PR is not a significant change or confirmed that the review/consideration process was appropriate for the change

gnovm/stdlibs/std/banker.gno

gnovm/stdlibs/internal/std/frame.gno

thehowl

Hi @r3v4s, we discussed on how to best tackle this, both to try avoiding duplicating std into internal/std and also to have the code here effectively make sense.

Let's work to do this instead:

Remove stdlibs/internal/std and the current changes to stdlibs.go (to add PrevRealm to internal/std)
Create a new type of banker inside of stdlibs/banker.go, called RealmIssueBanker.
- This shall be returned by the native GetBanker with BankerType BankerTypeRealmIssue
- The realm is initialized with the PrevRealm values pkgPath and addr. Maybe split out the internal code of PrevRealm (with the for-loop etc.) into a function which returns 2 strings: (pkgPath, addr string)
When RealmIssueBanker.IssueCoins is called, you add the code you inserted into gnovm/stdlibs/std/banker.gno, and you remove it from there.

WDYT?

Thanks!

r3v4s · 2023-09-08T06:24:57Z

@thehowl Looking good! That will remove inevitable use of code redundancy and logic will be more simple. Will work on that

// UPDATE
stdlibs.go already had BankerTypeRealmIssue type which native GetBanker was returning banker it self. I couldn't find any good reason to return banker, so changed it to return RealmIssueBanker

leohhhn

Hey @r3v4s, I left some comments, please check them out 🙏

@thehowl, can you take a look at this one final time so that we can get it merged?

gno.land/cmd/gnoland/testdata/realm-banker-issued-coin-denom.txtar

gnovm/stdlibs/std/banker.go

thehowl

I am approving these changes, because this PR has been stuck in review forever and it already does an important step in the right direction. Please, tackle these last comments and we're good to go. Sorry for the long wait.

That said, soon after this is merged, I think we'll need to change this API again. This current implementation creates an inconsistency within the Banker API. All other banker methods now require you to pass in the full realm path to the token you're referring to, but IssueCoin and RemoveCoin do not.

Thus, I think a few more changes are in order:

There should be a RealmDenom(pkgpath, denom string) function in std, which creates a realm denomination (ie. /gno.land/r/morgan:bitcoin). There can be a helper method Realm.Denom(denom string) (so you can do std.CurrentRealm().Denom("bitcoin")
Instead of modifying denom's value in the native function, we should check it matches what we expect. ie. strings.HasPrefix(denom, RealmDenom(std.CurrentRealm().PkgPath()), then check the last part of the denom to see that it matches the Gno regex. (This can all be done in gno, without needing to put it in native code)

This should make it more consistent & easier to use realm denominations. Still, it's a UX issue, while this one tackles what is effectively a security issue; so let's start from here.

gnovm/stdlibs/std/banker.go

tm2/pkg/std/coin.go

gno.land/cmd/gnoland/testdata/realm-banker-issued-coin-denom.txtar

thehowl

Sorry. The test LGTM

gnovm/stdlibs/std/banker.go

@piux2

# Previous & Related PR gnolang#393 # Description ## BREAKING CHANGE: banker will not use raw(input) denom for minting Currently, there is a bug that additional coins are mintable using banker. Lots of discussing were made in gnolang#393, this PR include following. 1. It aims to use `pkg_path` that called (banker or Mint) as prefix for denom(Similar to IBC Spec) ``` ibc_denom := 'ibc/' + hash('path' + 'base_denom') denom_in_this_pr := '{pkg_path}:denom' ``` ~2. As @piux2 mentioned [here](gnolang#393 (comment)) currently gno has very inflexible format regexp for denom -- Changed to same as Cosmos's regex, but without capitals~ ~### is some issue about using `std.GetOrigCaller` or `std.PrevRealm` Some of you might be wonder why I made some packaged called `istd`, I made a issue: gnolang#876~ Update: After @thehowl's native binding PR, doesn't need this kind of work around ## Contributors Checklist - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [ ] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests ## Maintainers Checklist - [ ] Checked that the author followed the guidelines in `CONTRIBUTING.md` - [ ] Checked the conventional-commit (especially PR title and verb, presence of `BREAKING CHANGE:` in the body) - [ ] Ensured that this PR is not a significant change or confirmed that the review/consideration process was appropriate for the change --------- Co-authored-by: Morgan <[email protected]>

Introduced in #875, but only managed to review after it was merged.

…#2106) Introduced in gnolang#875, but only managed to review after it was merged.

Just to avoid [this comment](#875 (comment)) again :)

@thehowl

fix #2107 -------------------------- ## Problem > From [#875 (review)](#875 (review)): > > > That said, soon after this is merged, I think we'll need to change this API again. This current implementation creates an inconsistency within the Banker API. All other banker methods now require you to pass in the full realm path to the token you're referring to, but IssueCoin and RemoveCoin do not. > > Thus, I think a few more changes are in order: > > > > 1. There should be a `RealmDenom(pkgpath, denom string)` function in `std`, which creates a realm denomination (ie. `/gno.land/r/morgan:bitcoin`). There can be a helper method `Realm.Denom(denom string)` (so you can do `std.CurrentRealm().Denom("bitcoin")` > > 2. Instead of modifying `denom`'s value in the native function, we should check it matches what we expect. ie. `strings.HasPrefix(denom, RealmDenom(std.CurrentRealm().PkgPath())`, then check the last part of the denom to see that it matches the Gno regex. (This can all be done in gno, without needing to put it in native code) > > Related with #1475 #1576 ------------------------- ## Solution BREAKING CHANGE: All previous realm calling IssueCoin or RemoveCoin are now expected to append the prefix "/" + realmPkgPath + ":" before the denom, it should be done by using ``std.CurrentRealm().CoinDenom(denom string)`` or by using ``std.CoinDenom(pkgPath, denom string)`` For now to avoid to mix coins and fix security issues like being able to issue coins from other realm, when a realm issue a coin, the pkg path of the realm is added as a prefix to the coin. the thing is some function expect only the base denom ``bitcoin`` (issue & remove) but the others like get require the qualified denom ``gno.land/r/demo/banktest:bitcoin``. it can be confusing I also answer the requirements of the comment @thehowl made: - Two functions are now available ``std.CoinDenom(pkgpath, demon string)`` && the method ``std.Realm.CoinDenom(denom string)`` - the denom's value is changed in the `.gno` file and not the native. Here is an example of how it looks like: ```go func IssueNewCoin(denom string, amount int64) string { std.AssertOriginCall() banker := std.GetBanker(std.BankerTypeRealmIssue) addr := std.PrevRealm().Addr() banker.IssueCoin(addr, std.CurrentRealm().CoinDenom(denom), amount) return std.CurrentRealm().Denom(denom) } func RemoveCoin(denom string, amount int64) { std.AssertOriginCall() banker := std.GetBanker(std.BankerTypeRealmIssue) addr := std.PrevRealm().Addr() banker.RemoveCoin(addr, std.CurrentRealm().CoinDenom(denom), amount) } func GetCoins(denom string) uint64 { banker := std.GetBanker(std.BankerTypeReadonly) addr := std.PrevRealm().Addr() coins := banker.GetCoins(addr) for _, coin := range coins { if coin.Denom == std.CurrentRealm().CoinDenom(denom) { return uint64(coin.Amount) } } return 0 } ``` <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [x] Provided any useful hints for running manual tests </details> --------- Co-authored-by: Morgan Bazalgette <[email protected]> Co-authored-by: Leon Hudak <[email protected]>

github-actions bot added 📦 🌐 tendermint v2 Issues or PRs tm2 related 📦 🤖 gnovm Issues or PRs gnovm related labels Jun 7, 2023

github-actions bot assigned r3v4s Jun 7, 2023

r3v4s changed the title ~~Fix/gnot mintable~~ fix coins are being minted by banker Jun 7, 2023

This was referenced Jun 7, 2023

fix: minting additional GNOTs #393

Closed

Calling injected function in same package files (returns undefined error) #876

Closed

[META] 🏗4️⃣ test4.gno.land #362

Closed

r3v4s changed the title ~~fix coins are being minted by banker~~ Change denom of coin that minted by banker Jun 13, 2023

r3v4s force-pushed the fix/gnot-mintable branch from 844c616 to edd5d2d Compare June 13, 2023 03:58

r3v4s marked this pull request as ready for review June 13, 2023 03:59

r3v4s requested review from jaekwon and moul as code owners June 13, 2023 03:59

moul reviewed Jun 16, 2023

View reviewed changes

gnovm/stdlibs/std/banker.gno Outdated Show resolved Hide resolved

moul reviewed Jun 16, 2023

View reviewed changes

gnovm/stdlibs/internal/std/frame.gno Outdated Show resolved Hide resolved

r3v4s mentioned this pull request Jul 27, 2023

[META] Gno Wishlist / Feature Request Dump #975

Open

moul mentioned this pull request Jul 27, 2023

Banker should use PrevRealm instead of OrigPkgAddr #986

Closed

moul added this to the 🚀 main.gno.land milestone Sep 6, 2023

moul requested review from thehowl, piux2 and moul September 6, 2023 16:44

thehowl requested changes Sep 7, 2023

View reviewed changes

thehowl mentioned this pull request Sep 7, 2023

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

Open

3 tasks

tbruyelle mentioned this pull request Sep 8, 2023

refactor(gnovm): make IsOriginCall/AssertOriginCall rely on PrevRealm #1048

Closed

7 tasks

r3v4s force-pushed the fix/gnot-mintable branch from 4a067d5 to 040fdd1 Compare September 15, 2023 11:31

r3v4s requested a review from a team as a code owner September 15, 2023 11:31

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

r3v4s changed the title ~~Change denom of coin that minted by banker~~ feat: change denom of coin that minted by banker Sep 15, 2023

dongwon8247 mentioned this pull request Sep 20, 2023

Onbloc's Builder Journey gnolang/hackerspace#29

Open

dongwon8247 mentioned this pull request Oct 16, 2023

Gno Core Issue Tracker gnoswap-labs/gno#7

Open

18 tasks

r3v4s added 4 commits March 29, 2024 17:50

test: mint coin from long named package

5ffae5c

feat: check origin denom first, then make a new one with pkg_path

eea0c8c

feat: new regex to check denom

e001ac7

fix: test failing

9897814

r3v4s marked this pull request as ready for review March 29, 2024 13:01

r3v4s requested a review from thehowl March 29, 2024 13:01

harry-hov self-requested a review April 8, 2024 13:44

leohhhn approved these changes May 3, 2024

View reviewed changes

gno.land/cmd/gnoland/testdata/realm-banker-issued-coin-denom.txtar Outdated Show resolved Hide resolved

gno.land/cmd/gnoland/testdata/realm-banker-issued-coin-denom.txtar Show resolved Hide resolved

gnovm/stdlibs/std/banker.go Outdated Show resolved Hide resolved

Merge branch 'gnolang:master' into fix/gnot-mintable

9c5388b

r3v4s requested a review from a team as a code owner May 7, 2024 03:20

chore: clarify why such a balance is derived

f9b87b6

thehowl mentioned this pull request May 7, 2024

limit import path length #2053

Closed

thehowl approved these changes May 7, 2024

View reviewed changes

gnovm/stdlibs/std/banker.go Outdated Show resolved Hide resolved

tm2/pkg/std/coin.go Outdated Show resolved Hide resolved

gno.land/cmd/gnoland/testdata/realm-banker-issued-coin-denom.txtar Outdated Show resolved Hide resolved

thehowl changed the title ~~feat: change denom of coin that minted by banker~~ feat(stdlibs/td)!: namespace minted coins with realm path May 7, 2024

thehowl changed the title ~~feat(stdlibs/td)!: namespace minted coins with realm path~~ feat(stdlibs/std)!: namespace minted coins with realm path May 8, 2024

r3v4s added 3 commits May 9, 2024 21:05

chore: constant regex

3838b51

chore

362cd1c

test: spend all ugnot to make it clear

0d39abd

thehowl reviewed May 9, 2024

View reviewed changes

gnovm/stdlibs/std/banker.go Outdated Show resolved Hide resolved

gnovm/stdlibs/std/banker.go Outdated Show resolved Hide resolved

thehowl mentioned this pull request May 9, 2024

chore(lint): forbid usage of regexp.Match(String)? #2066

Merged

refactor: better regex

5311666

zivkovicmilos merged commit c30d0f1 into gnolang:master May 14, 2024
222 checks passed

This was referenced May 14, 2024

chore(stdlibs/std): use appropriate variable names for regex #2106

Merged

Expect full denoms in Banker.IssueCoin and Banker.RemoveCoin #2107

Closed

harry-hov pushed a commit that referenced this pull request May 16, 2024

chore(stdlibs/std): use appropriate variable names for regex (#2106)

3c37507

Introduced in #875, but only managed to review after it was merged.

leohhhn pushed a commit to leohhhn/gno that referenced this pull request May 21, 2024

chore(stdlibs/std): use appropriate variable names for regex (gnolang…

4bbf429

…#2106) Introduced in gnolang#875, but only managed to review after it was merged.

thehowl added a commit that referenced this pull request May 26, 2024

chore(lint): forbid usage of regexp.Match(String)? (#2066)

50bf659

Just to avoid [this comment](#875 (comment)) again :)

MikaelVallenet mentioned this pull request Nov 29, 2024

fix(std): add full denom in banker issue & remove coin #3239

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(stdlibs/std)!: namespace minted coins with realm path #875

feat(stdlibs/std)!: namespace minted coins with realm path #875

r3v4s commented Jun 7, 2023 •

edited

Loading

thehowl left a comment

r3v4s commented Sep 8, 2023 •

edited

Loading

leohhhn left a comment

thehowl left a comment

thehowl left a comment

feat(stdlibs/std)!: namespace minted coins with realm path #875

feat(stdlibs/std)!: namespace minted coins with realm path #875

Conversation

r3v4s commented Jun 7, 2023 • edited Loading

Previous & Related PR

Description

BREAKING CHANGE: banker will not use raw(input) denom for minting

Contributors Checklist

Maintainers Checklist

thehowl left a comment

Choose a reason for hiding this comment

r3v4s commented Sep 8, 2023 • edited Loading

leohhhn left a comment

Choose a reason for hiding this comment

thehowl left a comment

Choose a reason for hiding this comment

thehowl left a comment

Choose a reason for hiding this comment

r3v4s commented Jun 7, 2023 •

edited

Loading

r3v4s commented Sep 8, 2023 •

edited

Loading