Skip to content Search Apps Documentation Source Content File Folder Download Copy Actions State String Boolean Number Struct Map Slice Pointer Function Closure Reference Nil Package Type Interface Unknown

Community realm. Read the code first. Community realm, deployed by its author. Read the code before you interact or send coins.

hlbubble state

Back to all declarations

namespace

untyped string

Value

"gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/"

pkgPath

untyped string

// must match gnomod.toml

Value

"gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/hlbubble"

mailboxPath

untyped string

Value

"gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/hlmailbox"

feesPath

untyped string

Value

"gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/hlfees"

bubblePath

untyped string

// the live token realm, never redeployed

Value

"gno.land/r/g1leu8d2vsplhehcfkjg50mwgdpxdkt8tztu95wr/bubble"

hlgnotPath

untyped string

Value

"gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/hlgnot"

hlgovPath

untyped string

Value

"gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/hlgov"

one

int64

// one BUBBLE in base units

Value

1000000

launchFee

int64

Value

100000000

launchMinimum

int64

Value

200000000

launchFeeFloor

int64

Value

40000000

launchCapFloor

int64

Value

10000000000

launchMaximum

int64

Value

25000000000

launchRouter

untyped string

// the BUBBLE token program ETqUXu1uJPj8qgmw8AJMqhgWuL5QW5ymgUMiCARbXYPA

Value

"c807d773013b14cee2855ca9efafeac0b3bbc3a42fd397c2fbffda6417d290f1"

maxI64

uint64

Value

9223372036854775807

launchGovernor

.uverse.address

launchGovernor is the governor (M1k): the mailbox's, compiled here too so a member reads it in this realm's served source; init refuses a deploy with another. bridge/local/e2e.sh swaps it for gnodev's test1.

Value

<gnolang.StringValue>

mustHex

func(s string, what string) []uint8
Open
OID
013123…a1f4:27
mustHex details

Inspect func

isRealm

func(a .uverse.address) bool

isRealm is whether an address is a realm of the bridge: the six compiled here, every route realm the mailbox registers (R39: a successor's address is refused as a recipient at send and swept at a credit, to be credited to its owner by id, never paid into a realm's account outside every counter) and every one it dropped (AT6: a re-pointed-away successor, a route no more that nothing of the line can move BUBBLE out of). A handful of reads.

Open
OID
013123…a1f4:28
isRealm details

Inspect func

mustNotBePaused

func(fn string)
Open
OID
013123…a1f4:30
mustNotBePaused details

Inspect func

mustNotBeDropped

func()

mustNotBeDropped refuses a realm the mailbox dropped from its line (R35): its predecessor re-pointed the migration to another successor while this realm had pulled nothing, so it is a route no more — Solana's token may still name it the router until the next kind 6, and a send or a credit here would be against a lock no realm of the line holds. The mailbox refuses its Dispatch and its Process too; the line's last realm takes every message addressed to it once its import has ended.

Open
OID
013123…a1f4:31
mustNotBeDropped details

Inspect func

Locked

func() int64

Locked is the lock: what backs synthetic BUBBLE on Solana, by the counters (sent − paid).

Open
OID
013123…a1f4:34
Locked details

Inspect func

Balance

func() int64

Balance is the BUBBLE this realm holds; it is the lock unless someone sent BUBBLE here outside a transfer.

Open
OID
013123…a1f4:35
Balance details

Inspect func

Router

func() string

Router is the enrolled router on Solana, in hex.

Open
OID
013123…a1f4:36
Router details

Inspect func

Domain

func() uint32

Domain is the Solana domain this route sends to and takes from.

Open
OID
013123…a1f4:37
Domain details

Inspect func

Counters

func() (sentTotal int64, paidTotal int64, owed int64, voided int64, lost int64)

Counters is the identity's five counters (§5.9): sentTotal, paidTotal, owed, voided, lost.

Open
OID
013123…a1f4:44
Counters details

Inspect func

Migrated

func() string

Migrated is the successor's pkgpath once a migration applied, "" before.

Open
OID
013123…a1f4:45
Migrated details

Inspect func

TransferRemote

func(destination uint32, recipient string, amount int64) string

TransferRemote sends amount of the caller's BUBBLE to recipient on destination (a Solana address in base58, or 32 bytes in hex) and returns the message id in hex. First, on the bubble realm, the caller approves THIS realm (bubble.Approve, spender Address()) for at least amount + fee: the amount is locked here, the fee goes to r/hlfees. The amount is between the minimum and the per-message maximum.

Open
OID
013123…a1f4:46
TransferRemote details

Inspect func

Process

func(metadata string, message string)

Process takes a token message from Solana and credits a claim to its recipient. Anyone may call it with the verifier's metadata and the message, both in hex. A refused message stays undelivered. A realm registered as a successor credits nothing — its own messages included (R32) — before the last page of its predecessor's migration is in (AQ1); a migrated realm refuses before the mailbox is asked (see hlgnot's).

Open
OID
013123…a1f4:47
Process details

Inspect func

Claim

func(n int) int

Claim pays up to n claims (n ≤ 20) taking recipients in turns under the meters, the fee as each claim's first installment. Anyone may call it; the relayers do. It returns how many claims it paid something on.

Open
OID
013123…a1f4:48
Claim details

Inspect func

pay

func(to .uverse.address, amount int64)
Open
OID
013123…a1f4:49
pay details

Inspect func

Request

type

Request is what a builder returns (M1k): the proposal GovDAO's proxy executes after the yield (Proposal), and the same decision the governor runs directly before it (Govern); see hlgnot's.

Value

hlbubble.Request

who

func(path string, a .uverse.address) string

who names a previous realm in a refusal: its pkgpath, or a user's address.

Open
OID
013123…a1f4:51
who details

Inspect func

mustBeGovernor

func()

mustBeGovernor is a decision's identity check (M1k), read from the closure's own live cur: the governor's own call until it yields on r/hlmailbox, gno.land/r/gov/dao's proxy exactly after (or from the first block, when no governor was compiled); see hlgnot's.

Open
OID
013123…a1f4:52
mustBeGovernor details

Inspect func

propose

func(d v0.Draft) hlbubble.Request
Open
OID
013123…a1f4:53
propose details

Inspect func

Govern

func(r hlbubble.Request)

Govern is the governor's way in before the yield (M1k): the same closure GovDAO's proxy runs after it, called non-crossing in this frame so it reads the governor from cur.Previous(); refused for anyone else and for everyone once the governor yielded on r/hlmailbox (or when none was compiled); see hlgnot's.

Open
OID
013123…a1f4:54
Govern details

Inspect func

NewSetCapFloorRequest

func(n int64) hlbubble.Request
Open
OID
013123…a1f4:55
NewSetCapFloorRequest details

Inspect func

NewSetMaximumRequest

func(n int64) hlbubble.Request
Open
OID
013123…a1f4:56
NewSetMaximumRequest details

Inspect func

NewSetFeeRequest

func(fee int64, minimum int64) hlbubble.Request
Open
OID
013123…a1f4:57
NewSetFeeRequest details

Inspect func

NewSetFeeFloorRequest

func(n int64) hlbubble.Request
Open
OID
013123…a1f4:58
NewSetFeeFloorRequest details

Inspect func

NewSetRouterRequest

func(router string) hlbubble.Request
Open
OID
013123…a1f4:59
NewSetRouterRequest details

Inspect func

NewVoidRequest

func(ids string, forged bool, unpauseFns string, removeSeats string) hlbubble.Request

NewVoidRequest voids credits by message id (a claim, or a sweep entry as forged) or by a range of credits ("heights:\<from>-\<to>" or "since:\<from>", closed at the height the proposal is made, at most 1,000 credits), as withheld or forged, with the unpause option (the seats' holders recorded; a seat whose occupant changed by execution is skipped): see hlgnot's.

Open
OID
013123…a1f4:60
NewVoidRequest details

Inspect func

NewRestoreRequest

func(ids string) hlbubble.Request
Open
OID
013123…a1f4:61
NewRestoreRequest details

Inspect func

NewCreditRequest

func(id string, to .uverse.address, amount int64) hlbubble.Request
Open
OID
013123…a1f4:62
NewCreditRequest details

Inspect func

NewSweepRequest

func(ids string, to .uverse.address) hlbubble.Request

NewSweepRequest pays sweep entries, named by message id, to an address after 7 days — their sum, at most the lock — and drops them (R19): see hlgnot's.

Open
OID
013123…a1f4:63
NewSweepRequest details

Inspect func

NewRefundRequest

func(ids string) hlbubble.Request

NewRefundRequest queues a refund of imported sends by id, 7 days, once kind 6 has enrolled this realm on Solana for 14 days (AR1, R37); applied then by NewApplyRefundRequest, never by Execute (AT2); see hlgnot's.

Open
OID
013123…a1f4:64
NewRefundRequest details

Inspect func

NewApplyRefundRequest

func(id int64) hlbubble.Request

NewApplyRefundRequest applies a queued refund decision whose 7 days have passed, at once (AT2): GovDAO's own act after hlwatch's check that the token's router on Solana is this realm; under a standing payouts flag it waits like a claim; see hlgnot's.

Open
OID
013123…a1f4:65
NewApplyRefundRequest details

Inspect func

NewWriteOffRequest

func(ids string) hlbubble.Request

NewWriteOffRequest books refunded sends delivered on Solana after their refund as lost, after 7 days (AR1); see hlgnot's.

Open
OID
013123…a1f4:66
NewWriteOffRequest details

Inspect func

NewMigrateRequest

func(to string) hlbubble.Request

NewMigrateRequest: a successor that announced itself to the mailbox for the BUBBLE route (R25, AQ5) and is no route already (R31), after 7 days; a realm that succeeds another migrates on only once its own import has ended (R31); see hlgnot's.

Open
OID
013123…a1f4:67
NewMigrateRequest details

Inspect func

NewCancelRequest

func(id int64) hlbubble.Request
Open
OID
013123…a1f4:68
NewCancelRequest details

Inspect func

Execute

func(id int64)

Execute applies a queued decision whose 7 days have passed. Anyone may call it. A sweep payment moves BUBBLE out of the lock, so under a standing payouts flag it waits for the unpause like a claim (§5.9). A refund is never Execute's (AT2): the state refuses the kind, and GovDAO applies it by NewApplyRefundRequest.

Open
OID
013123…a1f4:69
Execute details

Inspect func

Pull

func(page int) *v0.Snapshot

Pull is the successor's: once a migrate decision names it, the realm at that pkgpath calls Pull from its own code, page by page from 0, and receives the lock (transferred to its address, with page 0) and the records to import, up to 500 a page (the snapshot's More says whether a page follows); a page pulled already hands over nothing. Page 0 moves the lock, so under a standing payouts flag it waits for the unpause like a sweep payment (R27, R16); the flag follows the claims to the successor (hlmailbox.AddRoute).

Open
OID
013123…a1f4:70
Pull details

Inspect func

Render

func(path string) string

Render: "" the route's page; "decisions"; "json"; "decisions.json"; "claim/\<id>"; "send/\<id>"; "claims/\<from>", "sweeps/\<from>" and "refunds/\<from>", up to 100 entries a page (hlgnot's Render says more).

Open
OID
013123…a1f4:72
Render details

Inspect func

parseFrom

func(s string) int

parseFrom reads a page's offset; -1 (an empty page) for anything but a number.

Open
OID
013123…a1f4:73
parseFrom details

Inspect func
namespace : untyped string ="gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/"
pkgPath : untyped string ="gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/hlbubble"
mailboxPath : untyped string ="gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/hlmailbox"
feesPath : untyped string ="gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/hlfees"
bubblePath : untyped string ="gno.land/r/g1leu8d2vsplhehcfkjg50mwgdpxdkt8tztu95wr/bubble"
hlgnotPath : untyped string ="gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/hlgnot"
hlgovPath : untyped string ="gno.land/r/g1zdaz6sypk5tdsjc2fzsqrrn4ttn8qzmnl4waqp/hlgov"
one : int64 =1000000
launchFee : int64 =100000000
launchMinimum : int64 =200000000
launchFeeFloor : int64 =40000000
launchCapFloor : int64 =10000000000
launchMaximum : int64 =25000000000
launchRouter : untyped string ="c807d773013b14cee2855ca9efafeac0b3bbc3a42fd397c2fbffda6417d290f1"
maxI64 : uint64 =9223372036854775807
launchGovernor : .uverse.address =<gnolang.StringValue>
st : *v0.State Inspect
realms : [].uverse.address (len=6) Inspect
init.18 : func() Inspect
mustKey : func(s string) [32]uint8 Inspect
now : func() int64 Inspect
u32 : func(n uint32) string Inspect
itoa : func(n int64) string Inspect
caller : func() .uverse.address Inspect
mustHex : func(s string, what string) []uint8 Inspect
isRealm : func(a .uverse.address) bool Inspect
mustBeLive : func() Inspect
mustNotBePaused : func(fn string) Inspect
mustNotBeDropped : func() Inspect
syncLaunch : func() Inspect
Address : func() .uverse.address Inspect
Locked : func() int64 Inspect
Balance : func() int64 Inspect
Router : func() string Inspect
Domain : func() uint32 Inspect
Fee : func() int64 Inspect
Minimum : func() int64 Inspect
FeeFloor : func() int64 Inspect
CapFloor : func() int64 Inspect
Maximum : func() int64 Inspect
Cap : func() int64 Inspect
Counters : func() (sentTotal int64, paidTotal int64, owed int64, voided int64, lost int64) Inspect
Migrated : func() string Inspect
TransferRemote : func(destination uint32, recipient string, amount int64) string Inspect
Process : func(metadata string, message string) Inspect
Claim : func(n int) int Inspect
pay : func(to .uverse.address, amount int64) Inspect
env : func() v0.Env Inspect
Request : type =hlbubble.Request
who : func(path string, a .uverse.address) string Inspect
mustBeGovernor : func() Inspect
propose : func(d v0.Draft) hlbubble.Request Inspect
Govern : func(r hlbubble.Request) Inspect
NewSetCapFloorRequest : func(n int64) hlbubble.Request Inspect
NewSetMaximumRequest : func(n int64) hlbubble.Request Inspect
NewSetFeeRequest : func(fee int64, minimum int64) hlbubble.Request Inspect
NewSetFeeFloorRequest : func(n int64) hlbubble.Request Inspect
NewSetRouterRequest : func(router string) hlbubble.Request Inspect
NewVoidRequest : func(ids string, forged bool, unpauseFns string, removeSeats string) hlbubble.Request Inspect
NewRestoreRequest : func(ids string) hlbubble.Request Inspect
NewCreditRequest : func(id string, to .uverse.address, amount int64) hlbubble.Request Inspect
NewSweepRequest : func(ids string, to .uverse.address) hlbubble.Request Inspect
NewRefundRequest : func(ids string) hlbubble.Request Inspect
NewApplyRefundRequest : func(id int64) hlbubble.Request Inspect
NewWriteOffRequest : func(ids string) hlbubble.Request Inspect
NewMigrateRequest : func(to string) hlbubble.Request Inspect
NewCancelRequest : func(id int64) hlbubble.Request Inspect
Execute : func(id int64) Inspect
Pull : func(page int) *v0.Snapshot Inspect
pausedText : func() string Inspect
Render : func(path string) string Inspect
parseFrom : func(s string) int Inspect