# Command Line Interface (CLI)

CLI Rewards description CLI version
version Display version of the CLI 2.2.0
status Display uns.network blockchain status 2.2.0
send YES Send UNS tokens to another public address 2.2.0
resolve Resolve a decentralized Identifier
cryptoaccount:create Create a uns.network crypto-account 2.2.0
cryptoaccount:read Read current data of a specified cryptoaccount, eg. balance 2.2.0
cryptoaccount:address Get public address for a specified UNIK or for a passphrase 2.2.0
unik:create YES Create a UNIK Token 2.2.0
unik:read Read UNIK Token data 2.2.0
unik:disclose YES Disclose one or more explicit(s) value(s) related to a UNIK 2.2.0
unik:is-disclosed YES Check if UNIK has one or more disclosed explicit value 2.2.0
delegate:register YES Register a UNIK as delegate using @unikname or unikid 2.0.0
delegate:resign YES Resign delegate registration of a @unikname or unikid 2.0.0
delegate:vote YES Vote for a delegate with his @unikname or unikid 2.0.0
delegate:unvote YES Remove vote from a delegate with his @nikname or unikid 2.0.0
properties:get Get the value of a specific property of a UNIK token. 2.2.0
properties:list List all properties of a UNIK token 2.2.0

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 local] (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."

# APIs

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

# Transaction Types

Type Transaction
0 Transfer UNS tokens
1 Second Signature Registration
2 Delegate Registration
3 Vote
4 Multi Signature Registration
5 IPFS
6 Timelock Transfer
7 Multi Payment
9 Delegate Resignation
10 NFT Transfer
11 NFT Update
12 NFT Mint

# Types of UNIK

{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 UNIK

Property keys format must match with the following rules:

  • be alphanumeric: a-z,A-Z,0-9
  • be shorter or equals to 255 characters

# DID - Decentralized IDentifier

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

# Mint @unikname services

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

Prices for individual patterns:

Price (UNS) Pattern Description
500000 Individual - Digits - Tiny Only digits from Safetypo alphabet, 5 characters and less
50000 Individual - Digits - Standard Only digits from Safetypo alphabet, between 6 and 9 characters
100 Individual - Digits - Long Only digits from Safetypo alphabet, 10 character and more
5000000 Individual - Latin Safetypo - 1 Letters and digits from Safetypo alphabet, exactly 1 character
1000000 Individual - Latin Safetypo - 2 Letters and digits from Safetypo alphabet, exactly 2 characters
500000 Individual - Latin Safetypo - 3 Letters and digits from Safetypo alphabet, exactly 3 characters
50000 Individual - Latin Safetypo - Tiny Letters and digits from Safetypo alphabet, 4 or 5 characters
5000 Individual - Latin Safetypo - Short Letters and digits from Safetypo alphabet, 6 or 7 characters
100 Individual - Latin Safetypo - Normal Letters and digits from Safetypo alphabet, between 8 and 14 characters
10 Individual - Latin Safetypo - Long Letters and digits from Safetypo alphabet, more than 15 characters

Prices for organization patterns:

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

Prices for network pattern:

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