arena source realm

Package arena is a SocialFi realm: profiles, posts, follows, GNOT tips, and creator tickets priced on a quadratic bon...

Package arena is a SocialFi realm: profiles, posts, follows, GNOT tips, and creator tickets priced on a quadratic bonding curve.

Ticket collateral sits in this realm as totalReserve. Trade fees are forwarded out of that collateral, and Sweep only sends coins above it.

 1const (
 2	// CreatorFeeBps is the creator's cut of each ticket trade.
 3	CreatorFeeBps int64 = 500
 4	// ProtocolFeeBps is forwarded to the treasury on each ticket trade.
 5	ProtocolFeeBps int64 = 500
 6	// ReferralFeeBps is paid to the creator's referrer when they have one.
 7	ReferralFeeBps int64 = 100
 8	// TicketUnit is the ugnot price of ticket number 1. Ticket i costs i² units.
 9	TicketUnit int64 = 10_000
10	// MaxSupply is the most tickets one creator can have outstanding.
11	MaxSupply = 2000
12	// MaxTrade is the most tickets one buy or sell can move.
13	MaxTrade = 20
14	// MaxBodyRunes is the longest post, counted in runes.
15	MaxBodyRunes = 280
16	// ProtocolVersion is the immutable revision of this package.
17	// A later package is announced with SetSuccessor. It does not hold this reserve.
18	ProtocolVersion = "1"
19
20	maxHandle    = 16
21	minHandle    = 3
22	maxNameRunes = 32
23	maxNameBytes = 128
24	maxBioRunes  = 160
25	maxBioBytes  = 640
26	maxBodyBytes = 1120
27)

source

1func Buy(cur realm, handle string, amount int)

source

Buy mints amount tickets of handle. Attach exactly QuoteBuy's due in ugnot.

1func Delete(cur realm, id int)

source

Delete soft-deletes the caller's post and clears its body from current state. The original transaction still holds the text in chain history.

1func FeedCount() int

source

FeedCount is the number of live top-level posts still in the feed index.

1func Follow(cur realm, handle string)

source

Follow records that the caller follows handle.

1func Following(from address, handle string) bool

source

Following reports whether from follows the handle.

1func GatedBody(cur realm, id int) string

source

GatedBody returns a gated post's text for the author or a current ticket holder. Chain storage is public; this only gates the convenience call and Render.

1func LatestID() int

source

LatestID is the newest post id, or 0 when nothing has been posted.

1func Like(cur realm, id int)

source

Like adds the caller's like. One like per account.

1func Liked(who address, id int) bool

source

Liked reports whether who liked the post.

1func MemberCount() int

source

MemberCount is the number of registered handles.

1func Paused() bool

source

Paused reports whether new posts, replies, tips, and ticket buys are frozen. Sells stay open so ticket collateral can still exit.

1func Post(cur realm, body, gated string) int

source

Post publishes a top-level post and returns its id. gated is yes/1/true/khoa to withhold the body from Render. The body is still public chain state. Pass an empty gated value for a public post.

1func QuoteBuy(handle string, amount int) (due, curve, creatorFee, protocolFee, referralFee int64)

source

QuoteBuy is the exact ugnot a buyer must attach to mint amount tickets. due = curve + creator fee + protocol fee + referral fee. curve is what stays in the reserve. Fees are paid on top and forwarded.

1func QuoteSell(handle string, amount int) (proceeds, curve, creatorFee, protocolFee, referralFee int64)

source

QuoteSell is what a seller receives, and the fees taken out of the curve refund. The reserve drops by the full curve amount, so later sells stay solvent.

1func Register(cur realm, handle, name, bio, referrer string)

source

Register opens a profile for the calling account. handle is 3–16 chars of a-z, 0-9 and underscore. referrer may be empty or the bech32 address of an existing member. A member can register once.

1func Render(path string) string

source

Render is the short gnoweb page for this fund realm. The long client and Sheet live in the view realm. A realm has to declare Render, and the storage deposit of this package cannot hold both the curve and the full client.

1func Reply(cur realm, parent int, body string) int

source

Reply publishes a reply to parent and returns the new id. Replies are public.

1func Sell(cur realm, handle string, amount int)

source

Sell burns amount tickets and pays the caller from the reserve, minus fees. Sells stay available while the realm is paused.

1func SetPaused(cur realm, on string)

source

SetPaused freezes posts, replies, tips, and ticket buys when on is true/1/yes. Pass false/0/no to reopen. Ticket sells are never paused.

1func SetSuccessor(cur realm, next string)

source

SetSuccessor records the package path of a later realm. An empty path clears it. This does not move coins or shares.

1func SetTreasury(cur realm, next address)

source

SetTreasury moves future protocol fees and surplus sweeps to next.

1func SharesOf(holder address, handle string) int

source

SharesOf returns how many tickets holder has of the creator's handle.

1func Successor() string

source

Successor is the package path of a later realm, or empty. The later realm does not receive this realm's ticket reserve.

1func SupplyOf(handle string) (supply int, reserve int64, holders int)

source

SupplyOf returns tickets outstanding, ugnot locked in that curve, and holders.

1func Sweep(cur realm, confirm string)

source

Sweep sends this realm's ugnot above TotalReserve to the treasury. confirm must be the word "sweep". Ticket collateral is not included.

1func Tip(cur realm, id int)

source

Tip forwards the attached ugnot to the post's author. The realm does not keep it.

1func TotalReserve() int64

source

TotalReserve is the ugnot locked to back outstanding tickets.

1func TransferAdmin(cur realm, next address)

source

TransferAdmin rotates the pause/sweep key.

1func Unfollow(cur realm, handle string)

source

Unfollow removes a follow.

1func Unlike(cur realm, id int)

source

Unlike removes the caller's like.

1func UpdateProfile(cur realm, name, bio string)

source

UpdateProfile replaces the display name and bio. The handle stays.

1func Version() string

source

Version is this package revision. It has no setter.

1func Feed(before, limit int) []Article

source

Feed lists newest top-level posts with id < before. before 0 starts at the newest.

1func GetPost(id int) (Article, bool)

source

GetPost returns a copy of the post. The copy does not alias storage.

1func Hot(limit int) []Article

source

Hot ranks the newest window the same way Render does. It is not a global index.

1func PostsBy(addr address, before, limit int) []Article

source

PostsBy lists one member's newest top-level posts with id < before.

1func Replies(parent, after, limit int) []Article

source

Replies lists direct replies of parent with id > after, oldest first.

1func Holdings(holder, after address, limit int) []Holding

source

Holdings lists ticket balances of holder, after the given creator address.

1func FollowerList(who, after address, limit int) []Profile

source

FollowerList lists profiles that follow `who`, in address order, after `after`.

1func FollowingList(who, after address, limit int) []Profile

source

FollowingList lists profiles `who` follows, in address order, after `after`.

1func Handles(after string, limit int) []Profile

source

Handles lists profiles in handle order, strictly after the given handle.

1func ProfileByHandle(handle string) (Profile, bool)

source

ProfileByHandle returns a copy of the profile, or false when the handle is unknown.

1func ProfileOf(addr address) (Profile, bool)

source

ProfileOf returns a copy of the profile bound to addr.

 1type Article struct {
 2	ID      int
 3	Author  address
 4	Body    string
 5	Height  int64
 6	ReplyTo int
 7	Likes   int
 8	Replies int
 9	Tips    int64
10	Gated   bool
11	Deleted bool
12}

source

Article is a copy of one post. Gated bodies are still stored on chain; Render withholds them, and GatedBody checks the caller.

1type Holding struct {
2	Creator address
3	Handle  string
4	Amount  int
5}

source

Holding is one creator's tickets in a wallet. It is a copy.

 1type Profile struct {
 2	Addr      address
 3	Handle    string
 4	Name      string
 5	Bio       string
 6	Referrer  address
 7	Joined    int64
 8	Posts     int
 9	Followers int
10	Following int
11	TipsIn    int64
12	TipsOut   int64
13}

source

Profile is a copy of a member's public record.

Imports 9

/r/g10ragdr3cjqkael8rslpw4y6rlelhev4h0fswcx/arena

Imported by indexer

Find the packages that import it

Overview

Constants 1

Functions 43

Types 3

Dependencies

Imports 9

Imported by indexer

Source Files 8