MCP server for Boson Protocol — on-chain agentic commerce for physical & digital goods.
Inferred from the transports this listing declares (streamable-http). A client not listed here hasn’t been ruled out — it just isn’t something Forge can confirm.
Verification confirms publisher identity (repo ownership), not code safety. The security scan covers known CVEs and suspicious install scripts.
Read from a real MCP initialize → tools/list handshake against the declared endpoint. No tool was ever invoked — tools/list is the read-only introspection call the protocol defines for this. It reflects what the server advertised at that moment; a hosted endpoint is not pinned to any version and can change without notice.
https://mcp.bosonprotocol.io/mcp63 tools · 996msget_config_idsReturns all valid configId values for this server. Call first to discover which network/deployment to use. No auth required.Returns all valid configId values for this server. Call first to discover which network/deployment to use. No auth required.
No input schema was published for this tool.
get_fundsReads treasury fund balances for sellers and buyers from the Boson subgraph. Supports pagination/ordering/filtering. Read-only — signerAddress not required. Returns: array of { tokenAddress, availableAmount, accountId }.Reads treasury fund balances for sellers and buyers from the Boson subgraph. Supports pagination/ordering/filtering. Read-only — signerAddress not required. Returns: array of { tokenAddress, availableAmount, accountId }.
| Parameter | Type | Description |
|---|---|---|
| fundsSkip | number | — |
| fundsFirst | number | — |
| fundsOrderBy | string | — |
| fundsOrderDirection | string | — |
| fundsFilter | object | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
get_disputesReads dispute records from the Boson subgraph. Supports pagination, ordering, and filtering by buyer/seller/state. Read-only. Returns: array of dispute entities with exchangeId, state, timeout.Reads dispute records from the Boson subgraph. Supports pagination, ordering, and filtering by buyer/seller/state. Read-only. Returns: array of dispute entities with exchangeId, state, timeout.
| Parameter | Type | Description |
|---|---|---|
| disputesSkip | number | — |
| disputesFirst | number | — |
| disputesOrderBy | string | — |
| disputesOrderDirection | string | — |
| disputesFilter | object | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
get_dispute_by_idReads a single dispute by its ID (equals the exchangeId). Read-only. Returns: dispute entity with state, timeout, buyerPercent. Use get_disputes to search first.Reads a single dispute by its ID (equals the exchangeId). Read-only. Returns: dispute entity with state, timeout, buyerPercent. Use get_disputes to search first.
| Parameter | Type | Description |
|---|---|---|
| disputeId* | string | Numeric ID of the dispute to retrieve. Note: disputeId equals the exchangeId of the associated exchange. |
| queryVars | — | Optional additional subgraph query variables for field selection. Leave empty for default fields. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
get_exchangesReads exchange records (offer commitments) from the Boson subgraph. Filter by buyer/seller/state. Read-only. Returns: array of exchanges with offerId, state (Committed/Redeemed/Completed/Disputed/Cancelled/Revoked), and voucher details.Reads exchange records (offer commitments) from the Boson subgraph. Filter by buyer/seller/state. Read-only. Returns: array of exchanges with offerId, state (Committed/Redeemed/Completed/Disputed/Cancelled/Revoked), and voucher details.
| Parameter | Type | Description |
|---|---|---|
| exchangesSkip | number | — |
| exchangesFirst | number | — |
| exchangesOrderBy | string | — |
| exchangesOrderDirection | string | — |
| exchangesFilter | object | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
get_offersReads offer listings from the Boson subgraph. Supports pagination, ordering, and filtering (e.g. by sellerId). Read-only. Returns: array of offers with price, deposit, dates, and quantity.Reads offer listings from the Boson subgraph. Supports pagination, ordering, and filtering (e.g. by sellerId). Read-only. Returns: array of offers with price, deposit, dates, and quantity.
| Parameter | Type | Description |
|---|---|---|
| offersSkip | number | — |
| offersFirst | number | — |
| offersOrderBy | string | — |
| offersOrderDirection | string | — |
| offersFilter | object | — |
| includeExchanges | boolean | — |
| exchangesSkip | number | — |
| exchangesFirst | number | — |
| exchangesOrderBy | string | — |
| exchangesOrderDirection | string | — |
| exchangesFilter | object | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
get_sellersReads seller account entities from the Boson subgraph. Optionally includes related offers, exchanges, funds, and logs. Read-only. Returns: array of seller entities with addresses and metadataUri.Reads seller account entities from the Boson subgraph. Optionally includes related offers, exchanges, funds, and logs. Read-only. Returns: array of seller entities with addresses and metadataUri.
| Parameter | Type | Description |
|---|---|---|
| sellersSkip | number | — |
| sellersFirst | number | — |
| sellersOrderBy | string | — |
| sellersOrderDirection | string | — |
| sellersFilter | object | — |
| includeExchanges | boolean | — |
| includeOffers | boolean | — |
| includeFunds | boolean | — |
| includeLogs | boolean | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
get_dispute_resolversReads registered dispute resolver entities. Use this to find a valid disputeResolverId for create_offer. Read-only. Returns: array of resolvers with ID, fees, escalationResponsePeriod, and supported tokens.Reads registered dispute resolver entities. Use this to find a valid disputeResolverId for create_offer. Read-only. Returns: array of resolvers with ID, fees, escalationResponsePeriod, and supported tokens.
| Parameter | Type | Description |
|---|---|---|
| disputeResolversSkip | number | — |
| disputeResolversFirst | number | — |
| disputeResolversOrderBy | string | — |
| disputeResolversOrderDirection | string | — |
| disputeResolversFilter | object | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
create_offerCreates a product offer. Caller must have a seller account (create_seller first). Prerequisite: store metadata first with store_product_v1_metadata or store_base_metadata to get metadataUri/metadataHash. All dates in milliseconds; amounts as strings in wei. Returns unsigned tx — sign locally with y…Creates a product offer. Caller must have a seller account (create_seller first). Prerequisite: store metadata first with store_product_v1_metadata or store_base_metadata to get metadataUri/metadataHash. All dates in milliseconds; amounts as strings in wei. Returns unsigned tx — sign locally with y…
| Parameter | Type | Description |
|---|---|---|
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
| metadataUri* | string | IPFS URI pointing to the offer metadata JSON. Obtain by calling store_product_v1_metadata, store_bundle_metadata, or store_base_metadata. |
| metadataHash* | string | Keccak256 hash of the metadata JSON. Returned alongside metadataUri from the store_*_metadata tools. |
| exchangeTokenAddress | string | ERC-20 token accepted for payment. Omit or use address(0) for native ETH. Call get_supported_tokens for valid values. |
| price* | string | Offer price in the exchange token's smallest unit (wei). Pass as string to avoid precision loss, e.g. '1000000000000000000' = 1 ETH. |
| sellerDeposit* | — | Seller collateral in same unit as price. Released to seller on completion or forfeited on dispute. Pass as string. |
| agentId | — | Optional dACP agent facilitating this offer. Omit or pass '0' if no agent. |
| buyerCancellationPenalty* | — | Amount buyer forfeits on cancel, in same unit as price. Must be <= price. Pass as string. |
| quantityAvailable* | number | How many times this offer can be committed to. Must be 1 when creator='BUYER'. |
| validFromDateInMS* | number | Unix timestamp in milliseconds when the offer becomes active. Example: Date.now() for immediate. |
| validUntilDateInMS* | number | Unix timestamp in milliseconds when the offer can no longer be committed to. |
| voucherRedeemableFromDateInMS* | number | Timestamp in ms from which buyer can redeem. Must be >= validFromDateInMS. |
| voucherRedeemableUntilDateInMS* | number | Timestamp in ms after which voucher cannot be redeemed. Set to 0 to use voucherValidDurationInMS instead. |
| disputePeriodDurationInMS* | number | Duration in ms for buyer to raise a dispute after redeeming. Example: 604800000 = 7 days. |
| voucherValidDurationInMS* | number | Voucher is redeemable for this many ms after commit. Set to 0 to use voucherRedeemableUntilDateInMS instead. |
| resolutionPeriodDurationInMS* | number | Duration in ms to respond to a resolution proposal before it expires. Example: 259200000 = 3 days. |
| disputeResolverId | string | ID of the dispute resolver for escalated disputes. Call get_dispute_resolvers to list available resolvers. |
| collectionIndex | — | Index of the seller's NFT collection for vouchers. Omit to use default (index 0). |
| feeLimit | — | Max protocol fee the seller accepts in same token unit. Pass as string. |
| priceType | number | 0 = static price, 1 = discovery price (auction). |
| royaltyInfo | object | — |
| creator | string | 'SELLER' (default) = seller creates offer. 'BUYER' = buyer-initiated offer, quantity must be 1. |
| drMutualizerAddress | — | Optional dispute resolver mutualizer contract address that pools resolution funds. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
create_offer_with_conditionCreates an offer gated by token-ownership (e.g. hold an ERC-721 to commit). Same prerequisites as create_offer plus a condition object specifying the gate token, method, and threshold. Returns unsigned transaction data.Creates an offer gated by token-ownership (e.g. hold an ERC-721 to commit). Same prerequisites as create_offer plus a condition object specifying the gate token, method, and threshold. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| condition* | object | — |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
| metadataUri* | string | IPFS URI pointing to the offer metadata JSON. Obtain by calling store_product_v1_metadata, store_bundle_metadata, or store_base_metadata. |
| metadataHash* | string | Keccak256 hash of the metadata JSON. Returned alongside metadataUri from the store_*_metadata tools. |
| exchangeTokenAddress | — | ERC-20 token accepted for payment. Omit or use address(0) for native ETH. Call get_supported_tokens for valid values. |
| price* | — | Offer price in the exchange token's smallest unit (wei). Pass as string to avoid precision loss, e.g. '1000000000000000000' = 1 ETH. |
| sellerDeposit* | — | Seller collateral in same unit as price. Released to seller on completion or forfeited on dispute. Pass as string. |
| agentId | — | Optional dACP agent facilitating this offer. Omit or pass '0' if no agent. |
| buyerCancellationPenalty* | — | Amount buyer forfeits on cancel, in same unit as price. Must be <= price. Pass as string. |
| quantityAvailable* | number | How many times this offer can be committed to. Must be 1 when creator='BUYER'. |
| validFromDateInMS* | number | Unix timestamp in milliseconds when the offer becomes active. Example: Date.now() for immediate. |
| validUntilDateInMS* | number | Unix timestamp in milliseconds when the offer can no longer be committed to. |
| voucherRedeemableFromDateInMS* | number | Timestamp in ms from which buyer can redeem. Must be >= validFromDateInMS. |
| voucherRedeemableUntilDateInMS* | number | Timestamp in ms after which voucher cannot be redeemed. Set to 0 to use voucherValidDurationInMS instead. |
| disputePeriodDurationInMS* | number | Duration in ms for buyer to raise a dispute after redeeming. Example: 604800000 = 7 days. |
| voucherValidDurationInMS* | number | Voucher is redeemable for this many ms after commit. Set to 0 to use voucherRedeemableUntilDateInMS instead. |
| resolutionPeriodDurationInMS* | number | Duration in ms to respond to a resolution proposal before it expires. Example: 259200000 = 3 days. |
| disputeResolverId | string | ID of the dispute resolver for escalated disputes. Call get_dispute_resolvers to list available resolvers. |
| collectionIndex | — | Index of the seller's NFT collection for vouchers. Omit to use default (index 0). |
| feeLimit | — | Max protocol fee the seller accepts in same token unit. Pass as string. |
| priceType | number | 0 = static price, 1 = discovery price (auction). |
| royaltyInfo | object | — |
| creator | string | 'SELLER' (default) = seller creates offer. 'BUYER' = buyer-initiated offer, quantity must be 1. |
| drMutualizerAddress | — | Optional dispute resolver mutualizer contract address that pools resolution funds. |
create_buyerCreates a buyer account for signerAddress. Required before a buyer can commit to seller-initiated offers for the first time. No prerequisites. Returns unsigned transaction data.Creates a buyer account for signerAddress. Required before a buyer can commit to seller-initiated offers for the first time. No prerequisites. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
sign_full_offerGenerates EIP-712 typed data for a non-listed (private) offer that the offer creator must sign. Call before create_offer_and_commit or void_non_listed_offer. Returns: typed data structure — sign it locally with your wallet (EIP-712), then use the signature in the next step.Generates EIP-712 typed data for a non-listed (private) offer that the offer creator must sign. Call before create_offer_and_commit or void_non_listed_offer. Returns: typed data structure — sign it locally with your wallet (EIP-712), then use the signature in the next step.
| Parameter | Type | Description |
|---|---|---|
| offerCreator* | string | Ethereum address of the seller creating this non-listed offer. Must match the seller's assistant address. |
| committer* | — | Ethereum address of the buyer committing in the same transaction. |
| collectionIndex | string | Index of the seller's NFT collection for vouchers. Omit to use default (index 0). |
| royaltyInfo | object | — |
| drMutualizerAddress | — | Optional dispute resolver mutualizer contract address that pools resolution funds. |
| conditionalTokenId | — | Optional token ID of the NFT gate token used by this specific commit (for SpecificToken gating type). |
| condition | object | — |
| useDepositedFunds | boolean | If true, use funds already deposited in the protocol treasury instead of transferring from the wallet. |
| sellerId* | — | Numeric ID of the seller entity. Obtain via get_sellers_by_address. |
| buyerId* | — | Numeric ID of the buyer entity. Use '0' for seller-initiated offers. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
| metadataUri* | string | IPFS URI pointing to the offer metadata JSON. Obtain by calling store_product_v1_metadata, store_bundle_metadata, or store_base_metadata. |
| metadataHash* | string | Keccak256 hash of the metadata JSON. Returned alongside metadataUri from the store_*_metadata tools. |
| exchangeTokenAddress | — | ERC-20 token accepted for payment. Omit or use address(0) for native ETH. Call get_supported_tokens for valid values. |
| price* | — | Offer price in the exchange token's smallest unit (wei). Pass as string to avoid precision loss, e.g. '1000000000000000000' = 1 ETH. |
| sellerDeposit* | — | Seller collateral in same unit as price. Released to seller on completion or forfeited on dispute. Pass as string. |
| agentId | — | Optional dACP agent facilitating this offer. Omit or pass '0' if no agent. |
| buyerCancellationPenalty* | — | Amount buyer forfeits on cancel, in same unit as price. Must be <= price. Pass as string. |
| quantityAvailable* | number | How many times this offer can be committed to. Must be 1 when creator='BUYER'. |
| validFromDateInMS* | number | Unix timestamp in milliseconds when the offer becomes active. Example: Date.now() for immediate. |
| validUntilDateInMS* | number | Unix timestamp in milliseconds when the offer can no longer be committed to. |
| voucherRedeemableFromDateInMS* | number | Timestamp in ms from which buyer can redeem. Must be >= validFromDateInMS. |
| voucherRedeemableUntilDateInMS* | number | Timestamp in ms after which voucher cannot be redeemed. Set to 0 to use voucherValidDurationInMS instead. |
| disputePeriodDurationInMS* | number | Duration in ms for buyer to raise a dispute after redeeming. Example: 604800000 = 7 days. |
create_offer_and_commitAtomically 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.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.
| Parameter | Type | Description |
|---|---|---|
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
| signature* | string | 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* | string | Ethereum address of the seller creating this non-listed offer. Must match the seller's assistant address. |
| committer* | — | Ethereum address of the buyer committing in the same transaction. |
| collectionIndex | string | Index of the seller's NFT collection for vouchers. Omit to use default (index 0). |
| royaltyInfo | object | — |
| drMutualizerAddress | — | Optional dispute resolver mutualizer contract address that pools resolution funds. |
| conditionalTokenId | — | Optional token ID of the NFT gate token used by this specific commit (for SpecificToken gating type). |
| condition | object | — |
| useDepositedFunds | boolean | If true, use funds already deposited in the protocol treasury instead of transferring from the wallet. |
| sellerId* | — | Numeric ID of the seller entity. Obtain via get_sellers_by_address. |
| buyerId* | — | Numeric ID of the buyer entity. Use '0' for seller-initiated offers. |
| metadataUri* | string | IPFS URI pointing to the offer metadata JSON. Obtain by calling store_product_v1_metadata, store_bundle_metadata, or store_base_metadata. |
| metadataHash* | string | Keccak256 hash of the metadata JSON. Returned alongside metadataUri from the store_*_metadata tools. |
| exchangeTokenAddress | — | ERC-20 token accepted for payment. Omit or use address(0) for native ETH. Call get_supported_tokens for valid values. |
| price* | — | Offer price in the exchange token's smallest unit (wei). Pass as string to avoid precision loss, e.g. '1000000000000000000' = 1 ETH. |
| sellerDeposit* | — | Seller collateral in same unit as price. Released to seller on completion or forfeited on dispute. Pass as string. |
| agentId | — | Optional dACP agent facilitating this offer. Omit or pass '0' if no agent. |
| buyerCancellationPenalty* | — | Amount buyer forfeits on cancel, in same unit as price. Must be <= price. Pass as string. |
| quantityAvailable* | number | How many times this offer can be committed to. Must be 1 when creator='BUYER'. |
| validFromDateInMS* | number | Unix timestamp in milliseconds when the offer becomes active. Example: Date.now() for immediate. |
| validUntilDateInMS* | number | Unix timestamp in milliseconds when the offer can no longer be committed to. |
| voucherRedeemableFromDateInMS* | number | Timestamp in ms from which buyer can redeem. Must be >= validFromDateInMS. |
| voucherRedeemableUntilDateInMS* | number | Timestamp in ms after which voucher cannot be redeemed. Set to 0 to use voucherValidDurationInMS instead. |
create_offer_commit_and_redeemAtomically creates a private offer, commits a specific buyer, and immediately redeems the voucher in a single transaction via the OrchestrationHandler. Same prerequisites as create_offer_and_commit (sign_full_offer + EIP-712 signature). Use for instant-fulfilment private trades. Returns unsigned tr…Atomically creates a private offer, commits a specific buyer, and immediately redeems the voucher in a single transaction via the OrchestrationHandler. Same prerequisites as create_offer_and_commit (sign_full_offer + EIP-712 signature). Use for instant-fulfilment private trades. Returns unsigned tr…
| Parameter | Type | Description |
|---|---|---|
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
| signature* | string | 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* | string | Ethereum address of the seller creating this non-listed offer. Must match the seller's assistant address. |
| committer* | — | Ethereum address of the buyer committing in the same transaction. |
| collectionIndex | string | Index of the seller's NFT collection for vouchers. Omit to use default (index 0). |
| royaltyInfo | object | — |
| drMutualizerAddress | — | Optional dispute resolver mutualizer contract address that pools resolution funds. |
| conditionalTokenId | — | Optional token ID of the NFT gate token used by this specific commit (for SpecificToken gating type). |
| condition | object | — |
| useDepositedFunds | boolean | If true, use funds already deposited in the protocol treasury instead of transferring from the wallet. |
| sellerId* | — | Numeric ID of the seller entity. Obtain via get_sellers_by_address. |
| buyerId* | — | Numeric ID of the buyer entity. Use '0' for seller-initiated offers. |
| metadataUri* | string | IPFS URI pointing to the offer metadata JSON. Obtain by calling store_product_v1_metadata, store_bundle_metadata, or store_base_metadata. |
| metadataHash* | string | Keccak256 hash of the metadata JSON. Returned alongside metadataUri from the store_*_metadata tools. |
| exchangeTokenAddress | — | ERC-20 token accepted for payment. Omit or use address(0) for native ETH. Call get_supported_tokens for valid values. |
| price* | — | Offer price in the exchange token's smallest unit (wei). Pass as string to avoid precision loss, e.g. '1000000000000000000' = 1 ETH. |
| sellerDeposit* | — | Seller collateral in same unit as price. Released to seller on completion or forfeited on dispute. Pass as string. |
| agentId | — | Optional dACP agent facilitating this offer. Omit or pass '0' if no agent. |
| buyerCancellationPenalty* | — | Amount buyer forfeits on cancel, in same unit as price. Must be <= price. Pass as string. |
| quantityAvailable* | number | How many times this offer can be committed to. Must be 1 when creator='BUYER'. |
| validFromDateInMS* | number | Unix timestamp in milliseconds when the offer becomes active. Example: Date.now() for immediate. |
| validUntilDateInMS* | number | Unix timestamp in milliseconds when the offer can no longer be committed to. |
| voucherRedeemableFromDateInMS* | number | Timestamp in ms from which buyer can redeem. Must be >= validFromDateInMS. |
| voucherRedeemableUntilDateInMS* | number | Timestamp in ms after which voucher cannot be redeemed. Set to 0 to use voucherValidDurationInMS instead. |
void_offerVoids a listed offer so it can no longer be committed to. Caller must be the seller assistant. Existing exchanges are unaffected. Returns unsigned transaction data.Voids a listed offer so it can no longer be committed to. Caller must be the seller assistant. Existing exchanges are unaffected. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| offerId* | string | ID of the listed offer to void. Caller must be the seller assistant. Existing exchanges are unaffected. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
void_non_listed_offerVoids a private (non-listed) offer before it is fulfilled. Prerequisite: call sign_full_offer and sign the returned typed data locally with your wallet (EIP-712) to obtain the signature. Returns unsigned transaction data.Voids a private (non-listed) offer before it is fulfilled. Prerequisite: call sign_full_offer and sign the returned typed data locally with your wallet (EIP-712) to obtain the signature. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| condition | object | — |
| useDepositedFunds | boolean | If true, use funds already deposited in the protocol treasury instead of transferring from the wallet. |
| sellerId* | — | Numeric ID of the seller entity. Obtain via get_sellers_by_address. |
| buyerId* | — | Numeric ID of the buyer entity. Use '0' for seller-initiated offers. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
| metadataUri* | string | IPFS URI pointing to the offer metadata JSON. Obtain by calling store_product_v1_metadata, store_bundle_metadata, or store_base_metadata. |
| metadataHash* | string | Keccak256 hash of the metadata JSON. Returned alongside metadataUri from the store_*_metadata tools. |
| exchangeTokenAddress | — | ERC-20 token accepted for payment. Omit or use address(0) for native ETH. Call get_supported_tokens for valid values. |
| price* | — | Offer price in the exchange token's smallest unit (wei). Pass as string to avoid precision loss, e.g. '1000000000000000000' = 1 ETH. |
| sellerDeposit* | — | Seller collateral in same unit as price. Released to seller on completion or forfeited on dispute. Pass as string. |
| agentId | — | Optional dACP agent facilitating this offer. Omit or pass '0' if no agent. |
| buyerCancellationPenalty* | — | Amount buyer forfeits on cancel, in same unit as price. Must be <= price. Pass as string. |
| quantityAvailable* | number | How many times this offer can be committed to. Must be 1 when creator='BUYER'. |
| validFromDateInMS* | number | Unix timestamp in milliseconds when the offer becomes active. Example: Date.now() for immediate. |
| validUntilDateInMS* | number | Unix timestamp in milliseconds when the offer can no longer be committed to. |
| voucherRedeemableFromDateInMS* | number | Timestamp in ms from which buyer can redeem. Must be >= validFromDateInMS. |
| voucherRedeemableUntilDateInMS* | number | Timestamp in ms after which voucher cannot be redeemed. Set to 0 to use voucherValidDurationInMS instead. |
| disputePeriodDurationInMS* | number | Duration in ms for buyer to raise a dispute after redeeming. Example: 604800000 = 7 days. |
| voucherValidDurationInMS* | number | Voucher is redeemable for this many ms after commit. Set to 0 to use voucherRedeemableUntilDateInMS instead. |
| resolutionPeriodDurationInMS* | number | Duration in ms to respond to a resolution proposal before it expires. Example: 259200000 = 3 days. |
| disputeResolverId | string | ID of the dispute resolver for escalated disputes. Call get_dispute_resolvers to list available resolvers. |
| collectionIndex | — | Index of the seller's NFT collection for vouchers. Omit to use default (index 0). |
| feeLimit | — | Max protocol fee the seller accepts in same token unit. Pass as string. |
| priceType | number | 0 = static price, 1 = discovery price (auction). |
void_non_listed_offer_batchVoids multiple private offers atomically. Same prerequisite as void_non_listed_offer, but for an array of full offer objects. Returns unsigned transaction data.Voids multiple private offers atomically. Same prerequisite as void_non_listed_offer, but for an array of full offer objects. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| fullOffers* | array | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
create_sellerCreates a seller account on Boson Protocol. Required before creating any offers. signerAddress is automatically set as admin, assistant, and treasury. Provide seller metadata and royaltyPercentage. Returns unsigned transaction data.Creates a seller account on Boson Protocol. Required before creating any offers. signerAddress is automatically set as admin, assistant, and treasury. Provide seller metadata and royaltyPercentage. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
| type* | string | — |
| name | string | — |
| description | string | — |
| legalTradingName | string | — |
| kind* | string | — |
| website | string | — |
| images | array | — |
| contactLinks | array | — |
| contactPreference* | string | — |
| socialLinks | array | — |
| salesChannels | array | — |
| contractUri* | string | URI for OpenSea-style storefront metadata. Can be IPFS URI or empty string. |
| royaltyPercentage* | string | Default resale royalty in basis points (0–10000). Applied to all offers unless overridden. |
| authTokenId* | — | NFT token ID used as auth token (e.g. Lens profile ID). Pass '0' if not using auth tokens. |
| authTokenType* | number | Auth token type: 0=None, 1=Lens Protocol profile NFT. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
update_sellerUpdates an existing seller account. Caller must be the current seller admin (signerAddress). Use get_sellers_by_address to retrieve the seller id first. Returns unsigned transaction data.Updates an existing seller account. Caller must be the current seller admin (signerAddress). Use get_sellers_by_address to retrieve the seller id first. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
| type* | string | — |
| name | string | — |
| description | string | — |
| legalTradingName | string | — |
| kind* | string | — |
| website | string | — |
| images | array | — |
| contactLinks | array | — |
| contactPreference* | string | — |
| socialLinks | array | — |
| salesChannels | array | — |
| authTokenId* | string | NFT token ID used as auth token (e.g. Lens profile ID). Pass '0' if not using auth tokens. |
| authTokenType* | number | Auth token type: 0=None, 1=Lens Protocol profile NFT. |
| id* | — | Numeric ID of the existing seller entity to update. Obtain from get_sellers_by_address. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
send_signed_transactionBroadcasts a signed raw Ethereum transaction to the network. signedTransaction must be 0x-prefixed RLP-encoded hex obtained from local wallet signing (e.g. ethers `wallet.signTransaction(tx)`). Returns: transaction hash, block number, and gas used.Broadcasts a signed raw Ethereum transaction to the network. signedTransaction must be 0x-prefixed RLP-encoded hex obtained from local wallet signing (e.g. ethers `wallet.signTransaction(tx)`). Returns: transaction hash, block number, and gas used.
| Parameter | Type | Description |
|---|---|---|
| signedTransaction* | string | RLP-encoded signed Ethereum transaction as 0x-prefixed hex string. Obtain from local wallet signing (e.g. ethers `wallet.signTransaction(tx)`). |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
send_meta_transactionRelays a pre-signed meta-transaction via Biconomy so the user pays no gas. Requires sigR/sigS/sigV from a locally-signed EIP-712 payload. Use when the target operation requires metaTx relay. Returns: relay transaction data.Relays a pre-signed meta-transaction via Biconomy so the user pays no gas. Requires sigR/sigS/sigV from a locally-signed EIP-712 payload. Use when the target operation requires metaTx relay. Returns: relay transaction data.
| Parameter | Type | Description |
|---|---|---|
| functionName* | string | — |
| functionSignature* | string | — |
| nonce* | string | number | — |
| sigR* | string | — |
| sigS* | string | — |
| sigV* | string | number | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
send_native_meta_transactionRelays a native meta-transaction (EIP-712 signed function call) via Biconomy. Requires ABI-encoded function signature and sigR/sigS/sigV from a locally-signed EIP-712 payload. Returns: relay transaction data.Relays a native meta-transaction (EIP-712 signed function call) via Biconomy. Requires ABI-encoded function signature and sigR/sigS/sigV from a locally-signed EIP-712 payload. Returns: relay transaction data.
| Parameter | Type | Description |
|---|---|---|
| contractAddress* | string | Valid Ethereum address (e.g. '0xAbCd...' or '0xabcd...'). Mixed-case addresses are checksum-validated; all-lowercase and all-uppercase addresses are also accep… |
| functionSignature* | string | — |
| sigR* | string | — |
| sigS* | string | — |
| sigV* | string | number | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
send_forwarded_meta_transactionRelays a Biconomy forwarded meta-transaction (ERC-20 gas payment). Requires a complete ERC20ForwardRequest and domain separator signature. Returns: relay transaction data.Relays a Biconomy forwarded meta-transaction (ERC-20 gas payment). Requires a complete ERC20ForwardRequest and domain separator signature. Returns: relay transaction data.
| Parameter | Type | Description |
|---|---|---|
| contractAddress* | string | Valid Ethereum address (e.g. '0xAbCd...' or '0xabcd...'). Mixed-case addresses are checksum-validated; all-lowercase and all-uppercase addresses are also accep… |
| request* | object | — |
| domainSeparator* | string | — |
| signature* | string | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
withdraw_fundsWithdraws funds from an entity's protocol treasury to the entity's treasury address. Sellers withdraw proceeds; buyers withdraw refunds. Caller must control the entity via signerAddress. Returns unsigned transaction data.Withdraws funds from an entity's protocol treasury to the entity's treasury address. Sellers withdraw proceeds; buyers withdraw refunds. Caller must control the entity via signerAddress. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | Numeric ID of the seller or buyer entity withdrawing funds. |
| list* | array | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
deposit_fundsDeposits ERC-20 or native tokens into an entity's protocol treasury (e.g. seller deposit). For ERC-20, call approve_exchange_token first. Returns unsigned transaction data.Deposits ERC-20 or native tokens into an entity's protocol treasury (e.g. seller deposit). For ERC-20, call approve_exchange_token first. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| entityId* | string | Numeric ID of the entity to credit. Must match signerAddress's seller account. |
| tokenAddress* | string | ERC-20 token to deposit. Use address(0) for native ETH. |
| amount* | — | Amount in wei. For ERC-20, approve_exchange_token must be called first. Pass as string. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
extend_dispute_timeoutExtends the deadline of an active dispute. Dispute must be in 'Resolving' state. Either party can call this. Returns unsigned transaction data.Extends the deadline of an active dispute. Dispute must be in 'Resolving' state. Either party can call this. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| newDisputeTimeout* | — | New absolute Unix timestamp in SECONDS (not ms) for the dispute deadline. Must be later than current timeout. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
expire_disputeMarks a dispute as expired after its resolution period passes. Permissionless — anyone can call. Exchange must be in 'Disputed' state past its timeout. Returns unsigned transaction data.Marks a dispute as expired after its resolution period passes. Permissionless — anyone can call. Exchange must be in 'Disputed' state past its timeout. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
expire_dispute_batchMarks multiple expired disputes in one transaction. All exchanges must be in 'Disputed' state past their respective timeouts. Permissionless. Returns unsigned transaction data.Marks multiple expired disputes in one transaction. All exchanges must be in 'Disputed' state past their respective timeouts. Permissionless. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeIds* | array | Array of exchange IDs whose dispute period has passed. All must be in 'Disputed' state past their timeout. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
resolve_disputeResolves a dispute by mutual agreement. Workflow: (1) create_dispute_resolution_proposal generates typed data, (2) both parties sign the typed data locally with their wallet (EIP-712), (3) either party submits sigR/sigS/sigV here. Returns unsigned transaction data.Resolves a dispute by mutual agreement. Workflow: (1) create_dispute_resolution_proposal generates typed data, (2) both parties sign the typed data locally with their wallet (EIP-712), (3) either party submits sigR/sigS/sigV here. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| buyerPercentBasisPoints* | — | Agreed buyer share in basis points (0–10000). Both parties must sign the same value. Obtain via create_dispute_resolution_proposal then sign the typed data loc… |
| sigR* | string | 32-byte R component of the ECDSA resolution signature as 0x-prefixed hex. From the locally-signed EIP-712 signature parameters. |
| sigS* | string | 32-byte S component as 0x-prefixed hex. From the locally-signed EIP-712 signature parameters. |
| sigV* | — | Recovery byte V: 27 or 28. From the locally-signed EIP-712 signature parameters. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
raise_disputeRaises a dispute on a redeemed exchange. Caller must be the buyer. Must be called within disputePeriodDurationInMS after redemption. Returns unsigned transaction data.Raises a dispute on a redeemed exchange. Caller must be the buyer. Must be called within disputePeriodDurationInMS after redemption. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
retract_disputeRetracts a raised dispute, releasing seller deposit and restoring completion flow. Caller must be the buyer who raised it. Returns unsigned transaction data.Retracts a raised dispute, releasing seller deposit and restoring completion flow. Caller must be the buyer who raised it. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
escalate_disputeEscalates a stale dispute to the third-party dispute resolver. Caller must be the buyer. Resolver's escalation fee must be covered. Returns unsigned transaction data.Escalates a stale dispute to the third-party dispute resolver. Caller must be the buyer. Resolver's escalation fee must be covered. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
decide_disputeDecides an escalated dispute. Caller must be the dispute resolver assigned to the offer's disputeResolverId. Specify buyerPercent in basis points (0=all to seller, 10000=all to buyer). Returns unsigned transaction data.Decides an escalated dispute. Caller must be the dispute resolver assigned to the offer's disputeResolverId. Specify buyerPercent in basis points (0=all to seller, 10000=all to buyer). Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| buyerPercent* | — | Percentage of disputed funds to buyer in basis points (0–10000). 10000 = all to buyer, 0 = all to seller. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
refuse_escalated_disputeDispute resolver refuses to decide an escalated dispute. Returns the escalation fee to the buyer and resets dispute to 'Resolving' state. Returns unsigned transaction data.Dispute resolver refuses to decide an escalated dispute. Returns the escalation fee to the buyer and resets dispute to 'Resolving' state. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
expire_escalated_disputeExpires an escalated dispute once the resolver's response period passes without a decision. Permissionless — anyone can call. Returns unsigned transaction data.Expires an escalated dispute once the resolver's response period passes without a decision. Permissionless — anyone can call. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
create_dispute_resolution_proposalGenerates EIP-712 typed data for a mutual dispute resolution proposal. Both buyer and seller must sign the same buyerPercentBasisPoints value locally with their wallet (EIP-712) before calling resolve_dispute. Returns: typed data structure (domain, types, message).Generates EIP-712 typed data for a mutual dispute resolution proposal. Both buyer and seller must sign the same buyerPercentBasisPoints value locally with their wallet (EIP-712) before calling resolve_dispute. Returns: typed data structure (domain, types, message).
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| buyerPercentBasisPoints* | — | Proposed percentage of disputed funds for the buyer, 0–10000 (basis points). The counterparty must sign this same value. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
revoke_voucherRevokes a committed (not yet redeemed) voucher on behalf of the seller, returning funds to the buyer. Caller must be the seller assistant. Returns unsigned transaction data.Revokes a committed (not yet redeemed) voucher on behalf of the seller, returning funds to the buyer. Caller must be the seller assistant. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
approve_exchange_tokenGrants ERC-20 allowance to the Boson Protocol contract. Must be called before commit_to_offer or deposit_funds when using non-native exchange tokens. Returns unsigned transaction data.Grants ERC-20 allowance to the Boson Protocol contract. Must be called before commit_to_offer or deposit_funds when using non-native exchange tokens. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeTokenAddress* | string | ERC-20 token contract address to approve for the Boson Protocol diamond. |
| amount* | string | Allowance in wei. Use max uint256 string for unlimited: '115792089237316195423570985008687907853269984665640564039457584007913129639935'. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
sign_receive_with_erc3009_authorizationGenerates EIP-712 typed data for an ERC-3009 ReceiveWithAuthorization (e.g. USDC). Authorizes the spender (default: protocol diamond) to pull `value` from signerAddress between validAfter and validBefore. Sign locally with your wallet (EIP-712); use the resulting signature + nonce to build a Transf…Generates EIP-712 typed data for an ERC-3009 ReceiveWithAuthorization (e.g. USDC). Authorizes the spender (default: protocol diamond) to pull `value` from signerAddress between validAfter and validBefore. Sign locally with your wallet (EIP-712); use the resulting signature + nonce to build a Transf…
| Parameter | Type | Description |
|---|---|---|
| exchangeTokenAddress* | string | ERC-20 token contract address that supports the permit/authorization standard. |
| value* | string | Amount in wei the spender is authorized to pull from the signer. |
| spender | — | Optional spender address. Defaults to the Boson Protocol diamond from SDK config. |
| tokenDomainName* | string | EIP-712 domain name of the token contract (e.g. 'USD Coin'). Required for ERC-3009 / EIP-2612 domain separator. |
| tokenDomainVersion* | string | EIP-712 domain version of the token contract (e.g. '2'). Required for ERC-3009 / EIP-2612 domain separator. |
| validAfter* | — | Unix timestamp in seconds before which the authorization is not valid. |
| validBefore* | — | Unix timestamp in seconds after which the authorization is no longer valid. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
sign_receive_with_erc2612_permitGenerates EIP-712 typed data for an EIP-2612 Permit. Authorizes the spender (default: protocol diamond) to pull `value` from signerAddress until `deadline`. Sign locally with your wallet (EIP-712); use the resulting signature to build a TransferAuthorization { strategy: 'EIP2612' } for a meta-tx fl…Generates EIP-712 typed data for an EIP-2612 Permit. Authorizes the spender (default: protocol diamond) to pull `value` from signerAddress until `deadline`. Sign locally with your wallet (EIP-712); use the resulting signature to build a TransferAuthorization { strategy: 'EIP2612' } for a meta-tx fl…
| Parameter | Type | Description |
|---|---|---|
| exchangeTokenAddress* | string | ERC-20 token contract address that supports the permit/authorization standard. |
| value* | string | Amount in wei the spender is authorized to pull from the signer. |
| spender | — | Optional spender address. Defaults to the Boson Protocol diamond from SDK config. |
| tokenDomainName* | string | EIP-712 domain name of the token contract (e.g. 'USD Coin'). Required for ERC-3009 / EIP-2612 domain separator. |
| tokenDomainVersion* | string | EIP-712 domain version of the token contract (e.g. '2'). Required for ERC-3009 / EIP-2612 domain separator. |
| deadline* | — | Unix timestamp in seconds after which the permit is no longer valid. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
sign_receive_with_permit2Generates EIP-712 typed data for a Uniswap Permit2 PermitTransferFrom. Authorizes the spender (default: protocol diamond) to pull `value` from signerAddress until `deadline`. permit2Address defaults to contracts.permit2 from SDK config; permit2Nonce defaults to a random uint256. Sign locally with y…Generates EIP-712 typed data for a Uniswap Permit2 PermitTransferFrom. Authorizes the spender (default: protocol diamond) to pull `value` from signerAddress until `deadline`. permit2Address defaults to contracts.permit2 from SDK config; permit2Nonce defaults to a random uint256. Sign locally with y…
| Parameter | Type | Description |
|---|---|---|
| exchangeTokenAddress* | string | ERC-20 token contract address that supports the permit/authorization standard. |
| value* | string | Amount in wei the spender is authorized to pull from the signer. |
| spender | — | Optional spender address. Defaults to the Boson Protocol diamond from SDK config. |
| deadline* | — | Unix timestamp in seconds after which the Permit2 authorization is no longer valid. |
| permit2Address | — | Optional Uniswap Permit2 contract address. Defaults to contracts.permit2 from SDK config. |
| permit2Nonce | — | Optional Permit2 nonce as a uint256 string. If omitted, a random uint256 is generated. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
sign_receive_with_dai_permitGenerates EIP-712 typed data for a DAI-style Permit. Authorizes the spender (default: protocol diamond) to pull DAI-style tokens from signerAddress until `expiry`. Sign locally with your wallet (EIP-712); use the result to build a TransferAuthorization { strategy: 'DAIPermit' } for a meta-tx flow.…Generates EIP-712 typed data for a DAI-style Permit. Authorizes the spender (default: protocol diamond) to pull DAI-style tokens from signerAddress until `expiry`. Sign locally with your wallet (EIP-712); use the result to build a TransferAuthorization { strategy: 'DAIPermit' } for a meta-tx flow.…
| Parameter | Type | Description |
|---|---|---|
| exchangeTokenAddress* | string | ERC-20 token contract address that supports the permit/authorization standard. |
| value* | string | Amount in wei the spender is authorized to pull from the signer. |
| spender | — | Optional spender address. Defaults to the Boson Protocol diamond from SDK config. |
| tokenDomainName* | string | EIP-712 domain name of the DAI-style token (e.g. 'Dai Stablecoin'). |
| expiry* | — | Unix timestamp in seconds after which the DAI-style permit is no longer valid. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
commit_to_offerCommits to an offer, creating an exchange and minting a voucher NFT. Caller is the buyer (signerAddress) unless 'buyer' param is set. For ERC-20 offers, call approve_exchange_token first. Returns unsigned transaction data.Commits to an offer, creating an exchange and minting a voucher NFT. Caller is the buyer (signerAddress) unless 'buyer' param is set. For ERC-20 offers, call approve_exchange_token first. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| offerId* | string | ID of the active offer to commit to. Creates an exchange and mints a voucher NFT. |
| buyer | string | Optional buyer address if different from signerAddress. When set, executionMode must be 'direct'. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
commit_to_conditional_offerCommits to a token-gated (conditional) offer using a specific gating tokenId. Caller (signerAddress) must hold the gating token specified by the offer's condition. Use this instead of commit_to_offer for offers created via create_offer_with_condition. Returns unsigned transaction data.Commits to a token-gated (conditional) offer using a specific gating tokenId. Caller (signerAddress) must hold the gating token specified by the offer's condition. Use this instead of commit_to_offer for offers created via create_offer_with_condition. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| offerId* | string | ID of a conditional (token-gated) offer to commit to. Caller must hold the gating token specified by the offer's condition. |
| tokenId* | — | Token ID of the gate token used to qualify for the conditional commit (relevant for ERC-721/1155 and TokenRange gating). |
| buyer | string | Optional buyer address if different from signerAddress. When set, executionMode must be 'direct'. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
commit_to_offer_and_redeem_voucherAtomically commits to an offer and immediately redeems the voucher in a single transaction via the OrchestrationHandler. Buyer (signerAddress) must already hold any required ERC-20 allowance (approve_exchange_token). Skips voucher transferability and starts the dispute period clock immediately. Ret…Atomically commits to an offer and immediately redeems the voucher in a single transaction via the OrchestrationHandler. Buyer (signerAddress) must already hold any required ERC-20 allowance (approve_exchange_token). Skips voucher transferability and starts the dispute period clock immediately. Ret…
| Parameter | Type | Description |
|---|---|---|
| offerId* | string | ID of the active offer to commit to and immediately redeem in a single transaction. Combines commit_to_offer + redeem_voucher via the OrchestrationHandler. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
commit_to_conditional_offer_and_redeem_voucherAtomically commits to a token-gated (conditional) offer using a specific gating tokenId and immediately redeems the voucher in a single transaction. Buyer must hold the gating token. Returns unsigned transaction data.Atomically commits to a token-gated (conditional) offer using a specific gating tokenId and immediately redeems the voucher in a single transaction. Buyer must hold the gating token. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| offerId* | string | ID of a conditional (token-gated) offer to commit to and immediately redeem in a single transaction. |
| tokenId* | — | Token ID of the gate token used to qualify for the conditional commit (relevant for ERC-721/1155 and SpecificToken / TokenRange gating). |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
commit_to_buyer_offerFulfils a buyer-initiated offer (creator='BUYER') by the seller. Caller must be the seller. Provide matching collateral. Returns unsigned transaction data.Fulfils a buyer-initiated offer (creator='BUYER') by the seller. Caller must be the seller. Provide matching collateral. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| offerId* | string | ID of a buyer-initiated offer (creator='BUYER') to commit to. The seller fulfils the offer. |
| collectionIndex | — | — |
| royaltyInfo | object | — |
| drMutualizerAddress | — | Valid Ethereum address (e.g. '0xAbCd...' or '0xabcd...'). Mixed-case addresses are checksum-validated; all-lowercase and all-uppercase addresses are also accep… |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
cancel_voucherCancels a committed voucher. Caller must be the buyer (voucher holder). Buyer forfeits buyerCancellationPenalty; remainder is refunded. Returns unsigned transaction data.Cancels a committed voucher. Caller must be the buyer (voucher holder). Buyer forfeits buyerCancellationPenalty; remainder is refunded. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
redeem_voucherRedeems a voucher, signalling physical receipt of goods and starting the dispute period clock. Caller must be the buyer. After redemption, buyer has disputePeriodDurationInMS to raise a dispute. Returns unsigned transaction data.Redeems a voucher, signalling physical receipt of goods and starting the dispute period clock. Caller must be the buyer. After redemption, buyer has disputePeriodDurationInMS to raise a dispute. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
complete_exchangeCompletes an exchange after the dispute period expires, releasing funds to the seller. Can be called by seller after dispute period or by buyer at any time post-redemption. Returns unsigned transaction data.Completes an exchange after the dispute period expires, releasing funds to the seller. Can be called by seller after dispute period or by buyer at any time post-redemption. Returns unsigned transaction data.
| Parameter | Type | Description |
|---|---|---|
| exchangeId* | string | Numeric ID of the exchange/dispute to act on. Obtain from get_exchanges or the response of commit_to_offer. |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
| executionMode | string | 'direct' = standard on-chain tx (sign locally with your wallet → send_signed_transaction). 'metaTx' = gasless relay via Biconomy (send_meta_transaction). Defau… |
get_sellers_by_addressReads seller entities associated with a specific Ethereum address. Use this to check if signerAddress already has a seller account before calling create_seller. Read-only. Returns: array of seller entities.Reads seller entities associated with a specific Ethereum address. Use this to check if signerAddress already has a seller account before calling create_seller. Read-only. Returns: array of seller entities.
| Parameter | Type | Description |
|---|---|---|
| address* | string | — |
| sellersSkip | number | — |
| sellersFirst | number | — |
| sellersOrderBy | string | — |
| sellersOrderDirection | string | — |
| sellersFilter | object | — |
| includeExchanges | boolean | — |
| includeOffers | boolean | — |
| includeFunds | boolean | — |
| includeLogs | boolean | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
get_all_products_with_not_voided_variantsReads product groupings with at least one non-voided variant from the Boson subgraph. Useful for storefront displays. Supports pagination and ordering. Read-only.Reads product groupings with at least one non-voided variant from the Boson subgraph. Useful for storefront displays. Supports pagination and ordering. Read-only.
| Parameter | Type | Description |
|---|---|---|
| productsSkip | number | — |
| productsFirst | number | — |
| productsOrderBy | string | — |
| productsOrderDirection | string | — |
| productsFilter | object | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
search_productsSearches products in the Boson subgraph by keywords matched against title, description, brand, category, and tags. Supports pagination, ordering, filtering, and an includeInvalidOffers flag (default false = only products with currently-valid offers). Read-only. Returns: array of product search resu…Searches products in the Boson subgraph by keywords matched against title, description, brand, category, and tags. Supports pagination, ordering, filtering, and an includeInvalidOffers flag (default false = only products with currently-valid offers). Read-only. Returns: array of product search resu…
| Parameter | Type | Description |
|---|---|---|
| keywords* | array | List of keywords matched against product title, description, brand, category, and tags. |
| includeInvalidOffers | boolean | When true, include products whose offers are outside their validity window. Defaults to false (valid offers only). |
| productsSkip | number | — |
| productsFirst | number | — |
| productsOrderBy | string | — |
| productsOrderDirection | string | — |
| productsFilter | object | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
validate_metadataValidates a metadata object against the Boson Protocol schema (PRODUCT_V1, BUNDLE, BASE, etc.) without storing it. Use before store_*_metadata to catch errors early. Read-only. Returns: validation result with any errors.Validates a metadata object against the Boson Protocol schema (PRODUCT_V1, BUNDLE, BASE, etc.) without storing it. Use before store_*_metadata to catch errors early. Read-only. Returns: validation result with any errors.
| Parameter | Type | Description |
|---|---|---|
| metadata* | object | — |
store_product_v1_metadataStores a ProductV1 metadata object to IPFS. Call before create_offer to get metadataUri and metadataHash. Returns: { metadataUri: 'ipfs://...', metadataHash: '0x...' }.Stores a ProductV1 metadata object to IPFS. Call before create_offer to get metadataUri and metadataHash. Returns: { metadataUri: 'ipfs://...', metadataHash: '0x...' }.
| Parameter | Type | Description |
|---|---|---|
| schemaUrl* | string | — |
| type* | string | — |
| uuid* | string | — |
| name* | string | — |
| description* | string | — |
| externalUrl* | string | — |
| licenseUrl* | string | — |
| youtubeUrl | string | — |
| condition | string | — |
| image* | string | — |
| imageData | string | — |
| animationUrl | string | — |
| attributes* | array | — |
| product* | object | — |
| variations | array | — |
| seller* | object | — |
| shipping* | object | — |
| exchangePolicy* | object | — |
| productOverrides | object | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
store_bundle_metadataStores a Bundle metadata object to IPFS. Prerequisite: call store_bundle_item_product_v1_metadata and/or store_bundle_item_nft_metadata first; include their returned URLs in the items array. Returns: { metadataUri, metadataHash }.Stores a Bundle metadata object to IPFS. Prerequisite: call store_bundle_item_product_v1_metadata and/or store_bundle_item_nft_metadata first; include their returned URLs in the items array. Returns: { metadataUri, metadataHash }.
| Parameter | Type | Description |
|---|---|---|
| schemaUrl* | string | — |
| type* | string | — |
| name* | string | — |
| description* | string | — |
| image | string | — |
| imageData | string | — |
| externalUrl* | string | — |
| licenseUrl* | string | — |
| youtubeUrl | string | — |
| condition | string | — |
| animationUrl | string | — |
| attributes | array | — |
| bundleUuid* | string | — |
| seller* | object | — |
| items* | array | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
store_base_metadataStores a Base metadata object to IPFS. Use for simple offers that don't require ProductV1 or Bundle structure. Returns: { metadataUri, metadataHash } for use in create_offer.Stores a Base metadata object to IPFS. Use for simple offers that don't require ProductV1 or Bundle structure. Returns: { metadataUri, metadataHash } for use in create_offer.
| Parameter | Type | Description |
|---|---|---|
| schemaUrl* | string | — |
| type* | string | — |
| name* | string | — |
| description* | string | — |
| image | string | — |
| imageData | string | — |
| externalUrl* | string | — |
| licenseUrl* | string | — |
| condition | string | — |
| animationUrl | string | — |
| youtubeUrl | string | — |
| attributes | array | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
render_contractual_agreementRenders the legal contractual agreement text/HTML for an offer using its offer data and metadata. Use to preview or store the agreement. Returns: rendered agreement string.Renders the legal contractual agreement text/HTML for an offer using its offer data and metadata. Use to preview or store the agreement. Returns: rendered agreement string.
| Parameter | Type | Description |
|---|---|---|
| template* | string | — |
| offerData* | object | — |
| offerMetadata* | object | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | — | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
store_bundle_item_product_v1_metadataStores a single ProductV1 bundle item's metadata to IPFS. Call once per physical product in a bundle before store_bundle_metadata. Returns: { url: 'ipfs://...' } to include in the items array.Stores a single ProductV1 bundle item's metadata to IPFS. Call once per physical product in a bundle before store_bundle_metadata. Returns: { url: 'ipfs://...' } to include in the items array.
| Parameter | Type | Description |
|---|---|---|
| schemaUrl* | string | — |
| type* | string | — |
| uuid* | string | — |
| product* | object | — |
| variations | array | — |
| shipping* | object | — |
| exchangePolicy* | object | — |
| productOverrides | object | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
store_bundle_item_nft_metadataStores a single NFT bundle item's metadata to IPFS. Call once per NFT component in a bundle before store_bundle_metadata. Returns: { url: 'ipfs://...' } to include in the items array.Stores a single NFT bundle item's metadata to IPFS. Call once per NFT component in a bundle before store_bundle_metadata. Returns: { url: 'ipfs://...' } to include in the items array.
| Parameter | Type | Description |
|---|---|---|
| schemaUrl* | string | — |
| type* | string | — |
| name* | string | — |
| description | string | — |
| image | string | — |
| imageData | string | — |
| externalUrl | string | — |
| animationUrl | string | — |
| youtubeUrl | string | — |
| image_data | string | — |
| external_url | string | — |
| animation_url | string | — |
| youtube_url | string | — |
| attributes | array | — |
| chainId | number | — |
| contract | string | — |
| tokenId | string | — |
| tokenIdRange | object | — |
| terms | array | — |
| quantity | number | — |
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
| signerAddress* | string | Ethereum address that will sign and send this transaction. Must match the wallet that will sign the returned transaction locally. |
register_agentRegisters a dACP agent with this MCP server instance, associating its Ethereum identities and roles. The signature proves control of each signerAddress. Server-local state — no configId/signerAddress context needed. Returns: registration confirmation.Registers a dACP agent with this MCP server instance, associating its Ethereum identities and roles. The signature proves control of each signerAddress. Server-local state — no configId/signerAddress context needed. Returns: registration confirmation.
| Parameter | Type | Description |
|---|---|---|
| name* | string | — |
| description* | string | — |
| entities* | array | — |
get_registered_agentsReturns all dACP agents registered with this MCP server instance, with their associated protocol entities and roles. No auth required.Returns all dACP agents registered with this MCP server instance, with their associated protocol entities and roles. No auth required.
| Parameter | Type | Description |
|---|---|---|
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
get_supported_tokensReturns ERC-20 tokens accepted as exchange tokens on the given configId deployment. Use returned addresses in exchangeTokenAddress fields of create_offer. Read-only. Returns: array of { address, name, symbol, decimals }.Returns ERC-20 tokens accepted as exchange tokens on the given configId deployment. Use returned addresses in exchangeTokenAddress fields of create_offer. Read-only. Returns: array of { address, name, symbol, decimals }.
| Parameter | Type | Description |
|---|---|---|
| configId* | string | Boson/Fermion Protocol deployment identifier. Format: '<env>-<chainId>-<index>' e.g. 'production-137-0' (Polygon mainnet), 'testing-80002-0' (Amoy testnet). Ca… |
63 of 63 tools published a description.
Tool names and descriptions are written by the publisher and shown verbatim as inert text. They are the strings an MCP client passes to a model, so Forge scans them for prompt-injection patterns — any finding appears with the security scan above. “Privileged” is a keyword match on the tool name, not an audit of what the tool does: a benign-sounding name can still do anything.
MCP server for Boson Protocol — on-chain agentic commerce for physical & digital goods.
+ 23 more observed on this entry.
Linked names open Forge’s index of every entry observed exposing that tool. Browse all indexed tools.
This entry publishes no npm package, so Forge has no dependency tree for it. That is a gap in coverage — not a statement that it has no dependencies.