Package common provides shared realm utilities for GnoSwap protocol contracts.
Package common provides shared realm utilities for GnoSwap protocol contracts.
The common package contains shared GRC20 token operations and native coin validation.
The root Render("") delegates to the active implementation and shows the realm address, implementation path, and network-wide token registry count. The count is not a Gnoswap whitelist. Token keys use realm-path.SYMBOL, and token amounts use each token's base units.
Rendering is read-only and does not enumerate registry entries. Unsupported paths return 404.
The write helpers are called without crossing, for example
common.Transfer(0, cur, ...) and common.SafeGRC20Transfer(0, cur, ...).
The token actor is bound to that current realm via RealmTeller before the operation is forwarded.
Token lookup goes through the registered implementation (common/v1 resolves gno.land/r/nt/grc20reg/v0),
which is swapped with UpgradeImpl like the other proxy realms.
Token Operations:
Token Queries:
Token Transfers:
Coin Validation:
[GNOSWAP-COMMON-002] handle native coin is not allowed when unsafe.OriginSend() is non-emptyPackage common provides shared realm utilities for GnoSwap protocol contracts.
The package contains helpers that must keep a realm boundary, including GRC20 token operations and native coin validation. AMM math lives in gno.land/p/gnoswap/gnsmath/v1.
Key components: - GRC20 Registry Helpers: convenient wrappers for GRC20 token operations - Coin Utilities: native coin handling and validation - Assertion Utilities: input validation for supported operations, including native-coin rejection
Allowance returns the token allowance from owner to spender.
Parameters:
Returns:
Approve forwards an allowance update to the implementation bound to the current realm.
Parameters:
Returns:
AssertIsNotHandleNativeCoin validates that no native coins were sent with the transaction.
Use this when a function should only work with GRC20 tokens and not accept native coins.
BalanceOf returns the token balance for the specified address.
Parameters:
Returns:
GetImplementationPackagePath returns the package path of the currently selected common implementation.
Returns:
IsRegistered checks whether a token key is registered.
Parameters:
Returns:
MustRegistered checks whether all provided tokens are registered and panics if any is not registered.
Parameters:
Panics if any of the provided tokens is not registered.
RegisterInitializer registers the versioned common implementation initializer and activates the implementation returned by it.
Parameters:
Render delegates web rendering to the active implementation.
SafeGRC20Approve approves tokens as the current realm and panics if it fails.
Parameters:
Panics if the underlying approval returns an error.
SafeGRC20Transfer transfers tokens as the current realm and panics if it fails.
Parameters:
Panics if the underlying transfer returns an error.
1func SafeGRC20TransferFrom(_ int, rlm realm, tokenKey string, from, to address, amount int64)SafeGRC20TransferFrom transfers tokens as the current realm and panics if it fails.
Parameters:
Panics if the underlying transfer returns an error.
TotalSupply returns the total supply of the specified token.
Parameters:
Returns:
Transfer forwards a token transfer to the implementation bound to the current realm.
Parameters:
Returns:
TransferFrom forwards an allowance-backed token transfer to the implementation bound to the current realm.
Parameters:
Returns:
UpgradeImpl changes the active common implementation package and refreshes the cached implementation.
Parameters:
ValidateRegistered checks whether all provided tokens are registered, returning an error instead of panicking when a token is not registered.
Parameters:
Returns:
1type ICommon interface {
2 // ValidateNotHandleNativeCoin rejects a call carrying native coins.
3 //
4 // Returns:
5 // - error: non-nil when the transaction includes native coins; nil when no native coins are attached
6 ValidateNotHandleNativeCoin() error
7
8 // IsRegistered checks whether tokenKey identifies a registered token.
9 //
10 // Parameters:
11 // - tokenKey: token registry key to validate and look up
12 //
13 // Returns:
14 // - error: nil when tokenKey is valid and registered; non-nil for an invalid or unregistered key
15 IsRegistered(tokenKey string) error
16
17 // ValidateRegistered checks each token key in order.
18 //
19 // Parameters:
20 // - tokenKeys: token registry keys that must all be valid and registered
21 //
22 // Returns:
23 // - error: nil when every key is registered; otherwise the first registration failure in input order
24 ValidateRegistered(tokenKeys ...string) error
25
26 // TotalSupply returns the total supply of a registered token.
27 //
28 // Parameters:
29 // - tokenKey: token registry key whose supply is queried
30 //
31 // Returns:
32 // - totalSupply: token's total supply; panics if tokenKey is invalid or unregistered
33 TotalSupply(tokenKey string) int64
34
35 // BalanceOf returns a registered token's balance for an address.
36 //
37 // Parameters:
38 // - tokenKey: token registry key whose balance is queried
39 // - addr: account address whose token balance is queried
40 //
41 // Returns:
42 // - balance: token units held by addr; panics if tokenKey is invalid or unregistered
43 BalanceOf(tokenKey string, addr address) int64
44
45 // Allowance returns the approved spendable amount for an owner/spender pair.
46 //
47 // Parameters:
48 // - tokenKey: token registry key whose allowance is queried
49 // - owner: account that granted spending approval
50 // - spender: account allowed to spend owner's tokens
51 //
52 // Returns:
53 // - allowance: token units owner has approved for spender; panics if tokenKey is invalid or unregistered
54 Allowance(tokenKey string, owner, spender address) int64
55
56 // Transfer asks the token teller bound to rlm to move tokens to to.
57 //
58 // Parameters:
59 // - _: leading token-call discriminator; callers pass 0
60 // - rlm: propagated realm context used to bind the token teller and invoke the transfer
61 // - tokenKey: token registry key whose tokens are transferred
62 // - to: recipient account address
63 // - amount: number of token units to transfer
64 //
65 // Returns:
66 // - error: nil when the teller completes the transfer; non-nil when token validation or transfer rules reject it
67 Transfer(_ int, rlm realm, tokenKey string, to address, amount int64) error
68
69 // TransferFrom asks the token teller bound to rlm to transfer tokens from one account to another.
70 //
71 // Parameters:
72 // - _: leading token-call discriminator; callers pass 0
73 // - rlm: propagated realm context used to bind the token teller and invoke the transfer
74 // - tokenKey: token registry key whose tokens are transferred
75 // - from: account whose token balance is debited
76 // - to: recipient account address
77 // - amount: number of token units to transfer
78 //
79 // Returns:
80 // - error: nil when the teller completes the transfer; non-nil when token validation, allowance, or balance rules reject it
81 TransferFrom(_ int, rlm realm, tokenKey string, from, to address, amount int64) error
82
83 // Approve asks the token teller bound to rlm to set spender's allowance.
84 //
85 // Parameters:
86 // - _: leading token-call discriminator; callers pass 0
87 // - rlm: propagated realm context used to bind the token teller and invoke approval
88 // - tokenKey: token registry key whose tokens are approved
89 // - spender: account receiving permission to spend the caller's tokens
90 // - amount: number of token units to authorize
91 //
92 // Returns:
93 // - error: nil when the teller records the allowance; non-nil when token validation or approval rules reject it
94 Approve(_ int, rlm realm, tokenKey string, spender address, amount int64) error
95 Render(path string) string
96}