protobuf
// Source: https://github.com/provenance-io/provenance

// NameRecord is a structure used to bind ownership of a name heirarchy to a collection of addresses
message NameRecord {
  option (gogoproto.goproto_stringer) = false;

  // The bound name
  string name = 1;

  // The address the name resolves to.
  string address = 2;

  // Whether owner signature is required to add sub-names.
  bool restricted = 3;
}

• Names are always stored and compared using a lower case form or a hash derived from this normalized form.

• Unicode values that are not graphic, lower case, or digits are considered invalid.

• A single occurrence of the hyphen-minus character is allowed unless the value conforms to a valid UUID.

• Each component of the name is restricted to a length of 2 to 32 characters (inclusive). These limits are configurable in the module parameters.

• A maximum of 16 components for a name (levels in the hierarchy) is also enforced and configurable in the module parameters.

• Leading and trailing spaces are always trimmed off of names for consistency during processing and evaluation.

protobuf
// Source: https://github.com/provenance-io/provenance

// NameRecord is a structure used to bind ownership of a name heirarchy to a collection of addresses
message NameRecord {
  option (gogoproto.goproto_stringer) = false;

  // The bound name
  string name = 1;

  // The address the name resolved to.
  string address = 2;

  // Whether owner signature is required to add sub-names.
  bool restricted = 3;
}

protobuf
// Source: https://github.com/provenance-io/provenance

message MsgBindNameRequest {
  option (gogoproto.equal) = false;
  option (gogoproto.goproto_getters) = false;

  // The parent record to bind this name under.
  NameRecord parent = 1 [(gogoproto.nullable) = false];

  // The name record to bind under the parent
  NameRecord record = 2 [(gogoproto.nullable) = false];
}

• The parent name record does not exist

• The requestor does not match the owner listed on the parent record and the parent record indicates creation of child records is restricted

• The record being created is otherwise invalid due to format or contents of the name value itself

• Insufficient length of name

• Excessive length of name

• Not deriving from the parent record (targets another root)

protobuf
// Source: https://github.com/provenance-io/provenance

// MsgDeleteNameRequest defines an sdk.Msg type that is used to remove an existing address/name binding. The binding
// may not have any child names currently bound for this request to be successful. All associated attributes on account addresses will be deleted.
message MsgDeleteNameRequest {
  option (gogoproto.equal) = false;
  option (gogoproto.goproto_getters) = false;

  // The parent record the record to remove is under.
  NameRecord parent = 1 [(gogoproto.nullable) = false];

  // The record being removed
  NameRecord record = 2 [(gogoproto.nullable) = false];
}

• Any components of the request do not pass basic integrity and format checks

• The parent name record does not exist

• The record to remove does not exist

• Any child records exist under the record being removed

• The requestor does not match the owner listed on the record

protobuf
// Source: https://github.com/provenance-io/provenance

// MsgModifyNameRequest defines a method that is used to update an existing address/name binding.
message MsgModifyNameRequest {
  option (cosmos.msg.v1.signer) = "authority";

  // The address signing the message
  string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];

  // The record being updated
  NameRecord record = 2 [(gogoproto.nullable) = false];
}

• Any components of the request do not pass basic integrity and format checks

• The record to update does not exist

• The authority does not match the gov module or the name owner

protobuf
// Source: https://github.com/provenance-io/provenance

message CreateRootNameProposal {
  option (gogoproto.equal) = false;
  option (gogoproto.goproto_getters) = false;
  option (gogoproto.goproto_stringer) = false;

  string title = 1;
  string description = 2;
  string name = 3;
  string owner = 4;
  bool restricted = 5;
}

• The name already exists

• Insufficient length of name

• Excessive length of name

protobuf
// Source: https://github.com/provenance-io/provenance

message MsgCreateRootNameRequest {
  option (cosmos.msg.v1.signer) = "authority";

  // The signing authority for the request
  string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];

  // NameRecord is a structure used to bind ownership of a name hierarchy to a collection of addresses
  NameRecord record = 2;
}

• The name already exists

• Insufficient length of name

• Excessive length of name

• The authority does not match the gov module

• GitHub Repository: provenance-io/provenance

• Documentation: Provenance Blockchain Developer Portal

go
// Example event emission structure
// Source: https://github.com/provenance-io/provenance

// Event types emitted by the name module
const (
    EventTypNameBound   = "name_bound"
    EventTypeNameUnbound = "name_unbound"
    EventTypeNameModify  = "name_modify"
)

// Attribute keys used in events
const (
    AttributeKeyName       = "name"
    AttributeKeyAddress    = "address"
    AttributeKeyRestricted = "restricted"
    AttributeKeyAuthority  = "authority"
)

protobuf
// Source: https://github.com/provenance-io/provenance

// QueryParamsRequest is the request type for the Query/Params RPC method.
message QueryParamsRequest {}

protobuf
// Source: https://github.com/provenance-io/provenance

// QueryParamsResponse is the response type for the Query/Params RPC method.
message QueryParamsResponse {
  // params defines the parameters of the module.
  Params params = 1 [(gogoproto.nullable) = false];
}

protobuf
// Source: https://github.com/provenance-io/provenance

// QueryResolveRequest is the request type for the Query/Resolve method.
message QueryResolveRequest {
  option (gogoproto.equal)           = false;
  option (gogoproto.goproto_getters) = false;

  // name to resolve the address for
  string name = 1;
}

protobuf
// Source: https://github.com/provenance-io/provenance

// QueryResolveResponse is the response type for the Query/Resolve method.
message QueryResolveResponse {
  // a string containing the address the name resolves to
  string address = 1;

  // Whether owner signature is required to add sub-names.
  bool restricted = 2;
}

protobuf
// Source: https://github.com/provenance-io/provenance

// QueryReverseLookupRequest is the request type for the Query/ReverseLookup method.
message QueryReverseLookupRequest {
  option (gogoproto.equal)           = false;
  option (gogoproto.goproto_getters) = false;

  // address to find name records for
  string address = 1;

  // pagination defines an optional pagination for the request.
  cosmos.base.query.v1beta1.PageRequest pagination = 2;
}

protobuf
// Source: https://github.com/provenance-io/provenance

// QueryReverseLookupResponse is the response type for the Query/Resolve method.
message QueryReverseLookupResponse {
  option (gogoproto.equal)           = false;
  option (gogoproto.goproto_getters) = false;

  // an array of names bound against a given address
  repeated string name = 1;

  // pagination defines an optional pagination for the request.
  cosmos.base.query.v1beta1.PageResponse pagination = 2;
}

protobuf
// Example Query Service Definition
// Source: https://github.com/provenance-io/provenance

service Query {
  // Params queries params of the name module.
  rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
    option (google.api.http).get = "/provenance/name/v1/params";
  }

  // Resolve queries for the address associated with a given name
  rpc Resolve(QueryResolveRequest) returns (QueryResolveResponse) {
    option (google.api.http).get = "/provenance/name/v1/resolve/{name}";
  }

  // ReverseLookup queries for all names bound against a given address
  rpc ReverseLookup(QueryReverseLookupRequest) returns (QueryReverseLookupResponse) {
    option (google.api.http).get = "/provenance/name/v1/lookup/{address}";
  }
}