Atomically creates a private offer and commits a specific buyer in one transaction. Prerequisite: call sign_full_offer, sign the returned typed data locally with your wallet (EIP-712), and provide the signature here. Used for private/bilateral trades. Returns unsigned transaction data.
View input schema
{
"type": "object",
"properties": {
"executionMode": {
"type": "string",
"enum": [
"direct",
"metaTx"
],
"description": "'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defaults to 'direct'."
},
"signature": {
"type": "string",
"description": "ECDSA signature over the offer typed data. Workflow: sign_full_offer → sign the returned typed data locally with your wallet (EIP-712) → use result here."
},
"offerCreator": {
"type": "string",
"description": "Ethereum address of the seller creating this non-listed offer. Must match the seller's assistant address."
},
"committer": {
"$ref": "#/properties/offerCreator",
"description": "Ethereum address of the buyer committing in the same transaction."
},
"collectionIndex": {
"type": "string",
"description": "Index of the seller's NFT collection for vouchers. Omit to use default (index 0)."
},
"royaltyInfo": {
"type": "object",
"properties": {
"recipients": {
"type": "array",
"items": {
"$ref": "#/properties/offerCreator",
"description": "Valid Ethereum address (e.g. '0xAbCd...' or '0xabcd...'). Mixed-case addresses are checksum-validated; all-lowercase and all-uppercase addresses are also accepted."
},
"minItems": 0,
"description": "Array of addresses receiving resale royalties."
},
"bps": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 0,
"description": "Royalty amounts per recipient in basis points (1 bp = 0.01%). Parallel to recipients. Total must not exceed 10000."
}
},
"required": [
"recipients",
"bps"
],
"additionalProperties": false
},
"drMutualizerAddress": {
"$ref": "#/properties/royaltyInfo/properties/recipients/items",
"description": "Optional dispute resolver mutualizer contract address that pools resolution funds."
},
"conditionalTokenId": {
"$ref": "#/properties/collectionIndex",
"description": "Optional token ID of the NFT gate token used by this specific commit (for SpecificToken gating type)."
},
"condition": {
"type": "object",
"properties": {
"method": {
"type": "number",
"description": "Gating method: 0=None, 1=Threshold (hold >= threshold tokens), 2=SpecificToken (hold specific token ID)."
},
"tokenType": {
"type": "number",
"description": "Token standard: 0=ERC-20, 1=ERC-721, 2=ERC-1155."
},
"tokenAddress": {
"$ref": "#/properties/offerCreator",
"description": "Address of the gate token contract buyers must hold."
},
"gatingType": {
"type": "number",
"description": "0=PerAddress (each address commits once), 1=PerTokenId (each token ID can be used once)."
},
"minTokenId": {
"$ref": "#/properties/collectionIndex",
"description": "Min token ID (inclusive) for ERC-721/1155 criteria. Pass as string."
},
"maxTokenId": {
"$ref": "#/properties/collectionIndex",
"description": "Max token ID (inclusive) for ERC-721/1155 criteria. Pass as string."
},
"threshold": {
"$ref": "#/properties/collectionIndex",
"description": "Minimum token balance required. Pass as string."
},
"maxCommits": {
"$ref": "#/properties/collectionIndex",
"description": "Max commits per qualifying address or token ID. Pass as string."
}
},
"required": [
"method",
"tokenType",
"tokenAddress",
"gatingType",
"minTokenId",
"maxTokenId",
"threshold",
"maxCommits"
],
"additionalProperties": false
},
"useDepositedFunds": {
"type": "boolean",
"description": "If true, use funds already deposited in the protocol treasury instead of transferring from the wallet."
},
"sellerId": {
"$ref": "#/properties/collectionIndex",
"description": "Numeric ID of the seller entity. Obtain via get_sellers_by_address."
},
"buyerId": {
"$ref": "#/properties/collectionIndex",
"description": "Numeric ID of the buyer entity. Use '0' for seller-initiated offers."
},
"metadataUri": {
"type": "string",
"description": "IPFS URI pointing to the offer metadata JSON. Obtain by calling store_product_v1_metadata, store_bundle_metadata, or store_base_metadata."
},
"metadataHash": {
"type": "string",
"description": "Keccak256 hash of the metadata JSON. Returned alongside metadataUri from the store_*_metadata tools."
},
"exchangeTokenAddress": {
"$ref": "#/properties/royaltyInfo/properties/recipients/items",
"description": "ERC-20 token accepted for payment. Omit or use address(0) for native ETH. Call get_supported_tokens for valid values."
},
"price": {
"$ref": "#/properties/collectionIndex",
"description": "Offer price in the exchange token's smallest unit (wei). Pass as string to avoid precision loss, e.g. '1000000000000000000' = 1 ETH."
},
"sellerDeposit": {
"$ref": "#/properties/collectionIndex",
"description": "Seller collateral in same unit as price. Released to seller on completion or forfeited on dispute. Pass as string."
},
"agentId": {
"$ref": "#/properties/collectionIndex",
"description": "Optional dACP agent facilitating this offer. Omit or pass '0' if no agent."
},
"buyerCancellationPenalty": {
"$ref": "#/properties/collectionIndex",
"description": "Amount buyer forfeits on cancel, in same unit as price. Must be <= price. Pass as string."
},
"quantityAvailable": {
"type": "number",
"exclusiveMinimum": 0,
"description": "How many times this offer can be committed to. Must be 1 when creator='BUYER'."
},
"validFromDateInMS": {
"type": "number",
"description": "Unix timestamp in milliseconds when the offer becomes active. Example: Date.now() for immediate."
},
"validUntilDateInMS": {
"type": "number",
"description": "Unix timestamp in milliseconds when the offer can no longer be committed to."
},
"voucherRedeemableFromDateInMS": {
"type": "number",
"description": "Timestamp in ms from which buyer can redeem. Must be >= validFromDateInMS."
},
"voucherRedeemableUntilDateInMS": {
"type": "number",
"description": "Timestamp in ms after which voucher cannot be redeemed. Set to 0 to use voucherValidDurationInMS instead."
},
"disputePeriodDurationInMS": {
"type": "number",
"description": "Duration in ms for buyer to raise a dispute after redeeming. Example: 604800000 = 7 days."
},
"voucherValidDurationInMS": {
"type": "number",
"description": "Voucher is redeemable for this many ms after commit. Set to 0 to use voucherRedeemableUntilDateInMS instead."
},
"resolutionPeriodDurationInMS": {
"type": "number",
"description": "Duration in ms to respond to a resolution proposal before it expires. Example: 259200000 = 3 days."
},
"disputeResolverId": {
"type": "string",
"description": "ID of the dispute resolver for escalated disputes. Call get_dispute_resolvers to list available resolvers."
},
"feeLimit": {
"$ref": "#/properties/collectionIndex",
"description": "Max protocol fee the seller accepts in same token unit. Pass as string."
},
"priceType": {
"type": "number",
"description": "0 = static price, 1 = discovery price (auction)."
},
"creator": {
"type": "string",
"enum": [
"SELLER",
"BUYER"
],
"description": "'SELLER' (default) = seller creates offer. 'BUYER' = buyer-initiated offer, quantity must be 1."
},
"configId": {
"type": "string",
"description": "Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Call get_config_ids to list all valid values for this server."
},
"signerAddress": {
"$ref": "#/properties/offerCreator",
"description": "Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally."
}
},
"required": [
"signature",
"offerCreator",
"committer",
"sellerId",
"buyerId",
"metadataUri",
"metadataHash",
"price",
"sellerDeposit",
"buyerCancellationPenalty",
"quantityAvailable",
"validFromDateInMS",
"validUntilDateInMS",
"voucherRedeemableFromDateInMS",
"voucherRedeemableUntilDateInMS",
"disputePeriodDurationInMS",
"voucherValidDurationInMS",
"resolutionPeriodDurationInMS",
"configId",
"signerAddress"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}