ucs03_zkgm state

SelectorUpdateImpl

SelectorSetBucketConfig

SelectorSetRateLimitDisabled

SelectorPausable

SetBucketConfig

SetBucketConfig creates or updates the per-denom send-side rate-limit bucket. The bucket is anchored to block time, so RefillRate is tokens per second.

SetRateLimitDisabled

SetRateLimitDisabled toggles the global rate-limit kill switch.

Pausable

Pausable toggles the global pause gate checked by every App receiver.

App

app.gno is the App receiver surface: the core-driven half of the proxy. core holds this App reference permanently (its port is keyed by the proxy pkgpath and re-registration is rejected), so App is the stable IBC identity and must never carry business logic. Every receiver gates on assertIsCoreRealm and assertIsNotPaused before delegating to the installed impl or rejecting channel close. Logic lives in the impl realm; authority and funds live in the proxy. See assert.gno for the gates and upgrade.gno for the swap point.

assertIsCoreRealm

assertIsRlmCurrent

assertIsProxyRealm

assertIsNotPaused

EmitRecvError

EmitNativeReleased

EmitForwardInFlightSet

EmitForwardInFlightPopped

ErrSpoofedRealm

ErrSpoofedRealm guards non-crossing (\_ int, rlm realm, ...) entrypoints: the passed rlm must be the current crossing frame, not a forged or stale token replayed by a caller.

ErrNotProxyRealm

ErrSpoofedRealm guards non-crossing (\_ int, rlm realm, ...) entrypoints: the passed rlm must be the current crossing frame, not a forged or stale token replayed by a caller.

ErrNotCoreRealm

ErrSpoofedRealm guards non-crossing (\_ int, rlm realm, ...) entrypoints: the passed rlm must be the current crossing frame, not a forged or stale token replayed by a caller.

ErrInvalidSaltLength

ErrSpoofedRealm guards non-crossing (\_ int, rlm realm, ...) entrypoints: the passed rlm must be the current crossing frame, not a forged or stale token replayed by a caller.

ErrTokenBucketNotFound

ErrSpoofedRealm guards non-crossing (\_ int, rlm realm, ...) entrypoints: the passed rlm must be the current crossing frame, not a forged or stale token replayed by a caller.

ErrChannelBalanceV2NotFound

ErrSpoofedRealm guards non-crossing (\_ int, rlm realm, ...) entrypoints: the passed rlm must be the current crossing frame, not a forged or stale token replayed by a caller.

ErrLockedTokenAmountOverflow

ErrSpoofedRealm guards non-crossing (\_ int, rlm realm, ...) entrypoints: the passed rlm must be the current crossing frame, not a forged or stale token replayed by a caller.

ErrInterfaceConversion

ErrSpoofedRealm guards non-crossing (\_ int, rlm realm, ...) entrypoints: the passed rlm must be the current crossing frame, not a forged or stale token replayed by a caller.

ZkgmImplUpdatedEvent

ZkgmPausedEvent

ZkgmUnpausedEvent

ZkgmRateLimitBucketConfiguredEvent

ZkgmRateLimitDisabledSetEvent

ZkgmReceiverRegisteredEvent

ZkgmNativeReleasedEvent

ZkgmForwardInFlightSetEvent

ZkgmForwardInFlightPoppedEvent

ZkgmRecvErrorEvent

emitZkgmImplUpdatedEvent

emitZkgmPausedEvent

emitZkgmUnpausedEvent

emitZkgmRateLimitBucketConfiguredEvent

emitZkgmRateLimitDisabledSetEvent

emitZkgmReceiverRegisteredEvent

emitZkgmNativeReleasedEvent

emitZkgmForwardInFlightSetEvent

emitZkgmForwardInFlightPoppedEvent

emitRecvError

GetTokenBucket

GetTokenBucket returns the rate-limit bucket for a denom.

GetChannelBalanceV2

GetChannelBalanceV2 returns the escrow balance for a key.

GetLockedTokenAmount

GetLockedTokenAmount returns the total base-token amount permanently locked for a denom.

GetVoucherList

GetVoucherList returns a page of up to count wrapped voucher tokens starting at offset, ordered by denom.

GetVoucherInfo

GetVoucherInfo returns a snapshot of the single wrapped voucher registered for ibcDenom.

GetVoucherSize

GetVoucherSize returns the total number of registered vouchers, i.e. the key count callers need to drive GetVoucherList's offset/count pagination.

RegisterCoreApp

RegisterCoreApp registers the proxy App with core under the proxy pkgpath. core rejects re-registration, so the App identity is permanent once installed.

RegisterReceiver

RegisterReceiver records the calling realm as an OP\_CALL receiver target, keyed by its package path. The impl looks it up via store.GetReceiver during call dispatch.

store

paused

proxyPkgPath

proxyAddress

currentImplPath

currentImpl

implConstructors

init.59

Store

NewStore

Send

SendRaw

SendRaw sends a ZKGM packet from hex-encoded instruction fields. Use this entry point from gnokey maketx call (not maketx run) so OriginSend captures any native coins attached with -send for escrow-bearing instructions. - channelId: local source IBC channel id on this chain. - timeoutTimestamp: packet expiry in nanoseconds since the Unix epoch. - saltHex: 32-byte send salt as hex; an optional 0x prefix is accepted. - version: instruction version byte (e.g. 2 for TokenOrderV2). - opcode: instruction opcode (0=Forward, 1=Call, 2=Batch, 3=TokenOrder). - operandHex: ABI-encoded instruction operand as hex; 0x prefix optional.

parseHex

Version

IApp

IAppIntent

IAppTransfer

IAppTransfer is the user-initiated send surface. zkgm is a general instruction protocol (token order / batch / call / forward), so Send takes a raw Instruction rather than a token-transfer shaped argument list.

IAppVoucher

IAppVoucher is the wrapped-voucher self-service surface: it lets a holder grant an allowance or move their own balance directly, without exposing the mint/burn capability that Store's Voucher.Ledger() carries.

IAppGetter

IAppGetter is the read-only query surface implemented by the impl and exposed by the proxy's getters.gno.

IStore

ProxyPkgPath

ProxyAddress

RegisterImpl

RegisterImpl records an impl constructor under the calling realm's package path. It is called from the impl realm's init, so the path is permanent once installed: re-registration is rejected. The caller must be a sub-realm of this proxy (its path must be prefixed by the proxy path), matching core's host registration rule.

UpdateImpl

UpdateImpl installs or re-points the implementation following the bootstrap and steady-state tiers of the trust model. It is admin-gated and injects the proxy-owned store into the registered constructor for path.

mustGetImpl

mustGetImpl returns the installed impl, panicking until the first UpdateImpl.

Voucher

Voucher bundles a wrapped grc20 token, its private mint/burn ledger, and the origin token's decimal precision. It is proxy-owned state held in the Store, so its mint/burn rights survive impl upgrades. Packet amounts are in the origin token's decimals; the grc20 ledger holds them downscaled to the (possibly capped) ledger decimals, so they fit int64. MintScaled / BurnScaled / TransferScaled apply that downscale, so callers never combine the scale and the ledger by hand; the raw int64 ops stay reachable via Ledger(). SECURITY: those methods and Ledger() all hand out the mint/burn capability, so a \*Voucher must stay impl-gated. The Store is injected and never publicly returned, so untrusted realms can only read balances via VoucherBalanceOf.

NewVoucher

NewVoucher is a crossing-safe constructor, so the impl realm can build one without tripping the foreign-composite-literal rule. originDecimals is the origin token's precision; the ledger token is created at min(originDecimals, ledger cap).

VoucherInfo

VoucherInfo is a read-only snapshot of a wrapped voucher's grc20 identity for the voucher-list getter. It carries only scalar fields copied out of Voucher/Token — no token/ledger handles — so listing vouchers never hands out the mint/burn capability that \*Voucher.Ledger() exposes.

NewVoucherInfo

NewVoucherInfo is a crossing-safe constructor, so the impl realm (and test doubles) can build one without tripping the foreign-composite-literal rule.

VoucherApprove

VoucherApprove lets the caller grant spender an allowance on their own wrapped-voucher balance for ibcDenom, so the voucher can be used through GRC20-composable flows (e.g. Gnoswap) that rely on TransferFrom.

VoucherTransfer

VoucherTransfer lets the caller move their own wrapped-voucher balance for ibcDenom directly to another address.

VoucherBalanceOf

VoucherBalanceOf returns addr's wrapped-voucher balance for ibcDenom, or 0 if none. It reads the proxy-owned Store, so the balance survives impl upgrades and does not depend on grc20reg's key.