跳到主要内容

Broadcaster 接入流程

本页沿用概览的身份校验。所有调用发往选定的 /v1/chains/{chainId},使用 Content-Type: application/json、位置参数数组和非空请求 id。

方法与消息​

{"jsonrpc":"2.0","id":"relay-status-1","method":"broadcaster_getStatus","params":[]}
方法params 内容返回
broadcaster_getVersion[]apiVersion、protocolVersion
broadcaster_getStatus[]身份、halt 状态、预约和来源策略
broadcaster_getTokenSupport[{tokenAddress}]服务状态和 supported
broadcaster_getGasReference[{shape}]SDK 模型用量与来源,或不可用错误
broadcaster_estimateQuote[{data,schedule?}]feeRecipient、feeAmount、maxGas
broadcaster_getQuote[{data,schedule?}]quote、signature 和可选来源要求
broadcaster_submitTransaction[{data,quote,signature,memberProof?,proofSidecars?}]持久任务状态
broadcaster_getTransactionStatus[{id}]当前任务状态
broadcaster_cancelTransaction[{id,cancelToken}]已持久化取消或错误

业务查询对象拒绝未知字段。金额、gas 上限、chain ID、deadline 和预约时间用十进制字符串;shape 的计数、gas reference 的 gasUnits/sampleCount 是 JSON 数字。地址为 20 字节,哈希为 32 字节 hex,calldata/signature 为 hex 字节串。

以下只读示例需 POSIX shell、curl、jq,并设置完整链路由 BROADCASTER_RPC_URL 与真实非零 ERC20 地址 TOKEN_ADDRESS。支持查询不发送 calldata、不估费、不调用 Provenance。

: "${BROADCASTER_RPC_URL:?Set the full trusted chain RPC URL}"
: "${TOKEN_ADDRESS:?Set the expected ERC20 contract address}"
jq -n --arg token "$TOKEN_ADDRESS" \
'{jsonrpc:"2.0",id:2,method:"broadcaster_getTokenSupport",params:[{tokenAddress:$token}]}' |
curl --fail-with-body -sS "$BROADCASTER_RPC_URL" \
-H 'Content-Type: application/json' --data-binary @-

supported:true 仅表示当前价格与服务准入可用,不能保证具体操作可报价。

准备至提交​

  1. 用匹配 SDK 准备业务意图,确定 token、接收方、金额和输入。
  2. 调用 estimateQuote,根据 feeRecipient/feeAmount 重建意图;结构变化后重新估算,并强制用户 maxFeeAmount。默认 SDK 最多重建四次。
  3. 对最终含费 calldata 调用 getQuote。验证 EIP-712 签名、部署、完整 requestHash、token、费用、期限和 execution。
  4. 固定全部业务字段后取得钱包授权、生成所需证明及资金签名。Shield 无需生成 ZK 证明;Credit revoke 使用对应 owner 授权。
  5. 按服务签名策略准备公开 Provenance sidecar;按 aggregate execution 准备 SDK 递归 memberProof。不得发送私密 witness。
  6. 在本地持久化完整提交 body,再调用 submitTransaction;保存服务返回的 id,轮询并独立核验链。

报价域为 InvisiBroadcaster、版本 1,绑定 chain ID 与 Protocol 合约。quote 包含 token、feeRecipient、feeAmount、deadline、maxGas、requestHash、execution,以及可选签名 schedule。不要手写哈希或删改返回字段,使用匹配 SDK 的验证实现。

estimate/getQuote 不接收 proofSidecars,也不调用 Provenance。开启来源策略时,普通 Note 输入 transact 的提交需要一份 operationIndex:"0" sidecar;零输入公开出资、Shield、Credit 入口不需要。来源拒绝或不可用不能按 allow 处理。首次提交策略变化要求重新报价;已尝试发送的请求保持原样恢复。

聚合执行​

服务在授权和证明之前选择 direct 或 aggregate;用户不能在取得报价后切换。aggregate 接收单成员公开递归证据,排队后由服务生成外层证明。兼容成员可共享交易哈希,但每个任务独立跟踪;没有同伴时也可执行单成员外层聚合。聚合不会降低回执和最终性要求。

任务状态与丢失响应​

state含义与恢复
pending已持久预留发送,尚未必有哈希;保留输入
submitted发送返回交易哈希;继续核对回执
uncertain发送结果不明;保持原请求与预留
queued / proving等待或执行外层证明;尚非上链成功
confirmed / reverted回执成功 / 回滚,另行判断最终性
scheduled / preparing等待预约 / 到期校验
expired / rejected / cancelled未发送任务的窗口或接单结果;不代表协议签名撤销

若 submit 响应丢失且不知道 durable id,原样重放已保存的完整 body 以取回记录;知道 id 后查询状态。不要猜测 ID、生成新 quote/proof 或切换服务重发同一输入。未知 ID 返回 -32001,不是 null。

confirmation 为 {level,status,block};level 是 pending/included/safe/finalized,status 是 available/unsupported/unavailable/inconsistent。block 是实际交易区块或 null,number 为十进制字符串、timestamp 为 JSON 数字。原生查询不可用不会自动升级层级,也不授权重发;释放钱包预留仍需规范链核对。

错误与传输预算​

检查 HTTP 与 JSON-RPC 两层。默认 body 256 KiB、批次最多 16 调用、批响应 1 MiB;部署可调整接单资源限制。429 按 Retry-After 退避;413 缩小 body;415 修正媒体类型。带外网关认证与 CORS 取决于运营者。

-32602 修正参数,-32000 是通用业务拒绝,-32002 表示 shape 无 gas 模型,-32010 表示来源证明/规则拒绝,-32011 表示来源结果或持久跟踪不可用。不要按错误文本分类或将网络断开当成拒绝。所有方法均使用带 id 的请求;无 id 通知被抑制且不执行,不能用来提交交易。