lthn/lns

Fork 0

Table of Contents

Alias RPC Reference

Daemon Methods

get_alias_details
Request:
Request description:
Response:
Response description:
get_alias_by_address
Request:
Request description:
Response:
Response description:
get_aliases
Request:
Request description:
Response:
Response description:
get_all_alias_details
Request:
Request description:
Response:
Response description:
get_alias_reward
Request:
Request description:
Response:
Response description:

Wallet Methods

register_alias
Request:
Request description:
Response:
Response description:
update_alias
Request:
Request description:
Response:
Response description:

Alias RPC Reference

Complete RPC methods for managing .lthn aliases on the Lethean blockchain.

Daemon Methods

These methods query alias data from the daemon (port 36941, testnet: 46941).

get_alias_details

Retrieves information about a specific address alias.

URL: http:://127.0.0.1:36941/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_alias_details",
  "params": {
    "alias": "gigabyted"
  }
}

Request description:

    "alias": The alias name for which details are being requested.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "alias_details": {
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
      "tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
    },
    "status": "OK"
  }
}

Response description:

    "alias_details": Contains the detailed information about the specified alias, including the associated wallet address, tracking key, comment etc..
      "address": Address of the alias.
      "comment": Arbitrary comment (optional).
      "tracking_key": View secret key of the corresponding address (optional).
    "status": Status of the call.

_{Auto-doc built with: 2.2.0.461[d830c07]}

get_alias_by_address

Retrieves all aliases registered for a given address.

URL: http:://127.0.0.1:36941/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_alias_by_address",
  "params": ""
}

Request description:

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "alias_info_list": [{
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "alias": "zxdya6q6whzwqjkmtcsjpc3ku",
      "comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
      "tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
    }],
    "status": "OK"
  }
}

Response description:

    "alias_info_list": List of alias_rpc_details objects, each containing detailed information about each alias registered to the specified address.
      "address": Address of the alias.
      "alias": Alias itself, a brief shortcut for an address.
      "comment": Arbitrary comment (optional).
      "tracking_key": View secret key of the corresponding address (optional).
    "status": Status of the call.

_{Auto-doc built with: 2.2.0.461[d830c07]}

get_aliases

Retrieves a specified portion of all registered aliases, allowing pagination through large sets of aliases.

URL: http:://127.0.0.1:36941/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_aliases",
  "params": {
    "count": 2,
    "offset": 0
  }
}

Request description:

    "count": The number of aliases to retrieve from the specified offset.
    "offset": The offset in the list of all aliases from which to start retrieving.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "aliases": [{
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "alias": "zxdya6q6whzwqjkmtcsjpc3ku",
      "comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
      "tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
    },{
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "alias": "zxdya6q6whzwqjkmtcsjpc3ku",
      "comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
      "tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
    }],
    "status": "OK"
  }
}

Response description:

    "aliases": List of alias_rpc_details objects, each containing information about an individual alias retrieved based on the request parameters.
      "address": Address of the alias.
      "alias": Alias itself, a brief shortcut for an address.
      "comment": Arbitrary comment (optional).
      "tracking_key": View secret key of the corresponding address (optional).
      "address": Address of the alias.
      "alias": Alias itself, a brief shortcut for an address.
      "comment": Arbitrary comment (optional).
      "tracking_key": View secret key of the corresponding address (optional).
    "status": Status of the call.

_{Auto-doc built with: 2.2.0.461[d830c07]}

get_all_alias_details

Retrieves all registered aliases along with associated information.

URL: http:://127.0.0.1:36941/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_all_alias_details",
  "params": {
  }
}

Request description:

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "aliases": [{
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "alias": "zxdya6q6whzwqjkmtcsjpc3ku",
      "comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
      "tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
    },{
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "alias": "zxdya6q6whzwqjkmtcsjpc3ku",
      "comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
      "tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
    }],
    "status": "OK"
  }
}

Response description:

    "aliases": List of alias_rpc_details objects, each containing information about an individual alias.
      "address": Address of the alias.
      "alias": Alias itself, a brief shortcut for an address.
      "comment": Arbitrary comment (optional).
      "tracking_key": View secret key of the corresponding address (optional).
      "address": Address of the alias.
      "alias": Alias itself, a brief shortcut for an address.
      "comment": Arbitrary comment (optional).
      "tracking_key": View secret key of the corresponding address (optional).
    "status": Status of the call.

_{Auto-doc built with: 2.2.0.461[d830c07]}

get_alias_reward

Retrieves the cost of registering an alias on the blockchain.

URL: http:://127.0.0.1:36941/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "get_alias_reward",
  "params": {
    "alias": "zxdya6q6whzwqjkmtcsjpc3ku"
  }
}

Request description:

    "alias": The alias name for which the registration cost is being queried.

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "reward": 100000000000,
    "status": "OK"
  }
}

Response description:

    "reward": The registration cost for the specified alias.
    "status": Status of the call.

_{Auto-doc built with: 2.2.0.461[d830c07]}

Wallet Methods

These methods register/update aliases via the wallet (port 36944, testnet: 46944).

register_alias

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "register_alias",
  "params": {
    "al": {
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "alias": "zxdya6q6whzwqjkmtcsjpc3ku",
      "comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
      "tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
    },
    "authority_key": ""
  }
}

Request description:

    "al": Alias details
      "address": Address of the alias.
      "alias": Alias itself, a brief shortcut for an address.
      "comment": Arbitrary comment (optional).
      "tracking_key": View secret key of the corresponding address (optional).
    "authority_key": Key for registering aliases shorter than 6 letters (team)

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_id": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Response description:

    "tx_id": If success - transactions that performs registration(alias becomes available after few confirmations)

_{Auto-doc built with: 2.2.0.461[d830c07]}

update_alias

Update an alias details/transwer alias ownership

URL: http:://127.0.0.1:36944/json_rpc

Request:

{
  "id": 0,
  "jsonrpc": "2.0",
  "method": "update_alias",
  "params": {
    "al": {
      "address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
      "alias": "zxdya6q6whzwqjkmtcsjpc3ku",
      "comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
      "tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
    }
  }
}

Request description:

    "al": Alias details
      "address": Address of the alias.
      "alias": Alias itself, a brief shortcut for an address.
      "comment": Arbitrary comment (optional).
      "tracking_key": View secret key of the corresponding address (optional).

Response:

{
  "id": 0,
  "jsonrpc": "2.0",
  "result": {
    "tx_id": "97d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"
  }
}

Response description:

    "tx_id": If success - transactions that performs registration(alias becomes available after few confirmations)

_{Auto-doc built with: 2.2.0.461[d830c07]}