Skip to main content

IBosonConfigHandler

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

↗ Extends: IBosonConfigEvents ↘ Derived Contracts: ConfigHandlerFacet

IBosonConfigHandler

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

Functions

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

NameTypeDescription
_tokenAddressaddress payablethe Boson Token (ERC-20 contract) address

getTokenAddress

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

function getTokenAddress() 
external
view
returns(address payable)

Returns

NameTypeDescription
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

NameTypeDescription
_treasuryAddressaddress payablethe the multi-sig wallet address

getTreasuryAddress

Gets the Boson Protocol multi-sig wallet address.

function getTreasuryAddress() 
external
view
returns(address payable)

Returns

NameTypeDescription
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

NameTypeDescription
_voucherBeaconAddressaddressthe 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

NameTypeDescription
_beaconProxyAddressaddressreference 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

NameTypeDescription
_protocolFeePercentageuint256the 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

NameTypeDescription
_protocolFeeFlatBosonuint256the 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

setMaxOffersPerBatch

Sets the maximum numbers of offers that can be created in a single transaction.
Emits a MaxOffersPerBatchChanged event.
Reverts if _maxOffersPerBatch is zero.Caller must have ADMIN role.

function setMaxOffersPerBatch(uint16 _maxOffersPerBatch) 
external

Arguments

NameTypeDescription
_maxOffersPerBatchuint16the maximum length of {BosonTypes.Offer[]}

getMaxOffersPerBatch

Gets the maximum numbers of offers that can be created in a single transaction.

function getMaxOffersPerBatch() 
external
view
returns(uint16)

Returns

uint16

setMaxOffersPerGroup

Sets the maximum numbers of offers that can be added to a group in a single transaction.
Emits a MaxOffersPerGroupChanged event.
Reverts if _maxOffersPerGroup is zero.Caller must have ADMIN role.

function setMaxOffersPerGroup(uint16 _maxOffersPerGroup) 
external

Arguments

NameTypeDescription
_maxOffersPerGroupuint16the maximum length of {BosonTypes.Group.offerIds}

getMaxOffersPerGroup

Gets the maximum numbers of offers that can be added to a group in a single transaction.

function getMaxOffersPerGroup() 
external
view
returns(uint16)

Returns

uint16

setMaxTwinsPerBundle

Sets the maximum numbers of twins that can be added to a bundle in a single transaction.
Emits a MaxTwinsPerBundleChanged event.
Reverts if _maxTwinsPerBundle is zero.Caller must have ADMIN role.

function setMaxTwinsPerBundle(uint16 _maxTwinsPerBundle) 
external

Arguments

NameTypeDescription
_maxTwinsPerBundleuint16the maximum length of {BosonTypes.Bundle.twinIds}

getMaxTwinsPerBundle

Gets the maximum numbers of twins that can be added to a bundle in a single transaction.

function getMaxTwinsPerBundle() 
external
view
returns(uint16)

Returns

uint16

setMaxOffersPerBundle

Sets the maximum numbers of offers that can be added to a bundle in a single transaction.
Emits a MaxOffersPerBundleChanged event.
Reverts if _maxOffersPerBundle is zero.Caller must have ADMIN role.

function setMaxOffersPerBundle(uint16 _maxOffersPerBundle) 
external

Arguments

NameTypeDescription
_maxOffersPerBundleuint16the maximum length of {BosonTypes.Bundle.offerIds}

getMaxOffersPerBundle

Gets the maximum numbers of offers that can be added to a bundle in a single transaction.

function getMaxOffersPerBundle() 
external
view
returns(uint16)

Returns

uint16

setMaxTokensPerWithdrawal

Sets the maximum numbers of tokens that can be withdrawn in a single transaction.
Emits a MaxTokensPerWithdrawalChanged event.
Reverts if _maxTokensPerWithdrawal is zero.Caller must have ADMIN role.

function setMaxTokensPerWithdrawal(uint16 _maxTokensPerWithdrawal) 
external

Arguments

NameTypeDescription
_maxTokensPerWithdrawaluint16the maximum length of token list when calling {FundsHandlerFacet.withdraw}

getMaxTokensPerWithdrawal

Gets the maximum numbers of tokens that can be withdrawn in a single transaction.

function getMaxTokensPerWithdrawal() 
external
view
returns(uint16)

Returns

uint16

setMaxFeesPerDisputeResolver

Sets the maximum number of dispute resolver fee structs that can be processed in a single transaction.
Emits a MaxFeesPerDisputeResolverChanged event.
Reverts if _maxFeesPerDisputeResolver is zero.Caller must have ADMIN role.

function setMaxFeesPerDisputeResolver(uint16 _maxFeesPerDisputeResolver) 
external

Arguments

NameTypeDescription
_maxFeesPerDisputeResolveruint16the maximum length of dispute resolver fees list when calling {AccountHandlerFacet.createDisputeResolver} or {AccountHandlerFacet.updateDisputeResolver}

getMaxFeesPerDisputeResolver

Gets the maximum number of dispute resolver fee structs that can be processed in a single transaction.

function getMaxFeesPerDisputeResolver() 
external
view
returns(uint16)

Returns

uint16

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

NameTypeDescription
_maxEscalationResponsePerioduint256the 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

setMaxDisputesPerBatch

Sets the maximum number of disputes that can be expired in a single transaction.
Emits a MaxDisputesPerBatchChanged event.
Reverts if _maxDisputesPerBatch is zero.Caller must have ADMIN role.

function setMaxDisputesPerBatch(uint16 _maxDisputesPerBatch) 
external

Arguments

NameTypeDescription
_maxDisputesPerBatchuint16the maximum number of disputes that can be expired

getMaxDisputesPerBatch

Gets the maximum number of disputes that can be expired in a single transaction.

function getMaxDisputesPerBatch() 
external
view
returns(uint16)

Returns

uint16

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

NameTypeDescription
_maxTotalOfferFeePercentageuint16the 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

setMaxAllowedSellers

Sets the maximum number of seller ids that can be added to or removed from dispute resolver seller allow list in a single transaction.
Emits a MaxAllowedSellersChanged event.
Reverts if _maxAllowedSellers is zero.Caller must have ADMIN role.

function setMaxAllowedSellers(uint16 _maxAllowedSellers) 
external

Arguments

NameTypeDescription
_maxAllowedSellersuint16the maximum number of seller ids that can be added or removed

getMaxAllowedSellers

Gets the maximum number of seller ids that can be added to or removed from dispute resolver seller allow list in a single transaction.

function getMaxAllowedSellers() 
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

NameTypeDescription
_buyerEscalationDepositPercentageuint256the 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

NameTypeDescription
_authTokenTypeenum BosonTypes.AuthTokenTypethe auth token type, as an Enum value
_authTokenContractaddressthe 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

NameTypeDescription
_authTokenTypeenum BosonTypes.AuthTokenTypethe auth token type, as an Enum value

Returns

address

setMaxExchangesPerBatch

Sets the maximum number of exchanges that can be created in a single transaction.
Emits a MaxExchangesPerBatchChanged event.
Reverts if _maxExchangesPerBatch is zero.Caller must have ADMIN role.

function setMaxExchangesPerBatch(uint16 _maxExchangesPerBatch) 
external

Arguments

NameTypeDescription
_maxExchangesPerBatchuint16the maximum length of {BosonTypes.Exchange[]}

getMaxExchangesPerBatch

Gets the maximum number of exchanges that can be created in a single transaction.

function getMaxExchangesPerBatch() 
external
view
returns(uint16)

Returns

uint16

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

NameTypeDescription
_maxRoyaltyPecentageuint16the 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

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

NameTypeDescription
_maxResolutionPerioduint256the 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

NameTypeDescription
_minDisputePerioduint256the 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

NameTypeDescription
_accessControllerAddressaddressaccess controller address

getAccessControllerAddress

Gets the access controller address.

function getAccessControllerAddress() 
external
view
returns(address)

Returns

address