Search Apps Documentation Source Content File Folder Download Copy Actions Download

urlshort package

Overview

Package urlshort is a simple on-chain URL alias registry.

Callers register an `alias -> url` mapping they own. An alias can only be claimed once; the owner may later update the target URL, but nobody else can overwrite an alias they do not own. A per-alias click counter is bumped every time the alias is resolved through Render("/<alias>").

Functions

Lookup

func Lookup(alias string) (string, bool)

Lookup returns the target url for an alias and whether it exists. It is a read-only helper and does NOT increment the click counter.

Param

Command

gnokey query vm/qeval -remote "https://rpc.test13.testnets.gno.land" -data "gno.land/r/g12cs4cehujpffpjpywmkqj43m6u5ya53nj69sjz/urlshort.Lookup()"

Result

Remove

func Remove(cur realm, alias string)

Remove deletes an alias owned by the caller. Aborts if the alias does not exist or the caller is not the owner.

Param

Command

# WARNING: This command is running in an INSECURE mode.
# It is strongly recommended to use a hardware device for signing
# and avoid trusting any computer connected to the internet,
# as your private keys could be exposed.

gnokey maketx call -pkgpath "gno.land/r/g12cs4cehujpffpjpywmkqj43m6u5ya53nj69sjz/urlshort" -func "Remove" -args $'' -gas-fee 1000000ugnot -gas-wanted 1_000_000_000 -send "" -chainid "test-13" -remote "https://rpc.test13.testnets.gno.land" ADDRESSgnokey query -remote "https://rpc.test13.testnets.gno.land" auth/accounts/ADDRESS
gnokey maketx call -pkgpath "gno.land/r/g12cs4cehujpffpjpywmkqj43m6u5ya53nj69sjz/urlshort" -func "Remove" -args $'' -gas-fee 1000000ugnot -gas-wanted 1_000_000_000 -send "" -broadcast=false ADDRESS > call.tx
gnokey sign -tx-path call.tx -chainid "test-13" -account-number ACCOUNTNUMBER -account-sequence SEQUENCENUMBER ADDRESS
gnokey broadcast -remote "https://rpc.test13.testnets.gno.land" call.tx

Render

func Render(path string) string

Render renders Markdown. The root path lists every alias; "/<alias>" shows a single alias detail and bumps its click counter.

Param

Command

gnokey query vm/qeval -remote "https://rpc.test13.testnets.gno.land" -data "gno.land/r/g12cs4cehujpffpjpywmkqj43m6u5ya53nj69sjz/urlshort.Render()"

Result

Shorten

func Shorten(cur realm, alias string, url string, note string)

Shorten registers `alias -> url` owned by the caller.

Rules:

  • alias must be non-empty and alphanumeric;
  • url must be non-empty;
  • if the alias is unclaimed, it is created owned by the caller;
  • if it is already claimed by the caller, the url/note are updated;
  • if it is claimed by someone else, the call aborts.

Params

Command

# WARNING: This command is running in an INSECURE mode.
# It is strongly recommended to use a hardware device for signing
# and avoid trusting any computer connected to the internet,
# as your private keys could be exposed.

gnokey maketx call -pkgpath "gno.land/r/g12cs4cehujpffpjpywmkqj43m6u5ya53nj69sjz/urlshort" -func "Shorten" -args $'' -args $'' -args $'' -gas-fee 1000000ugnot -gas-wanted 1_000_000_000 -send "" -chainid "test-13" -remote "https://rpc.test13.testnets.gno.land" ADDRESSgnokey query -remote "https://rpc.test13.testnets.gno.land" auth/accounts/ADDRESS
gnokey maketx call -pkgpath "gno.land/r/g12cs4cehujpffpjpywmkqj43m6u5ya53nj69sjz/urlshort" -func "Shorten" -args $'' -args $'' -args $'' -gas-fee 1000000ugnot -gas-wanted 1_000_000_000 -send "" -broadcast=false ADDRESS > call.tx
gnokey sign -tx-path call.tx -chainid "test-13" -account-number ACCOUNTNUMBER -account-sequence SEQUENCENUMBER ADDRESS
gnokey broadcast -remote "https://rpc.test13.testnets.gno.land" call.tx