Skip to main content

SoulStore

Masa Finance

Soul Store

Soul Store, that can mint new Soulbound Identities and Soul Name NFTs, paying a fee

From this smart contract we can mint new Soulbound Identities and Soul Name NFTs. This minting can be done paying a fee in ETH, USDC or MASA

Methods

DEFAULT_ADMIN_ROLE

function DEFAULT_ADMIN_ROLE() external view returns (bytes32)

Returns

NameTypeDescription
_0bytes32undefined

PROJECT_ADMIN_ROLE

function PROJECT_ADMIN_ROLE() external view returns (bytes32)

Returns

NameTypeDescription
_0bytes32undefined

addAuthority

function addAuthority(address _authority) external nonpayable

Adds a new authority to the list of authorities

The caller must have the admin or project admin role to call this function

Parameters

NameTypeDescription
_authorityaddressNew authority to add

authorities

function authorities(address) external view returns (bool)

Parameters

NameTypeDescription
_0addressundefined

Returns

NameTypeDescription
_0boolundefined

disablePaymentMethod

function disablePaymentMethod(address _paymentMethod) external nonpayable

Removes a token as a valid payment method

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_paymentMethodaddressToken to remove

eip712Domain

function eip712Domain() external view returns (bytes1 fields, string name, string version, uint256 chainId, address verifyingContract, bytes32 salt, uint256[] extensions)

See {EIP-5267}. Available since v4.9.

Returns

NameTypeDescription
fieldsbytes1undefined
namestringundefined
versionstringundefined
chainIduint256undefined
verifyingContractaddressundefined
saltbytes32undefined
extensionsuint256[]undefined

enablePaymentMethod

function enablePaymentMethod(address _paymentMethod) external nonpayable

Adds a new token as a valid payment method

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_paymentMethodaddressNew token to add

enabledPaymentMethod

function enabledPaymentMethod(address) external view returns (bool)

Parameters

NameTypeDescription
_0addressundefined

Returns

NameTypeDescription
_0boolundefined

enabledPaymentMethods

function enabledPaymentMethods(uint256) external view returns (address)

Parameters

NameTypeDescription
_0uint256undefined

Returns

NameTypeDescription
_0addressundefined

getEnabledPaymentMethods

function getEnabledPaymentMethods() external view returns (address[])

Returns all available payment methods

Returns the address of all available payment methods

Returns

NameTypeDescription
_0address[]Array of all enabled payment methods

getNameRegistrationPricePerYear

function getNameRegistrationPricePerYear(uint256 nameLength) external view returns (uint256)

Returns the price of register a name per year in stable coin for an specific length

Returns the price for registering per year in USD for an specific name length

Parameters

NameTypeDescription
nameLengthuint256Length of the name

Returns

NameTypeDescription
_0uint256Price in stable coin for that name length

getPriceForMintingName

function getPriceForMintingName(address paymentMethod, uint256 nameLength, uint256 yearsPeriod) external view returns (uint256 price)

Returns the price of the name minting

Returns current pricing for name minting for a given name length and years period

Parameters

NameTypeDescription
paymentMethodaddressAddress of token that user want to pay
nameLengthuint256Length of the name
yearsPerioduint256Years of validity of the name

Returns

NameTypeDescription
priceuint256Current price of the name minting in the given payment method

getPriceForMintingNameWithProtocolFee

function getPriceForMintingNameWithProtocolFee(address paymentMethod, uint256 nameLength, uint256 yearsPeriod) external view returns (uint256 price, uint256 protocolFee)

Returns the price of the name minting with protocol fee

Returns current pricing for name minting for a given name length and years period with protocol fee

Parameters

NameTypeDescription
paymentMethodaddressAddress of token that user want to pay
nameLengthuint256Length of the name
yearsPerioduint256Years of validity of the name

Returns

NameTypeDescription
priceuint256Current price of the name minting in the given payment method
protocolFeeuint256Current protocol fee of the name minting in the given payment method

getProtocolFee

function getProtocolFee(address paymentMethod, uint256 amount) external view returns (uint256)

Calculates the protocol fee added to the project fee

This method will calculate the protocol fee based on the payment method

Parameters

NameTypeDescription
paymentMethodaddressAddress of token that user want to pay
amountuint256Price to be paid in the specified payment method

Returns

NameTypeDescription
_0uint256undefined

getProtocolFeeSub

function getProtocolFeeSub(uint256 amount) external view returns (uint256)

Calculates the protocol fee substracted from the amount

This method will calculate the protocol fee based on the payment method

Parameters

NameTypeDescription
amountuint256Price to be paid in the specified payment method

Returns

NameTypeDescription
_0uint256undefined

getRoleAdmin

function getRoleAdmin(bytes32 role) external view returns (bytes32)

Returns the admin role that controls role. See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.

Parameters

NameTypeDescription
rolebytes32undefined

Returns

NameTypeDescription
_0bytes32undefined

grantRole

function grantRole(bytes32 role, address account) external nonpayable

Grants role to account. If account had not been already granted role, emits a {RoleGranted} event. Requirements: - the caller must have role's admin role. May emit a {RoleGranted} event.

Parameters

NameTypeDescription
rolebytes32undefined
accountaddressundefined

hasRole

function hasRole(bytes32 role, address account) external view returns (bool)

Returns true if account has been granted role.

Parameters

NameTypeDescription
rolebytes32undefined
accountaddressundefined

Returns

NameTypeDescription
_0boolundefined

masaToken

function masaToken() external view returns (address)

Returns

NameTypeDescription
_0addressundefined

nameRegistrationPricePerYear

function nameRegistrationPricePerYear(uint256) external view returns (uint256)

Parameters

NameTypeDescription
_0uint256undefined

Returns

NameTypeDescription
_0uint256undefined

pause

function pause() external nonpayable

Pauses the smart contract

The caller must have the admin role to call this function

paused

function paused() external view returns (bool)

Returns true if the contract is paused, and false otherwise.

Returns

NameTypeDescription
_0boolundefined

projectFeeReceiver

function projectFeeReceiver() external view returns (address)

Returns

NameTypeDescription
_0addressundefined

protocolFeeAmount

function protocolFeeAmount() external view returns (uint256)

Returns

NameTypeDescription
_0uint256undefined

protocolFeePercent

function protocolFeePercent() external view returns (uint256)

Returns

NameTypeDescription
_0uint256undefined

protocolFeePercentSub

function protocolFeePercentSub() external view returns (uint256)

Returns

NameTypeDescription
_0uint256undefined

protocolFeeReceiver

function protocolFeeReceiver() external view returns (address)

Returns

NameTypeDescription
_0addressundefined

purchaseIdentity

function purchaseIdentity() external nonpayable returns (uint256)

Mints a new Soulbound Identity purchasing it

This function allows the purchase of a soulbound identity for free

Returns

NameTypeDescription
_0uint256TokenId of the new soulbound identity

purchaseIdentityAndName

function purchaseIdentityAndName(address paymentMethod, string name, uint256 nameLength, uint256 yearsPeriod, string tokenURI, address authorityAddress, bytes signature) external payable returns (uint256)

Mints a new Soulbound Identity and Name purchasing it

This function allows the purchase of a soulbound identity and name using stable coin (USDC), native token (ETH) or utility token (MASA)

Parameters

NameTypeDescription
paymentMethodaddressAddress of token that user want to pay
namestringName of the new soul name
nameLengthuint256Length of the name
yearsPerioduint256Years of validity of the name
tokenURIstringURI of the NFT
authorityAddressaddressAddress of the authority
signaturebytesSignature of the authority

Returns

NameTypeDescription
_0uint256TokenId of the new soulbound identity

purchaseName

function purchaseName(address paymentMethod, address to, string name, uint256 nameLength, uint256 yearsPeriod, string tokenURI, address authorityAddress, bytes signature) external payable returns (uint256)

Mints a new Soul Name purchasing it

This function allows the purchase of a soul name using stable coin (USDC), native token (ETH) or utility token (MASA)

Parameters

NameTypeDescription
paymentMethodaddressAddress of token that user want to pay
toaddressAddress of the owner of the new soul name
namestringName of the new soul name
nameLengthuint256Length of the name
yearsPerioduint256Years of validity of the name
tokenURIstringURI of the NFT
authorityAddressaddressAddress of the authority
signaturebytesSignature of the authority

Returns

NameTypeDescription
_0uint256TokenId of the new sou name

removeAuthority

function removeAuthority(address _authority) external nonpayable

Removes an authority from the list of authorities

The caller must have the admin or project admin role to call this function

Parameters

NameTypeDescription
_authorityaddressAuthority to remove

renounceRole

function renounceRole(bytes32 role, address account) external nonpayable

Revokes role from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked role, emits a {RoleRevoked} event. Requirements: - the caller must be account. May emit a {RoleRevoked} event.

Parameters

NameTypeDescription
rolebytes32undefined
accountaddressundefined

revokeRole

function revokeRole(bytes32 role, address account) external nonpayable

Revokes role from account. If account had been granted role, emits a {RoleRevoked} event. Requirements: - the caller must have role's admin role. May emit a {RoleRevoked} event.

Parameters

NameTypeDescription
rolebytes32undefined
accountaddressundefined

setMasaToken

function setMasaToken(address _masaToken) external nonpayable

Sets the utility token to pay the fee in (MASA)

The caller must have the admin role to call this function It can be set to address(0) to disable paying in MASA

Parameters

NameTypeDescription
_masaTokenaddressNew utility token to pay the fee in

setNameRegistrationPricePerYear

function setNameRegistrationPricePerYear(uint256 _nameLength, uint256 _nameRegistrationPricePerYear) external nonpayable

Sets the price of the name registering per one year in stable coin

The caller must have the admin or project admin role to call this function

Parameters

NameTypeDescription
_nameLengthuint256Length of the name
_nameRegistrationPricePerYearuint256New price of the name registering per one year in stable coin for that name length per year

setProjectFeeReceiver

function setProjectFeeReceiver(address _projectFeeReceiver) external nonpayable

Set the project fee receiver wallet

The caller must have the admin or project admin role to call this function

Parameters

NameTypeDescription
_projectFeeReceiveraddressNew project fee receiver wallet

setProtocolFeeAmount

function setProtocolFeeAmount(uint256 _protocolFeeAmount) external nonpayable

Set the protocol fee amount

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_protocolFeeAmountuint256New protocol fee amount

setProtocolFeePercent

function setProtocolFeePercent(uint256 _protocolFeePercent) external nonpayable

Set the protocol fee percent added to the project fee

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_protocolFeePercentuint256New protocol fee percent added to the project fee

setProtocolFeePercentSub

function setProtocolFeePercentSub(uint256 _protocolFeePercentSub) external nonpayable

Set the protocol fee percent substracted from the amount

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_protocolFeePercentSubuint256New protocol fee percent substracted from the amount

setProtocolFeeReceiver

function setProtocolFeeReceiver(address _protocolFeeReceiver) external nonpayable

Set the protocol fee wallet

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_protocolFeeReceiveraddressNew protocol fee wallet

setSoulName

function setSoulName(contract ISoulName _soulName) external nonpayable

Sets the SoulName contract address linked to this store

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_soulNamecontract ISoulNameNew SoulName contract address

setSoulboundIdentity

function setSoulboundIdentity(contract ISoulboundIdentity _soulboundIdentity) external nonpayable

Sets the SoulboundIdentity contract address linked to this store

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_soulboundIdentitycontract ISoulboundIdentityNew SoulboundIdentity contract address

setStableCoin

function setStableCoin(address _stableCoin) external nonpayable

Sets the stable coin to pay the fee in (USDC)

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_stableCoinaddressNew stable coin to pay the fee in

setSwapRouter

function setSwapRouter(address _swapRouter) external nonpayable

Sets the swap router address

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_swapRouteraddressNew swap router address

setWrappedNativeToken

function setWrappedNativeToken(address _wrappedNativeToken) external nonpayable

Sets the wrapped native token address

The caller must have the admin role to call this function

Parameters

NameTypeDescription
_wrappedNativeTokenaddressNew wrapped native token address

soulName

function soulName() external view returns (contract ISoulName)

Returns

NameTypeDescription
_0contract ISoulNameundefined

soulboundIdentity

function soulboundIdentity() external view returns (contract ISoulboundIdentity)

Returns

NameTypeDescription
_0contract ISoulboundIdentityundefined

stableCoin

function stableCoin() external view returns (address)

Returns

NameTypeDescription
_0addressundefined

supportsInterface

function supportsInterface(bytes4 interfaceId) external view returns (bool)

See {IERC165-supportsInterface}.

Parameters

NameTypeDescription
interfaceIdbytes4undefined

Returns

NameTypeDescription
_0boolundefined

swapRouter

function swapRouter() external view returns (address)

Returns

NameTypeDescription
_0addressundefined

unpause

function unpause() external nonpayable

Unpauses the smart contract

The caller must have the admin role to call this function

wrappedNativeToken

function wrappedNativeToken() external view returns (address)

Returns

NameTypeDescription
_0addressundefined

Events

EIP712DomainChanged

event EIP712DomainChanged()

MAY be emitted to signal that the domain could have changed.

Paused

event Paused(address account)

Emitted when the pause is triggered by account.

Parameters

NameTypeDescription
accountaddressundefined

Pay

event Pay(address indexed paymentMethod, uint256 amount, uint256 protocolFee)

Parameters

NameTypeDescription
paymentMethod indexedaddressundefined
amountuint256undefined
protocolFeeuint256undefined

RoleAdminChanged

event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)

Emitted when newAdminRole is set as role's admin role, replacing previousAdminRole DEFAULT_ADMIN_ROLE is the starting admin for all roles, despite {RoleAdminChanged} not being emitted signaling this. Available since v3.1.

Parameters

NameTypeDescription
role indexedbytes32undefined
previousAdminRole indexedbytes32undefined
newAdminRole indexedbytes32undefined

RoleGranted

event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender)

Emitted when account is granted role. sender is the account that originated the contract call, an admin role bearer except when using {AccessControl-_setupRole}.

Parameters

NameTypeDescription
role indexedbytes32undefined
account indexedaddressundefined
sender indexedaddressundefined

RoleRevoked

event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender)

Emitted when account is revoked role. sender is the account that originated the contract call: - if using revokeRole, it is the admin role bearer - if using renounceRole, it is the role bearer (i.e. account)

Parameters

NameTypeDescription
role indexedbytes32undefined
account indexedaddressundefined
sender indexedaddressundefined

SoulNamePurchased

event SoulNamePurchased(address indexed account, uint256 tokenId, string indexed name, uint256 yearsPeriod, address indexed paymentMethod, uint256 price, uint256 protocolFee)

Parameters

NameTypeDescription
account indexedaddressundefined
tokenIduint256undefined
name indexedstringundefined
yearsPerioduint256undefined
paymentMethod indexedaddressundefined
priceuint256undefined
protocolFeeuint256undefined

SoulboundIdentityAndNamePurchased

event SoulboundIdentityAndNamePurchased(address indexed account, uint256 tokenId, string indexed name, uint256 yearsPeriod, address indexed paymentMethod, uint256 price, uint256 protocolFee)

Parameters

NameTypeDescription
account indexedaddressundefined
tokenIduint256undefined
name indexedstringundefined
yearsPerioduint256undefined
paymentMethod indexedaddressundefined
priceuint256undefined
protocolFeeuint256undefined

SoulboundIdentityPurchased

event SoulboundIdentityPurchased(address indexed account, uint256 tokenId)

Parameters

NameTypeDescription
account indexedaddressundefined
tokenIduint256undefined

Unpaused

event Unpaused(address account)

Emitted when the pause is lifted by account.

Parameters

NameTypeDescription
accountaddressundefined

Errors

AlreadyAdded

error AlreadyAdded()

AuthorityNotExists

error AuthorityNotExists(address authority)

Parameters

NameTypeDescription
authorityaddressundefined

InsufficientEthAmount

error InsufficientEthAmount(uint256 amount)

Parameters

NameTypeDescription
amountuint256undefined

InvalidPaymentMethod

error InvalidPaymentMethod(address paymentMethod)

Parameters

NameTypeDescription
paymentMethodaddressundefined

InvalidShortString

error InvalidShortString()

InvalidSignature

error InvalidSignature()

InvalidToken

error InvalidToken(address token)

Parameters

NameTypeDescription
tokenaddressundefined

NonExistingErc20Token

error NonExistingErc20Token(address erc20token)

Parameters

NameTypeDescription
erc20tokenaddressundefined

NotAuthorized

error NotAuthorized(address signer)

Parameters

NameTypeDescription
signeraddressundefined

PaymentParamsNotSet

error PaymentParamsNotSet()

ProtocolFeeReceiverNotSet

error ProtocolFeeReceiverNotSet()

RefundFailed

error RefundFailed()

SameValue

error SameValue()

StringTooLong

error StringTooLong(string str)

Parameters

NameTypeDescription
strstringundefined

TransferFailed

error TransferFailed()

UserMustHaveProtocolOrProjectAdminRole

error UserMustHaveProtocolOrProjectAdminRole()

ZeroAddress

error ZeroAddress()