# unikname.network cheat-sheet

Table Of Content

WARNING

UNS/uns.network/universal-name-system is the old name of unikname.network blockchain. UNIK is the old name of UNIKNAME nft token UNS is the old name of UNIK protocol token Urls, commands and old documentation are not renamed yet but are still valid. We're updating progressively.

# Mint UNIKNAME NFT Token (@unikname ID) services

To create @unikname, a service fee must be paid to the NFT-Factory with UNIK tokens. Prices are depending of the pattern wanted.

# Prices for individual patterns

Price (UNIK) Common Patterns Description
500 Individual - Latin Safetypo - Long Letters and digits from Safetypo alphabet, 15 characters and more
1 000 Individual - Latin Safetypo - Regular Letters and digits from Safetypo alphabet, 10 characters and more
5 000 Individual - Latin Safetypo - Short Letters and digits from Safetypo alphabet, 7 characters and more
50 000 Individual - Latin Safetypo - Rare Letters and digits from Safetypo alphabet, 4 characters and more
Price (UNIK) Tiny Patterns Description
500 000 Individual - Latin Safetypo - Tiny 3 Letters and digits from Safetypo alphabet, exactly 3 characters
5 000 000 Individual - Latin Safetypo - Tiny 2 Letters and digits from Safetypo alphabet, exactly 2 characters
Price (UNIK) Only Digit Patterns Description
5 000 Individual - Digits - Long Only digits from Safetypo alphabet, 10 digits and more
50 000 Individual - Digits - Standard Only digits from Safetypo alphabet, between 6 and 9 digits
500 000 Individual - Digits - Tiny Only digits from Safetypo alphabet, 4 and 5 digits

# Prices for organization patterns

Price (UNIK) Pattern Description
25 000 Organization - Digits Only digits from Safetypo alphabet. No length restriction.
25 000 Organization - Latin Safetypo Letters and digits from Safetypo alphabet. No length restriction.

# Prices for network patterns

Price (UNIK) Pattern Description
1 000 000 Network - Digits Only digits from Safetypo alphabet. No length restriction.
1 000 000 Network - Latin Safetypo Letters and digits from Safetypo alphabet. No length restriction.

# Command Line Interface (CLI)

CLI Network Costs description
version Display version of the CLI
update Keep the CLI up to date
status Display unikname.network blockchain status
resolve Resolve a decentralized Identifier
send YES Send UNIK tokens to another public address
cryptoaccount:create Create a unikname.network crypto-account
cryptoaccount:read Read current data of a specified cryptoaccount, eg. balance
cryptoaccount:set-second-passphrase YES Set a second passphrase for the specified cryptoaccount
unik:create YES Create a UNIKNAME Token
unik:read Read UNIKNAME Token data
unik:disclose YES Disclose one or more explicit(s) value(s) related to a UNIKNAME
unik:is-disclosed YES Check if UNIKNAME has one or more disclosed explicit value
unik:everlasting YES Keep UNIKNAME alive for eternity
properties:set YES Set the value of a specific property of a UNIKNAME
properties:unset YES Unset or clear the value of a specific property of a UNIKNAME
properties:list List all properties of a UNIKNAME token
properties:get Get the value of a specific property of a UNIKNAME
properties:register Register a properties to verify
properties:verify YES Verify a registered properties
delegate:vote YES Vote for a delegate with his @unikname or unikid
delegate:unvote YES Remove vote from a delegate with his @nikname or unikid
delegate:register YES Register a UNIKNAME as delegate using @unikname or unikid
delegate:resign YES Resign delegate registration of a @unikname or unikid
badges:claim YES Claim a badge for a specified UNIKNAME

Add or Update your CLI to the latest version : >yarn global [add|upgrade] @uns/uns-cli

Getting help for a specific {command} : >uns {command} --help

# Standard command flags

-h --help: (optional) Command help
-n --network: (required) Network on which to run the command [sandbox or livenet] (local is for development only)
-v --verbose: (optional) Output more details on logs
-f --format: (optional) Specify how to format the output [json|table|yaml|raw]. See command help to know supported format.
-m --chainmeta: (optional) Output chain meta data related to the read itself."
--node: (optional) URL of custom node representing blockchain endpoint (environment variable: UNS_NODE)
--nftfactory: (optional): URL of custom forge factory services endpoint (environment variable: UNS_SERVICES)
--await-confirmation: (optional) Maximum number of blocks to wait to get one confirmation of the transaction. Default to 3. 0 for immediate return.
--passphrase: The passphrase of the owner of UNIKNAME. If you do not enter a passphrase you will be prompted for it.
--second-passphrase: The second crypto account passphrase. If you have set up a second passphrase on your crypto-account, you can specify it with this flag.
--sender-account: The @unikname or unik ID of the transaction sender. If --sender-account is provided, a check is performed to verify if the passphrase match the unikname's account.

# APIs

API
Wallet
/wallets/{id} → read wallet info and UNS balance
/wallets/{id}/uniks → list UNIKNAMEs owned by a specific wallet.
UNS protocol Token
/transactions → list all transactions on chain
/transactions/{id} →list transactions for a specific UNIK
UNIKNAME NFT tokens
/uniks/{unikid}
/uniks/{unikid}/transactions
/uniks/{unikid}/properties
/uniks/{unikid}/properties/{propertyKey}
/uniks _→ list minted UNIKNAMEs

# Transaction Types

Transactions
Transfer UNIK tokens
Second Signature Registration
Delegate Registration
Vote
Multi Signature Registration
IPFS
Timelock Transfer
Multi Payment
Delegate Resignation
UNIKNAME Disclose
UNIKNAME Update
UNIKNAME Mint
UNIKNAME Transfer

# Types of UNIKNAME

{1|individual|2|organization|3|network}

The default type value is individual: @Bob always designates the individual DID of Bob. So if you want to designate the DID of MyCompany, you will need to specify the type: e.g. @organization:MyCompany.

# Property keys of UNIKNAME

Property keys format must match with the following rules:

  • it must be alphanumeric: a-z, A-Z, 0-9
  • it may contains: + - . / _ (but no space characters at all)
  • it must be shorter or equals to 255 characters

# Property values of UNIKNAME

Property values format must match with the following rules:

  • it may any UTF-8 characters
  • it must be shorter or equals to 255 characters

# DID - Decentralized IDentifier

@unikname DID string format: [@][unik:][type:]explicitValue[?propertyKey|?*].