# 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

Each kind of type have different features, behaviors of the uns.network and governance processes.

Possible Values

  • 1: UNIK for individuals identifers
  • 2: UNIK for organizations identifiers
  • 3: UNIK for networks identifiers

# Types and categories of UNIK

type # Category pattern
individual 0x101 / 257 Latin 1 Latin charset of SafeTypo, 1 chars long
individual 0x102 / 258 Latin 2 Latin charset of SafeTypo, 2 chars long
individual 0x103 / 259 Latin 3 Latin charset of SafeTypo, 3 chars long
individual 0x104 / 260 Latin Tiny Latin charset of SafeTypo, 4 to 5 chars long
individual 0x105 / 261 Latin Short Latin charset of SafeTypo, 6 to 9 chars long
individual 0x106 / 262 Latin Standard Latin charset of SafeTypo, 10 to 14 chars long
individual 0x107 / 263 Latin Long Latin charset of SafeTypo, 15 chars long and more
individual 0x110 / 272 Only numbers SafeTypo numbers
individual 0x111 / 273 Latin Single char greater than 1 char long and a suite of similar latin chars
organization 0x201 Standard Latin Latin charset of SafeTypo
network 0x301 Standard Latin Latin charset of SafeTypo

# 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

# Badges of UNIK

Badge How get it
Badges/Security/SecondPassphrase Set a second passphrase on your crypto-account
Badges/NP/Delegate Register your @unikname as delegate

# DID - Decentralized IDentifier

The expected format of a DID of kind "UNIK" is: [@][unik:][type:]explicitValue[?propertyKey|?*].

[...] are the optional parts of the pattern. Each part of the pattern are described below.

# Type

The type can be one of these values (numeric or letter format).

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

# explicitValue

The explicitValue is the usual value of your @unikname.

# propertyKey

The propertyKey part must match with property keys format.

# Examples

TODO