v1 state

RegisterArtist

RegisterArtist creates or updates the caller's artist profile. Names use Latin letters so look-alike names in other scripts cannot impersonate.

CreateArtist

CreateArtist adds an unclaimed artist. Admin only. A curated artist has a name and its page at the source (https), shown for attribution. An Audius or Jamendo artist is a pointer: no name or bio, and source is its platform id ("audius-user:\<id>", "jamendo-artist:\<id>"), which also keeps it unique; the app reads its name live from the platform.

AssignArtist

AssignArtist hands an unclaimed artist to the wallet that proved it owns the profile (claim checked off-chain). Their tracks then receive tips.

Follow

Follow and Unfollow an artist.

Unfollow

newArtist

rename

rename moves the artist to a new name and frees the old one (the caller saves a). A hidden artist keeps its name so it cannot dodge moderation.

ReleaseName

ReleaseName frees a reserved name no visible artist is using. Admin only.

refUser

refUser is the source prefix of a pointer artist's platform id.

validRef

version

denom

ugnot

OriginArtist

OriginCurated

OriginAudius

OriginJamendo

minTip

// 0.1 GNOT

maxTip

// keeps share math far from overflow

maxSplits

maxSplitPct

// the artist always keeps at least 10%

earlyBadges

minDuration

maxDuration

maxPerArtist

// tracks per artist

maxAlbumTracks

maxListTracks

maxUserLists

maxFollows

maxUserReports

// open reports per reporter

maxTitle

// track, album and playlist titles, in characters

maxBio

// artist bio

maxCredits

// a track's credits and a curated import's attribution

maxReason

// report and moderation reasons

topSize

maxSupportPct

NumGenres

NumGenres is the size of the fixed genre list; genre ids are 1..NumGenres.

genres

licenses

licenses an artist may pick; curated imports are limited to CC0, BY, BY-SA, BY-NC and BY-NC-SA (no ND, no reserved rights).

AudiusLicense

AudiusLicense is the license id of tracks streamed from Audius.

rightsTerms

self

// this realm's path

admin

// the moderator; nil when a release before renounced it

init.43

now

userCaller

adminAddr

syncAdmin

syncAdmin adopts the mirror when the previous release changed it after this one's init (during the release's delay).

onlyAdmin

noPayment

paid

paid returns the ugnot attached to the call; anything else is refused.

emitEvent

Ready

Ready tells the data realm that this release is on chain (see data.Propose). Anyone may call it.

OfferAdmin

OfferAdmin offers the admin role to an address (offering it to the admin cancels the offer); AcceptAdmin takes it. Each change is mirrored to the data realm, so the next release keeps the admin.

AcceptAdmin

RenounceAdmin

RenounceAdmin gives the admin role up for good, for this release and the next ones.

Render

Render points gnoweb visitors to the GnoRadio site; a retired release says which realm took over.

Info

Info is the catalog's summary for the app: counts, the admin and the realm that writes the catalog now ("current", this one unless retired).

cArtists

// P((id-1)/chunkSize) -> artist heads (chunk)

cAlists

// P(artist) -> Rec(track ids, album ids)

cOwners

// owner address -> artist id

cNames

// name skeleton -> artist id

cTracks

// P((id-1)/chunkSize) -> track records (chunk)

cGenres

// P(genre)/P(id>>9) -> packed track ids

cAlbums

// P((id-1)/chunkSize) -> album records (chunk)

cPlaylists

// P(id) -> playlist record

cUsers

// address -> Rec(follows, tipped, playlists, reports)

cLikes

// address/P(id>>9) -> packed liked track ids

cTipped

// address/P(id>>9) -> packed tipped track ids

cReports

// P(id) -> report record (open reports only)

cRemoved

// kind:id -> moderator's reason, "" when its artist hid it

cHosts

// allowed https host -> "1"

cMeta

// "n" -> counts

cTops

// liked|artists|fans|support -> ranks

cActivity

// P(0..63) -> activity record (ring, head in meta)

cConfig

// admin, treasury, goal, bot, gen

cSupporters

// address -> lifetime support

cMonthly

// YYYY-MM -> support that month

cPromo

// P(artist) -> promo percent

cBudgets

// P(artist) -> sponsored-pick settings and stats

cWalletDay

// address -> day|artist ids sponsored that day

cClaims

// P(artist) -> pending claim

cProofs

// P(artist) -> proof URL of the last finalized claim

collections

chunkSize

// records per key of the chunked collections; tickets/nft reads artists with it: frozen

maxRec

// longest artist, track or album record when written by its author

idRange

// likes, tips and genres are kept per range of 1\<\<idRange track ids

activitySize

setup

setup makes the catalog's collections and its first settings, once: a later release finds them made (it is not the writer in its init).

tx

tx reads each key from the data realm once and writes every key it changed once, in one call (data.Set or data.Batch). Every entrypoint loads what it needs, changes it in its tx, then saves; readers use one too, so a chunk is decoded once per call. A tx is never stored.

entry

rd

save

save writes what t changed: one data.Set or data.Remove, or Batches of 64 ops (a bulk ResolveReports may change more keys than one Batch takes; the transaction keeps them atomic, as in radio).

point

point is tx.rec without a tx, for the getters that read one or two records: no tx to build for a call the radio makes in loops.

artistAt

artistAt is field f of an artist's record, "" when unknown (point).

fits

fits refuses a record too long for its chunk: chunkSize records, each with room left for its counters and early badges, stay under data's 16 KiB value limit, so one author can never fill a chunk others share.

mTracks

Count fields. A count is read and changed in place (store.Field and store.With): converting numbers costs gas, so nothing decodes the record. Reaching field i walks the i before it: what a publish changes comes first.

mGenre

// + genre id (1..NumGenres): tracks filed under it

mArtists

mAlbums

mPlaylists

mReports

// filed

mOpen

// reports not yet resolved

mSupporters

mSupport

// ugnot

mFields

newCounts

rangeKey

rangePage

rangePage reads up to limit ids of a ranged set from offset, highest first, and the set's size, one data.Page per 100 ranges.

Activity

Activity is one entry of the public activity feed.

Rank

topLiked

// track ids by likes

topArtists

// artist ids by tips

topFans

// addresses by tipped

topSupport

// addresses by support

ranks

updateTop

updateTop keeps a short leaderboard sorted by value, highest first.

ints

trackJSON

trackJSON writes track id from its record and its artist's head.

playableRec

playableRec returns a track's record and its artist's head when both are visible ("" otherwise).

TrackJSON

TrackJSON returns one playable track.

TracksJSON

TracksJSON pages through playable tracks (newest first), at most 100. Chunks and artist heads are read once per page.

ArtistJSON

artistJSON

albumJSON

albumJSON writes a visible album ("" when it or its artist is hidden).

AlbumJSON

playlistJSON

playlistJSON writes a visible playlist ("" when hidden or unknown).

PlaylistJSON

UserJSON

UserJSON returns a listener's public counters (likes are paged with LikesJSON).

LikesJSON

GenresJSON

maxBatch

maxBatch caps the batched readers, so one query stays far below the qeval budget.

batch

batch writes {"total":n,"\<key>":\[...]} for ids offset+1..offset+limit, skipping hidden items; one query replaces up to 100 single reads.

ArtistsJSON

ArtistsJSON returns visible artists with ids offset+1..offset+limit (at most 100).

AlbumsJSON

AlbumsJSON returns visible albums with ids offset+1..offset+limit (at most 100).

PlaylistsJSON

PlaylistsJSON returns visible playlists with ids offset+1..offset+limit (at most 100).

Report

Report flags a track, album, artist or playlist for the moderators (e.g. "broken link", "not the real artist", "copyright").

getReport

ResolveReport

ResolveReport closes a report once handled. Admin only.

ResolveReports

ResolveReports closes the open reports with ids from..from+count-1 (count 1-50) in one transaction, e.g. a run of spam reports; ids already closed are skipped. There is no global cap on open reports, so spam never blocks an honest reporter: each wallet keeps at most 5 open. Admin only.

resolve

resolve closes one report, false when there is no such open report.

HideTrack

Hide or restore content. Admin only; hiding takes a public reason (4-200 characters) and restoring works on anything, whoever hid it. Hidden content stays on-chain (and on IPFS); it is no longer listed, played or tippable. Radio stations drop a hidden track on their next Refresh (radio.RefreshArtist for a whole artist).

HideAlbum

HideArtist

HidePlaylist

moderate

moderate records the moderator's public reason and saves t.

mark

mark records the moderator's public reason for one item (the caller saves).

maxHideBatch

maxHideBatch bounds HideSource: 2 writes per artist.

HideSource

HideSource hides every artist read from a platform ("audius" or "jamendo"), and so all their tracks, for a platform that ends GnoRadio's API access. It walks artist ids from \`from\`, count (1-50) at a time, and returns where to go on (0 once past the last artist). One artist opting out is a HideArtist. Admin only.

HideOwn

HideOwn hides or shows again the caller's own track, album or artist profile ("artist", with the profile's id). The artist can show again only what they hid themselves: what the moderator hid stays hidden.

mustToggle

HiddenNote

HiddenNote says why a track, album, artist or playlist is hidden, for its page: "Removed by moderation: \<reason>", "Hidden by the artist.", or "".

Verify

Verify marks an artist whose identity was checked off-chain.

AllowHost

AllowHost adds or removes an https host that audio and covers may use.

defaultPromoPct

maxPromoPct

SetPromoShare

SetPromoShare sets the percent of each tip on the caller's tracks that goes to the picker and the referrer (0..20).

PromoShare

PromoShare returns an artist's promo percent.

promoShare

RadioTip

RadioTip pays a tip the radio realm received for the listener tipper (radio.TipOnAir): the radio has already forwarded total ugnot to this realm and names the picker of the slot on air. Only the radio writer may call it. It returns what the picker and the referrer received.

onlyRadio

onlyRadio admits the radio realm the data realm names as radio writer now, unless the radio role is paused: a paused radio moves no coins through the catalog either.

promoShares

promoShares splits an artist-side amount's promo share between the picker and the referrer still eligible ("" when not): half each, the odd ugnot to the picker, all of it to one alone.

GenreName

TrackCount

ArtistCount

AlbumCount

PlaylistCount

TrackBrief

TrackBrief is what the radio needs; playable is false for an unknown or hidden track, or one whose artist is hidden.

TrackBriefFor

TrackBriefFor is TrackBrief and whether addr ("" for nobody) is the track's artist or one of its collaborators, from the same reads.

PlayableTitle

PlayableTitle is a track's title, "" unless it is playable (TrackBrief).

TrackTitle

ArtistName

ArtistOwner

ArtistOf

ArtistPayee

ArtistVisible

GetTrack

GetTrack returns a copy of a track; ok is false if unknown. A pointer's empty title reads as its platform ("Audius track").

GetArtist

ArtistByRef

ArtistByRef looks a pointer artist up by its platform id ("audius-user:12").

ArtistByName

ArtistByName looks a profile up by its (case-insensitive) name.

GetAlbum

GetPlaylist

ReportCount

ReportCount is the number of open (unresolved) reports.

GetReport

UserStats

UserStats returns a listener's public counters and playlists. The like count reads the listener's own like ranges, one page.

LikedPage

LikedPage lists a listener's liked track ids, newest tracks first, paginated. Likes are keyed by track id, so this is the newest music the listener liked, not the order of their likes (that needs an index per like, which would add to every like's storage deposit).

ArtistTrackCount

ArtistTrackCount is the number of tracks an artist published.

ArtistTrackPage

ArtistTrackPage lists an artist's track ids in publishing order, paginated.

ArtistBrief

ArtistBrief returns what a link to an artist needs, without the bio or the id lists; ok is false for an unknown artist.

PlaylistBrief

PlaylistBrief returns a playlist's header without its track ids.

FollowsPage

FollowsPage lists the artist ids a listener follows, paginated.

GenrePage

GenrePage lists the track ids of a genre (hidden ones included), newest first.

GenreCount

GenreCount is the number of tracks filed under a genre.

TrackPage

TrackPage lists track ids, newest first when newest is true. Ids are dense (1..count), so these pages are arithmetic.

ArtistPage

AlbumPage

PlaylistPage

ReportPage

ReportPage lists open report ids, newest first.

seqPage

max0

TopLiked

TopArtists

TopFans

Admin

PendingAdmin

Version

RightsTerms

HostAllowed

Split

Artist

Track

Album

Playlist

User

User is what a listener writes, so a follow only touches that listener's own record. Follows are a sorted packed list (9 bytes each); likes and the tipped tracks live apart, per range of 512 track ids.

ReportInfo

fArtist

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fGenre

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fDuration

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fHidden

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fLikes

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fEarly

// first listeners to like it, comma-joined

fTips

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fSupporters

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fAlbum

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fCreated

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fOrigin

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fTitle

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fLicense

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fCMO

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fCredits

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fAudio

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fAudioSHA

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fCover

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fCoverSHA

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fSource

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.

fAttribution

Track record fields. Reading or replacing field i walks the i fields before it, so the fields the frequent actions read and change come first.