BNS Contract

See a detailed list of all functions and error codes of the BNS contract.

Introduction

The Blockchain Naming System (BNS) is implemented as a smart contract using Clarity.

Below is a list of public and read-only functions as well as error codes that can be returned by those methods.

Public functions

name-import

Signature: (name-import namespace name beneficiary zonefile-hash)

Input: (buff 20), (buff 48), principal, (buff 20)

Output: (response bool int)

Imports name to a revealed namespace. Each imported name is given both an owner and some off-chain state.

name-preorder

Signature: (name-preorder hashed-salted-fqn stx-to-burn)

Input: (buff 20), uint

Output: (response uint int)

Preorders a name by telling all BNS nodes the salted hash of the BNS name. It pays the registration fee to the namespace owner's designated address.

name-register

Signature: (name-register namespace name salt zonefile-hash)

Input: (buff 20), (buff 48), (buff 20), (buff 20)

Output: (response bool int)

Reveals the salt and the name to all BNS nodes, and assigns the name an initial public key hash and zone file hash.

name-renewal

Signature: (name-renewal namespace name stx-to-burn new-owner zonefile-hash)

Input: (buff 20), (buff 48), uint, (optional principal), (optional (buff 20))

Output: (response bool int)

Depending in the namespace rules, a name can expire. For example, names in the .id namespace expire after 2 years. You need to send a name renewal every so often to keep your name.

You will pay the registration cost of your name to the namespace's designated burn address when you renew it. When a name expires, it enters a "grace period". The period is set to 5000 blocks (a month) but can be configured for each namespace.

It will stop resolving in the grace period, and all of the above operations will cease to be honored by the BNS consensus rules. You may, however, send a NAME_RENEWAL during this grace period to preserve your name. After the grace period, everybody can register that name again. If your name is in a namespace where names do not expire, then you never need to use this transaction.

name-revoke

Signature: (name-revoke namespace name)

Input: (buff 20), (buff 48)

Output: (response bool int)

Makes a name unresolvable. The BNS consensus rules stipulate that once a name is revoked, no one can change its public key hash or its zone file hash. The name's zone file hash is set to null to prevent it from resolving. You should only do this if your private key is compromised, or if you want to render your name unusable for whatever reason.

name-transfer

Signature: (name-transfer namespace name new-owner zonefile-hash)

Input: (buff 20), (buff 48), principal, (optional (buff 20))

Output: (response bool int)

Changes the name's public key hash. You would send a name transfer transaction if you wanted to:

  • Change your private key
  • Send the name to someone else or
  • Update your zone file

When transferring a name, you have the option to also clear the name's zone file hash (i.e. set it to null). This is useful for when you send the name to someone else, so the recipient's name does not resolve to your zone file.

name-update

Signature: (name-update namespace name zonefile-hash)

Input: (buff 20), (buff 48), (buff 20)

Output: (response bool int)

Changes the name's zone file hash. You would send a name update transaction if you wanted to change the name's zone file contents. For example, you would do this if you want to deploy your own Gaia hub and want other people to read from it.

namespace-preorder

Signature: (namespace-preorder hashed-salted-namespace stx-to-burn)

Input: (buff 20), uint

Output: (response uint int)

Registers the salted hash of the namespace with BNS nodes, and burns the requisite amount of cryptocurrency. Additionally, this step proves to the BNS nodes that user has honored the BNS consensus rules by including a recent consensus hash in the transaction. Returns pre-order's expiration date (in blocks).

namespace-ready

Signature: (namespace-ready namespace)

Input: (buff 20)

Output: (response bool int)

Launches the namespace and makes it available to the public. Once a namespace is launched, anyone can register a name in it if they pay the appropriate amount of cryptocurrency.

namespace-reveal

Signature: (namespace-reveal namespace namespace-salt p-func-base p-func-coeff p-func-b1 p-func-b2 p-func-b3 p-func-b4 p-func-b5 p-func-b6 p-func-b7 p-func-b8 p-func-b9 p-func-b10 p-func-b11 p-func-b12 p-func-b13 p-func-b14 p-func-b15 p-func-b16 p-func-non-alpha-discount p-func-no-vowel-discount lifetime namespace-import)

Input: (buff 20), (buff 20), uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, uint, principal

Output: (response bool int)

Reveals the salt and the namespace ID (after a namespace preorder). It reveals how long names last in this namespace before they expire or must be renewed, and it sets a price function for the namespace that determines how cheap or expensive names its will be.All of the parameters prefixed by p make up the price function. These parameters govern the pricing and lifetime of names in the namespace.

The rules for a namespace are as follows:

  • a name can fall into one of 16 buckets, measured by length. Bucket 16 incorporates all names at least 16 characters long.
  • the pricing structure applies a multiplicative penalty for having numeric characters, or punctuation characters.
  • the price of a name in a bucket is ((coeff) * (base) ^ (bucket exponent)) / ((numeric discount multiplier) * (punctuation discount multiplier))

Example:

  • base = 10
  • coeff = 2
  • nonalpha discount: 10
  • no-vowel discount: 10
  • buckets 1, 2: 9
  • buckets 3, 4, 5, 6: 8
  • buckets 7, 8, 9, 10, 11, 12, 13, 14: 7
  • buckets 15, 16+:

Read-only functions

can-name-be-registered

Signature: (can-name-be-registered namespace name)

Input: (buff 20), (buff 48)

Output: (response bool int)

Returns true if the provided name can be registered.

can-namespace-be-registered

Signature: (can-namespace-be-registered namespace)

Input: (buff 20)

Output: (response bool UnknownType)

Returns true if the provided namespace is available.

can-receive-name

Signature: (can-receive-name owner)

Input: principal

Output: (response bool int)

Returns true if the provided name can be received. That is, if it is not curretly owned, a previous lease is expired, and the name wasn't revoked.

get-name-price

Signature: (get-name-price namespace name)

Input: (buff 20), (buff 48)

Output: (response uint int)

Gets the price for a name.

get-namespace-price

Signature: (get-namespace-price namespace)

Input: (buff 20)

Output: (response uint int)

Gets the price for a namespace.

get-namespace-properties

Signature: (get-namespace-properties namespace)

Input: (buff 20)

Output: (response (tuple (namespace (buff 20)) (properties (tuple (can-update-price-function bool) (launched-at (optional uint)) (lifetime uint) (namespace-import principal) (price-function (tuple (base uint) (buckets (list 16 uint)) (coeff uint) (no-vowel-discount uint) (nonalpha-discount uint))) (revealed-at uint)))) int)

Get namespace properties.

is-name-lease-expired

Signature: (is-name-lease-expired namespace name)

Input: (buff 20), (buff 48)

Output: (response bool int)

Return true if the provided name lease is expired.

name-resolve

Signature: (name-resolve namespace name)

Input: (buff 20), (buff 48)

Output: (response (tuple (lease-ending-at (optional uint)) (lease-started-at uint) (owner principal) (zonefile-hash (buff 20))) int)

Get name registration details.

resolve-principal

Signature: (resolve-principal owner)

Input: principal

Output: (response (tuple (name (buff 48)) (namespace (buff 20))) (tuple (code int) (name (optional (tuple (name (buff 48)) (namespace (buff 20)))))))

Returns the registered name that a principal owns if there is one. A principal can only own one name at a time.

Error codes

ERR_INSUFFICIENT_FUNDS

Type: int

Value: 4001

ERR_NAMESPACE_ALREADY_EXISTS

Type: int

Value: 1006

ERR_NAMESPACE_ALREADY_LAUNCHED

Type: int

Value: 1014

ERR_NAMESPACE_BLANK

Type: int

Value: 1013

ERR_NAMESPACE_CHARSET_INVALID

Type: int

Value: 1016

ERR_NAMESPACE_HASH_MALFORMED

Type: int

Value: 1015

ERR_NAMESPACE_NOT_FOUND

Type: int

Value: 1005

ERR_NAMESPACE_NOT_LAUNCHED

Type: int

Value: 1007

ERR_NAMESPACE_OPERATION_UNAUTHORIZED

Type: int

Value: 1011

ERR_NAMESPACE_PREORDER_ALREADY_EXISTS

Type: int

Value: 1003

ERR_NAMESPACE_PREORDER_CLAIMABILITY_EXPIRED

Type: int

Value: 1009

ERR_NAMESPACE_PREORDER_EXPIRED

Type: int

Value: 1002

ERR_NAMESPACE_PREORDER_LAUNCHABILITY_EXPIRED

Type: int

Value: 1010

ERR_NAMESPACE_PREORDER_NOT_FOUND

Type: int

Value: 1001

ERR_NAMESPACE_PRICE_FUNCTION_INVALID

Type: int

Value: 1008

ERR_NAMESPACE_STX_BURNT_INSUFFICIENT

Type: int

Value: 1012

ERR_NAMESPACE_UNAVAILABLE

Type: int

Value: 1004

ERR_NAME_ALREADY_CLAIMED

Type: int

Value: 2011

ERR_NAME_BLANK

Type: int

Value: 2010

ERR_NAME_CHARSET_INVALID

Type: int

Value: 2022

ERR_NAME_CLAIMABILITY_EXPIRED

Type: int

Value: 2012

ERR_NAME_COULD_NOT_BE_MINTED

Type: int

Value: 2020

ERR_NAME_COULD_NOT_BE_TRANSFERED

Type: int

Value: 2021

ERR_NAME_EXPIRED

Type: int

Value: 2008

ERR_NAME_GRACE_PERIOD

Type: int

Value: 2009

ERR_NAME_HASH_MALFORMED

Type: int

Value: 2017

ERR_NAME_NOT_FOUND

Type: int

Value: 2013

ERR_NAME_NOT_RESOLVABLE

Type: int

Value: 2019

ERR_NAME_OPERATION_UNAUTHORIZED

Type: int

Value: 2006

ERR_NAME_PREORDERED_BEFORE_NAMESPACE_LAUNCH

Type: int

Value: 2018

ERR_NAME_PREORDER_ALREADY_EXISTS

Type: int

Value: 2016

ERR_NAME_PREORDER_EXPIRED

Type: int

Value: 2002

ERR_NAME_PREORDER_FUNDS_INSUFFICIENT

Type: int

Value: 2003

ERR_NAME_PREORDER_NOT_FOUND

Type: int

Value: 2001

ERR_NAME_REVOKED

Type: int

Value: 2014

ERR_NAME_STX_BURNT_INSUFFICIENT

Type: int

Value: 2007

ERR_NAME_TRANSFER_FAILED

Type: int

Value: 2015

ERR_NAME_UNAVAILABLE

Type: int

Value: 2004

ERR_PANIC

Type: int

Value: 0

ERR_PRINCIPAL_ALREADY_ASSOCIATED

Type: int

Value: 3001

Previous
Deploy tips
Next
Stacking Contract
Powered by