# Soulbound TLD factory contract

Soulbound TLD Factory is identical to the Flexi TLD Factory, except the embedded TLD template is slighly different (it does not allow token transfers).

Contract code: https://github.com/punk-domains-2/punk-contracts/blob/main/contracts/factories/soulbound/SoulboundPunkTLDFactory.sol

There are multiple factory contracts, Soulbound is one of them. Read more about the Punk Domains architecture in this article: Modular Architecture.

Note that public state variables can also be used as read methods, that's why their code is listed as a method.

Returns an array of all TLDs that were created with this factory contract.

function tldNamesAddresses(string memory tldName) public view returns(address)

Input:

• The TLD name (must start with a dot)

Output:

• The TLD contract address

Returns the address of the ForbiddenTlds contract.

function forbiddenTlds() public view returns(address)

Output:

• The address of the ForbiddenTlds contract

Returns the address of the default FlexiPunkMetadata contract for the TLD template.

function metadataAddress() public view returns(address)

Output:

• The address of the FlexiPunkMetadata contract

For every new domain name (created in a TLD contract) a royalty payment is taken and sent to Punk Domains governance.

In case a domain is created for free by TLD owner, or if royalty is set to 0, there's no royalty to be paid.

The royalty amount set in the Factory contract applies only to newly created TLDs and can be then changed separately in each TLD contract.

function royalty() public view returns(uint256)

Output:

• TLD royalty in wei

Returns the price to create a new TLD.

function price() public view returns(uint256)

Output:

• TLD price in wei

If this value is set to false, only the Factory owner (Punk Domains governance) can create new TLDs (for free). Otherwise anyone can create new TLDs (but paid).

function buyingEnabled() public view returns(bool)

Output:

• Boolean value (true or false)

Returns the maximum length of a TLD name.

function nameMaxLength() public view returns(uint256)

Output:

• The number of characters that a TLD name can have at maximum

Returns an array of all TLDs that were created with this factory contract.

function getTldsArray() public view returns(string[] memory)

Output:

• An array of TLD names

If buying TLDs is enabled, anyone can create a new TLD name.

function createTld(
	string memory _name,
	string memory _symbol,
	address _tldOwner,
	uint256 _domainPrice,
	bool _buyingEnabled
) public payable returns(address)

Inputs:

• _name: A TLD name, for example .wagmi. Then name must contain only one dot which must be at the beginning.
• _symbol: The symbol is usually TLD name in uppercase letters. Symbol is only needed because the ERC-721 standard requires it, otherwise it's irrelevant.
• _tldOwner: The owner of the newly created TLD. Can be a different entity than the msg.sender. TLD owner will receive payments for all newly created domains under this TLD.
• _domainPrice: Price for creating new domains under this TLD. TLD owner can change this at any time in the TLD contract.
• _buyingEnabled: Should buying domains be enabled from the start or not.

Output:

• Newly created TLD address

When a new TLD is created, a TLD Factory needs to check with the Forbidden TLDs contract whether the TLD name is still available. If it is, the factory also needs to register the newly created TLD name with the Forbidden TLDs contract.

In order to do that, the Forbidden TLDs address needs to be specified in the factory contract.

function changeForbiddenTldsAddress(address _forbiddenTlds) public onlyOwner

Input:

• _forbiddenTlds: The address of the Forbidden TLDs contract

Factory owner can change the address of the default metadata contract. This is the address that each newly created TLD receives as an input. Every TLD contract owner can later on change the metadata address within the TLD contract, if they want.

function changeMetadataAddress(address _mAddr) external onlyOwner

Input:

• _mAddr: Metadata contract address

Factory owner can change the max name length for new TLDs.

function changeNameMaxLength(uint256 _maxLength) public onlyOwner

Input:

• _maxLength: Max TLD name length

Factory owner can change the price for minting new TLDs.

function changePrice(uint256 _price) public onlyOwner

Input:

• _price: TLD price in wei

Factory owner can change the initial royalty amount which is set when a new TLD is created. The royalty amount can then be changed separately in each TLD contract by the Factory owner.

function changeRoyalty(uint256 _royalty) public onlyOwner

Input:

• _royalty: royalty amount in wei

Factory owner can create a new TLD for free.

function ownerCreateTld(
	string memory _name,
	string memory _symbol,
	address _tldOwner,
	uint256 _domainPrice,
	bool _buyingEnabled
) public onlyOwner returns(address)

Inputs:

• _name: A TLD name, for example .wagmi. Then name must contain only one dot which must be at the beginning.
• _symbol: The symbol is usually TLD name in uppercase letters. Symbol is only needed because the ERC-721 standard requires it, otherwise it's irrelevant.
• _tldOwner: The owner of the newly created TLD. Can be a different entity than the msg.sender. TLD owner will receive payments for all newly created domains under this TLD.
• _domainPrice: Price for creating new domains under this TLD. TLD owner can change this at any time in the TLD contract.
• _buyingEnabled: Should buying domains be enabled from the start or not.

Output:

• Newly created TLD address

Factory owner can either start or stop buying TLDs.

function toggleBuyingTlds() public onlyOwner

*Methods marked with a star are specific for the Flexi/Soulbound contract. They are not obligatory for other contracts of that type.