IBosonConfigHandler

View Source: contracts/interfaces/handlers/IBosonConfigHandler.sol

↗ Extends: IBosonConfigEvents

IBosonConfigHandler

Handles management of configuration within the protocol.
The ERC-165 identifier for this interface is: 0xbc28d3e6

Functions

• setTokenAddress(address payable _tokenAddress)
• getTokenAddress()
• setTreasuryAddress(address payable _treasuryAddress)
• getTreasuryAddress()
• setVoucherBeaconAddress(address _voucherBeaconAddress)
• getVoucherBeaconAddress()
• setBeaconProxyAddress(address _beaconProxyAddress)
• getBeaconProxyAddress()
• setProtocolFeePercentage(uint256 _protocolFeePercentage)
• getProtocolFeePercentage()
• setProtocolFeeFlatBoson(uint256 _protocolFeeFlatBoson)
• getProtocolFeeFlatBoson()
• setMaxEscalationResponsePeriod(uint256 _maxEscalationResponsePeriod)
• getMaxEscalationResponsePeriod()
• setMaxTotalOfferFeePercentage(uint16 _maxTotalOfferFeePercentage)
• getMaxTotalOfferFeePercentage()
• setBuyerEscalationDepositPercentage(uint256 _buyerEscalationDepositPercentage)
• getBuyerEscalationDepositPercentage()
• setAuthTokenContract(enum BosonTypes.AuthTokenType _authTokenType, address _authTokenContract)
• getAuthTokenContract(enum BosonTypes.AuthTokenType _authTokenType)
• setMaxRoyaltyPecentage(uint16 _maxRoyaltyPecentage)
• getMaxRoyaltyPecentage()
• setMinResolutionPeriod(uint256 _minResolutionPeriod)
• getMinResolutionPeriod()
• setMaxResolutionPeriod(uint256 _maxResolutionPeriod)
• getMaxResolutionPeriod()
• setMinDisputePeriod(uint256 _minDisputePeriod)
• getMinDisputePeriod()
• setAccessControllerAddress(address _accessControllerAddress)
• getAccessControllerAddress()

setTokenAddress

Sets the Boson Token (ERC-20 contract) address.
Emits a TokenAddressChanged event.
Reverts if _tokenAddress is the zero addressCaller must have ADMIN role.

function setTokenAddress(address payable _tokenAddress) 
external

Arguments

Name	Type	Description
_tokenAddress	address payable	the Boson Token (ERC-20 contract) address

getTokenAddress

Gets the Boson Token (ERC-20 contract) address.

function getTokenAddress() 
external
view
returns(address payable)

Returns

Name	Type	Description
	address payable

setTreasuryAddress

Sets the Boson Protocol multi-sig wallet address.
Emits a TreasuryAddressChanged event.
Reverts if _treasuryAddress is the zero addressCaller must have ADMIN role.

function setTreasuryAddress(address payable _treasuryAddress) 
external

Arguments

Name	Type	Description
_treasuryAddress	address payable	the the multi-sig wallet address

getTreasuryAddress

Gets the Boson Protocol multi-sig wallet address.

function getTreasuryAddress() 
external
view
returns(address payable)

Returns

Name	Type	Description
	address payable

setVoucherBeaconAddress

Sets the Boson Voucher beacon contract address.
Emits a VoucherBeaconAddressChanged event.
Reverts if _voucherBeaconAddress is the zero addressCaller must have ADMIN role.

function setVoucherBeaconAddress(address _voucherBeaconAddress) 
external

Arguments

Name	Type	Description
_voucherBeaconAddress	address	the Boson Voucher beacon contract address

getVoucherBeaconAddress

Gets the Boson Voucher beacon contract address.

function getVoucherBeaconAddress() 
external
view
returns(address)

Returns

address

setBeaconProxyAddress

Sets the Boson Voucher reference proxy implementation address.
Emits a BeaconProxyAddressChanged event.
Reverts if _beaconProxyAddress is the zero addressCaller must have ADMIN role.

function setBeaconProxyAddress(address _beaconProxyAddress) 
external

Arguments

Name	Type	Description
_beaconProxyAddress	address	reference proxy implementation address

getBeaconProxyAddress

Gets the beaconProxy address.

function getBeaconProxyAddress() 
external
view
returns(address)

Returns

address

setProtocolFeePercentage

Sets the protocol fee percentage.
Emits a ProtocolFeePercentageChanged event.
Reverts if the _protocolFeePercentage is greater than 10000.Caller must have ADMIN role.

function setProtocolFeePercentage(uint256 _protocolFeePercentage) 
external

Arguments

Name	Type	Description
_protocolFeePercentage	uint256	the percentage that will be taken as a fee from the net of a Boson Protocol sale or auction (after royalties) N.B. Represent percentage value as an unsigned int by multiplying the percentage by 100: e.g, 1.75% = 175, 100% = 10000

getProtocolFeePercentage

Gets the protocol fee percentage.

function getProtocolFeePercentage() 
external
view
returns(uint256)

Returns

uint256

setProtocolFeeFlatBoson

Sets the flat protocol fee for exchanges in $BOSON.
Emits a ProtocolFeeFlatBosonChanged event.Caller must have ADMIN role.

function setProtocolFeeFlatBoson(uint256 _protocolFeeFlatBoson) 
external

Arguments

Name	Type	Description
_protocolFeeFlatBoson	uint256	the flat fee taken for exchanges in $BOSON

getProtocolFeeFlatBoson

Gets the flat protocol fee for exchanges in $BOSON.

function getProtocolFeeFlatBoson() 
external
view
returns(uint256)

Returns

uint256

setMaxEscalationResponsePeriod

Sets the maximum escalation response period a dispute resolver can specify.
Emits a MaxEscalationResponsePeriodChanged event.
Reverts if _maxEscalationResponsePeriod is zero.Caller must have ADMIN role.

function setMaxEscalationResponsePeriod(uint256 _maxEscalationResponsePeriod) 
external

Arguments

Name	Type	Description
_maxEscalationResponsePeriod	uint256	the maximum escalation response period that a {BosonTypes.DisputeResolver} can specify

getMaxEscalationResponsePeriod

Gets the maximum escalation response period a dispute resolver can specify.

function getMaxEscalationResponsePeriod() 
external
view
returns(uint256)

Returns

uint256

setMaxTotalOfferFeePercentage

Sets the total offer fee percentage limit which will validate the sum of (Protocol Fee percentage + Agent Fee percentage) of an offer fee.
Emits a MaxTotalOfferFeePercentageChanged event.
Reverts if the _maxTotalOfferFeePercentage is greater than 10000.Caller must have ADMIN role.

function setMaxTotalOfferFeePercentage(uint16 _maxTotalOfferFeePercentage) 
external

Arguments

Name	Type	Description
_maxTotalOfferFeePercentage	uint16	the maximum total offer fee percentage N.B. Represent percentage value as an unsigned int by multiplying the percentage by 100: e.g, 1.75% = 175, 100% = 10000

getMaxTotalOfferFeePercentage

Gets the total offer fee percentage limit which will validate the sum of (Protocol Fee percentage + Agent Fee percentage) of an offer fee.

function getMaxTotalOfferFeePercentage() 
external
view
returns(uint16)

Returns

uint16

setBuyerEscalationDepositPercentage

Sets the buyer escalation fee percentage.
Emits a BuyerEscalationFeePercentageChanged event.
Reverts if the _buyerEscalationDepositPercentage is greater than 10000.Caller must have ADMIN role.

function setBuyerEscalationDepositPercentage(uint256 _buyerEscalationDepositPercentage) 
external

Arguments

Name	Type	Description
_buyerEscalationDepositPercentage	uint256	the percentage of the DR fee that will be charged to buyer if they want to escalate the dispute N.B. Represent percentage value as an unsigned int by multiplying the percentage by 100: e.g, 1.75% = 175, 100% = 10000

getBuyerEscalationDepositPercentage

Gets the buyer escalation fee percentage.

function getBuyerEscalationDepositPercentage() 
external
view
returns(uint256)

Returns

uint256

setAuthTokenContract

Sets the contract address for the given AuthTokenType.
Emits an AuthTokenContractChanged event.
Reverts if _authTokenType is None
Reverts if _authTokenType is Custom
Reverts if _authTokenContract is the zero addressCaller must have ADMIN role.

function setAuthTokenContract(enum BosonTypes.AuthTokenType _authTokenType,
 address _authTokenContract) 
external

Arguments

Name	Type	Description
_authTokenType	enum BosonTypes.AuthTokenType	the auth token type, as an Enum value
_authTokenContract	address	the address of the auth token contract (e.g. Lens or ENS contract address)

getAuthTokenContract

Gets the contract address for the given AuthTokenType.

function getAuthTokenContract(enum BosonTypes.AuthTokenType _authTokenType) 
external
view
returns(address)

Arguments

Name	Type	Description
_authTokenType	enum BosonTypes.AuthTokenType	the auth token type, as an Enum value

Returns

address

setMaxRoyaltyPecentage

Sets the maximum royalty percentage that can be set by the seller.
Emits a MaxRoyaltyPercentageChanged event.
Reverts if:
- The _maxRoyaltyPercentage is zero.
- The _maxRoyaltyPecentage is greater than 10000.Caller must have ADMIN role.

function setMaxRoyaltyPecentage(uint16 _maxRoyaltyPecentage) 
external

Arguments

Name	Type	Description
_maxRoyaltyPecentage	uint16	the maximum royalty percentage N.B. Represent percentage value as an unsigned int by multiplying the percentage by 100: e.g, 1.75% = 175, 100% = 10000

getMaxRoyaltyPecentage

Gets the maximum royalty percentage that can be set by the seller.

function getMaxRoyaltyPecentage() 
external
view
returns(uint16)

Returns

uint16

setMinResolutionPeriod

Sets the minimum resolution period a seller can specify.
Emits a MinResolutionPeriodChanged event.
Reverts if _minResolutionPeriod is zero.Caller must have ADMIN role.

function setMinResolutionPeriod(uint256 _minResolutionPeriod) 
external

Arguments

Name	Type	Description
_minResolutionPeriod	uint256	the minimum resolution period that a {BosonTypes.Seller} can specify

getMinResolutionPeriod

Gets the minimum resolution period a seller can specify.

function getMinResolutionPeriod() 
external
view
returns(uint256)

Returns

uint256

setMaxResolutionPeriod

Sets the maximum resolution period a seller can specify.
Emits a MaxResolutionPeriodChanged event.
Reverts if _maxResolutionPeriod is zero.Caller must have ADMIN role.

function setMaxResolutionPeriod(uint256 _maxResolutionPeriod) 
external

Arguments

Name	Type	Description
_maxResolutionPeriod	uint256	the maximum resolution period that a {BosonTypes.Seller} can specify

getMaxResolutionPeriod

Gets the maximum resolution period a seller can specify.

function getMaxResolutionPeriod() 
external
view
returns(uint256)

Returns

uint256

setMinDisputePeriod

Sets the minimum dispute period a seller can specify.
Emits a MinDisputePeriodChanged event.
Reverts if _minDisputePeriod is zero.

function setMinDisputePeriod(uint256 _minDisputePeriod) 
external

Arguments

Name	Type	Description
_minDisputePeriod	uint256	the minimum dispute period that a {BosonTypes.Seller} can specify

getMinDisputePeriod

Gets the minimum dispute period a seller can specify.

function getMinDisputePeriod() 
external
view
returns(uint256)

Returns

uint256

setAccessControllerAddress

Sets the access controller address.
Emits an AccessControllerAddressChanged event.
Reverts if _accessControllerAddress is the zero addressCaller must have ADMIN role.

function setAccessControllerAddress(address _accessControllerAddress) 
external

Arguments

Name	Type	Description
_accessControllerAddress	address	access controller address

getAccessControllerAddress

Gets the access controller address.

function getAccessControllerAddress() 
external
view
returns(address)

Returns

address