Structs
These structs surface in the function inputs and outputs of the Diamond's facets. Names match the on-chain Solidity declarations. Nested structs reference each other by short name.
BosonTypes (31)
Agent
| Field | Type |
|---|---|
id | uint256 |
feePercentage | uint256 |
wallet | address |
active | bool |
AuthToken
| Field | Type |
|---|---|
tokenId | uint256 |
tokenType | AuthTokenType (enum) |
Bundle
| Field | Type |
|---|---|
id | uint256 |
sellerId | uint256 |
offerIds | uint256[] |
twinIds | uint256[] |
Buyer
| Field | Type |
|---|---|
id | uint256 |
wallet | address |
active | bool |
Collection
| Field | Type |
|---|---|
collectionAddress | address |
externalId | string |
Condition
| Field | Type |
|---|---|
method | EvaluationMethod (enum) |
tokenType | TokenType (enum) |
tokenAddress | address |
gating | GatingType (enum) |
minTokenId | uint256 |
threshold | uint256 |
maxCommits | uint256 |
maxTokenId | uint256 |
Dispute
| Field | Type |
|---|---|
exchangeId | uint256 |
buyerPercent | uint256 |
state | DisputeState (enum) |
DisputeDates
| Field | Type |
|---|---|
disputed | uint256 |
escalated | uint256 |
finalized | uint256 |
timeout | uint256 |
DisputeResolutionTerms
| Field | Type |
|---|---|
disputeResolverId | uint256 |
escalationResponsePeriod | uint256 |
feeAmount | uint256 |
buyerEscalationDeposit | uint256 |
mutualizerAddress | address |
DisputeResolver
| Field | Type |
|---|---|
id | uint256 |
escalationResponsePeriod | uint256 |
assistant | address |
admin | address |
clerk | address |
treasury | address |
metadataUri | string |
active | bool |
DisputeResolverFee
| Field | Type |
|---|---|
tokenAddress | address |
tokenName | string |
feeAmount | uint256 |
DRParameters
| Field | Type |
|---|---|
disputeResolverId | uint256 |
mutualizerAddress | address |
Exchange
| Field | Type |
|---|---|
id | uint256 |
offerId | uint256 |
buyerId | uint256 |
finalizedDate | uint256 |
state | ExchangeState (enum) |
mutualizerAddress | address |
FullOffer
| Field | Type |
|---|---|
offer | Offer |
offerDates | OfferDates |
offerDurations | OfferDurations |
drParameters | DRParameters |
condition | Condition |
agentId | uint256 |
feeLimit | uint256 |
useDepositedFunds | bool |
Funds
| Field | Type |
|---|---|
tokenAddress | address |
tokenName | string |
availableAmount | uint256 |
Group
| Field | Type |
|---|---|
id | uint256 |
sellerId | uint256 |
offerIds | uint256[] |
Offer
| Field | Type |
|---|---|
id | uint256 |
sellerId | uint256 |
price | uint256 |
sellerDeposit | uint256 |
buyerCancelPenalty | uint256 |
quantityAvailable | uint256 |
exchangeToken | address |
priceType | PriceType (enum) |
creator | OfferCreator (enum) |
metadataUri | string |
metadataHash | string |
voided | bool |
collectionIndex | uint256 |
royaltyInfo | RoyaltyInfo[] |
buyerId | uint256 |
OfferDates
| Field | Type |
|---|---|
validFrom | uint256 |
validUntil | uint256 |
voucherRedeemableFrom | uint256 |
voucherRedeemableUntil | uint256 |
OfferDurations
| Field | Type |
|---|---|
disputePeriod | uint256 |
voucherValid | uint256 |
resolutionPeriod | uint256 |
OfferFees
| Field | Type |
|---|---|
protocolFee | uint256 |
agentFee | uint256 |
PremintParameters
| Field | Type |
|---|---|
reservedRangeLength | uint256 |
to | address |
PriceDiscovery
| Field | Type |
|---|---|
price | uint256 |
side | Side (enum) |
priceDiscoveryContract | address |
conduit | address |
priceDiscoveryData | bytes |
Receipt
| Field | Type |
|---|---|
exchangeId | uint256 |
offerId | uint256 |
buyerId | uint256 |
sellerId | uint256 |
price | uint256 |
sellerDeposit | uint256 |
buyerCancelPenalty | uint256 |
offerFees | OfferFees |
agentId | uint256 |
exchangeToken | address |
finalizedDate | uint256 |
condition | Condition |
committedDate | uint256 |
redeemedDate | uint256 |
voucherExpired | bool |
disputeResolverId | uint256 |
disputedDate | uint256 |
escalatedDate | uint256 |
disputeState | DisputeState (enum) |
twinReceipts | TwinReceipt[] |
RoyaltyInfo
| Field | Type |
|---|---|
recipients | address[] |
bps | uint256[] |
RoyaltyRecipientInfo
| Field | Type |
|---|---|
wallet | address |
minRoyaltyPercentage | uint256 |
Seller
| Field | Type |
|---|---|
id | uint256 |
assistant | address |
admin | address |
clerk | address |
treasury | address |
active | bool |
metadataUri | string |
SellerOfferParams
| Field | Type |
|---|---|
collectionIndex | uint256 |
royaltyInfo | RoyaltyInfo |
mutualizerAddress | address |
Twin
| Field | Type |
|---|---|
id | uint256 |
sellerId | uint256 |
amount | uint256 |
supplyAvailable | uint256 |
tokenId | uint256 |
tokenAddress | address |
tokenType | TokenType (enum) |
TwinReceipt
| Field | Type |
|---|---|
twinId | uint256 |
tokenId | uint256 |
amount | uint256 |
tokenAddress | address |
tokenType | TokenType (enum) |
Voucher
| Field | Type |
|---|---|
committedDate | uint256 |
validUntilDate | uint256 |
redeemedDate | uint256 |
expired | bool |
VoucherInitValues
| Field | Type |
|---|---|
contractURI | string |
royaltyPercentage | uint256 |
collectionSalt | bytes32 |
Source
- ABI artifacts:
boson-protocol-contracts/addresses/abis/ - Solidity origin (for full NatSpec, enum values, etc.):
contracts/domain/BosonTypes.sol
Related
- Reference → Contracts → Diamond facets — which facet takes / returns each struct.
- Concepts → The Boson model.