Domain Operations
Checks that there is a valid domain record with the specified name and the address.
Entrypoint:
check_addressParameter | Type | Description |
name | bytes | The UTF-8 encoded name to check. |
address | address | The expected address. |
CameLIGO
Michelson
type check_address_param = [@layout:comb] {
name: bytes;
address: address
}
(* Checks that a name corresponds to an address. *)
| Check_address of check_address_param
parameter (or
(pair %check_address
(bytes %name)
(address %address)
# ... more entrypoints outside of this interoperability spec
);
Error | Description |
AMOUNT_NOT_ZERO | The transferred amount of tez is not zero. |
NAME_ADDRESS_MISMATCH | There is no valid domain record with the specified name or it resolves to an address different from the expected one. |
Claims a reverse record corresponding to a domain (a forward record). The claimed reverse record will map the sender's address to the specified domain name.
Entrypoint:
claim_reverse_recordParameter | Type | Description |
name | bytes | The UTF-8 encoded name to claim. |
owner | address | The owner of the record allowed to make changes. |
CameLIGO
type claim_reverse_record_param = [@layout:comb] {
name: bytes option;
owner: address;
}
| Claim_reverse_record of claim_reverse_record_param
Error | Description |
AMOUNT_NOT_ZERO | The transferred amount of tez is not zero. |
NAME_ADDRESS_MISMATCH | There is no domain record with the specified name or it resolves to an address different from the sender's address. |
Creates or overwrites an existing domain record. The current sender must be the owner of the parent record.
If there was an existing corresponding reverse record referencing this domain and the address of this domain changed, the reverse record's name will be updated to
None to preserve consistency.Entrypoint:
set_child_recordParameter | Type | Description |
label | bytes | The UTF-8 encoded label. |
parent | bytes | The UTF-8 encoded parent domain. |
address | address option | The optional address the record resolves to. |
owner | address | The owner of the record allowed to make changes. |
data | (string, bytes) map | A map of any additional data clients wish to store with the domain. |
expiry | timestamp option | The expiry of this record. Only applicable to second-level domains as all higher-level domains share the expiry of their ancestor 2LD. |
CameLIGO
type set_child_record_param = [@layout:comb] {
label: bytes;
parent: bytes;
address: address option;
owner: address;
data: (string, bytes) map;
expiry: timestamp option;
}
| Set_child_record of set_child_record_param
Error | Description |
AMOUNT_NOT_ZERO | The transferred amount of tez is not zero. |
PARENT_NOT_FOUND | There is no record for the specified parent domain. |
NOT_AUTHORIZED | The current sender is not the current record owner. |
INVALID_LABEL | |
LABEL_EMPTY | The given label is empty. |
LABEL_TOO_LONG | The label is too long. |
NAME_TOO_LONG | The name (label + parent) is too long. |
Updates an existing domain record. The current sender must be its owner.
If there was an existing corresponding reverse record referencing this domain and the address of this domain changed, the reverse record's name will be updated to
None to preserve consistency.Entrypoint:
update_recordParameter | Type | Description |
name | bytes | The UTF-8 encoded name of the domain to update. |
address | address option | The optional new address the record resolves to. |
owner | address | The new owner of the record allowed to make changes. |
data | (string, bytes) map | The new map of any additional data that clients wish to store with the domain. |
CameLIGO
type update_record_param = [@layout:comb] {
name: bytes;
address: address option;
owner: address;
data: (string, bytes) map;
}
| Update_record of update_record_param
Error | Description |
AMOUNT_NOT_ZERO | The transferred amount of tez is not zero. |
RECORD_NOT_FOUND | There is no domain record for the specified name. |
NOT_AUTHORIZED | The current sender is not the current record owner. |
Updates an existing reverse record. The current sender must be its owner. There must be a corresponding domain record.
Entrypoint:
claim_reverse_recordParameter | Type | Description |
address | address | The address of the reverse record to update. |
name | bytes option | The new UTF-8 encoded name the record resolves to. |
owner | address | The owner of the record allowed to make changes. |
CameLIGO
type update_reverse_record_param = [@layout:comb] {
address: address;
name: bytes option;
owner: address;
}
| Update_reverse_record of update_reverse_record_param
Error | Description |
AMOUNT_NOT_ZERO | The transferred amount of tez is not zero. |
RECORD_NOT_FOUND | There is no reverse record with the specified address. |
NOT_AUTHORIZED | The current sender is not the current record owner. |
NAME_ADDRESS_MISMATCH | There is no domain record with the specified name or it resolves to a different address. This can occur only if the name is specified. |