Parameters for registering a name in the Aptos network.

Configuration settings for the Aptos network.

The account initiating the name registration.

The name to be registered.

The expiration policy for the name registration.

interface RegisterNameParameters {
    aptosConfig: AptosConfig;
    expiration: {
        policy: "domain";
        years?: 1;
    } | {
        policy: "subdomain:follow-domain";
    } | {
        expirationDate: number;
        policy: "subdomain:independent";
    };
    name: string;
    options?: InputGenerateTransactionOptions;
    sender: Account;
    targetAddress?: AccountAddressInput;
    toAddress?: AccountAddressInput;
    transferable?: boolean;
}

Properties

aptosConfig: AptosConfig
expiration: {
    policy: "domain";
    years?: 1;
} | {
    policy: "subdomain:follow-domain";
} | {
    expirationDate: number;
    policy: "subdomain:independent";
}
name: string
sender: Account
targetAddress?: AccountAddressInput
transferable?: boolean