Naming API

Moera Naming API is based on JSON-RPC protocol. Until the API is stabilized, it may be changed in various ways and backward compatibility is not guaranteed.

timestamp below is the number of seconds that passed since 01-01-1970 00:00:00 in UTC timezone.

Calls

put(name, generation, updatingKey, nodeUri, signingKey, validFrom, previousDigest, signature)

Register or update the name. See Architecture Overview for the detailed description of the algorithm.

Parameters:

String name – the name to be registered/updated. Required.

int generation – the name generation to be registered/updated. Required.

byte[] updatingKey – the public key for verifying signatures of further updates of the name. May be null – the current key is preserved in this case.

String nodeUri – URI of the REST API endpoint of the node to which the name is assigned. May be null – the current URI is preserved in this case.

byte[] signingKey – the public key of the name owner. May be null – the current key is preserved in this case.

timestamp validFrom – the moment in time the owner's key is valid from. May be null, if signingKey is also null.

byte[] previousDigest – the unique identifier as reported by a naming server of the current state of the name. Used to detect the situations when the name was changed by someone else between sending the request and processing it. May be null, if the name was never registered before.

byte[] signature – the signature, if required, null otherwise.

Returns:

UUID – identifier of the operation that was created

Fingerprint: read more

Type	Value
String	name
int	generation
byte[]	updatingKey, if not null, or the current key otherwise
String	nodeUri, if not null, or the current URI otherwise
byte[]	signingKey, if not null, or the current key otherwise
timestamp	validFrom, if signingKey is not null, or the timestamp of the current key otherwise
byte[]	previousDigest

getStatus(operationId)

Get current status of the operation.

Parameters:

UUID operationId

Returns:

OperationStatusInfo – the operation status or null, if the operation ID is unknown

getCurrent(name, generation)

Get current information about the given generation of the name.

Parameters:

String name

int generation

Returns:

RegisteredNameInfo – the information or null, if the name/generation is not found

getPast(name, generation, at)

Get past information about the given generation of the name.

Parameters:

String name

int generation

timestamp at – the moment in time the information is related to

Returns:

RegisteredNameInfo – the information or null, if the name/generation did not exist at the given moment

isFree(name, generation)

Check if the given name is available for registration.

Parameters:

String name

int generation

Returns:

boolean – true, if the name is free, false otherwise

getSimilar(name)

Find a name that is close to the given name.

Parameters:

String name

Returns:

RegisteredNameInfo – information about the name or null, if no name found that is close enough

getAllKeys(name, generation)

Get the whole history of signing keys for the given name.

Parameters:

String name

int generation

Returns:

SigningKeyInfo[]

getAll(at, page, size)

Get the list of all registered names at the given moment. The list is returned in pages, one per call.

Parameters:

timestamp at – the moment in time the information is related to

int page – number of the page to be returned (starting from 0)

int size – size of the page

Returns:

RegisteredNameInfo[]

getAllNewer(at, page, size)

Get the list of all names registered after the given moment. The list is returned in pages, one per call.

Parameters:

timestamp at – the moment in time the information is related to

int page – number of the page to be returned (starting from 0)

int size – size of the page

Returns:

RegisteredNameInfo[]

Structures

OperationStatusInfo

RegisteredNameInfo

SigningKeyInfo

Enums

OperationStatus

This enum is used to designate the operation status both by the naming server and by the node.

Error codes