cosign.validate_cross_chain_payload

workflowcross-chain-swap·step 2 of 7Workflow: cross-chain-swap · step 2 of 7

cosign.validate_cross_chain_payload "contract_payload" Validate a cross-chain spot v1 payload without posting it. Returns validation result with detailed error if invalid. Useful for pre-flight checks before submitting an offer. Arguments: 1. contract_payload (string, required) Cross-chain spot v1 payload JSON to validate Result: { (json object) "valid" : true|false, (boolean) Whether payload is valid "error" : "str", (string, optional) Validation error message (if invalid) "schema" : "str", (string, optional) Schema identifier (if valid) "external_chain" : "str" (string, optional) External chain (if valid) } Examples: > bitcoin-cli cosign.validate_cross_chain_payload "{...payload_json...}"

Signature

cosign.validate_cross_chain_payload(contract_payload: string) → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"cosign.validate_cross_chain_payload","params":["\"<contract_payload>\""]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli cosign.validate_cross_chain_payload "{...payload_json...}"

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "cosign.validate_cross_chain_payload",
        "params": ["\"<contract_payload>\""],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "cosign.validate_cross_chain_payload",
    params: ["\"<contract_payload>\""],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
contract_payload	`string`	yes	Cross-chain spot v1 payload JSON to validate

Result

Type: any

{ (json object) "valid" : true|false, (boolean) Whether payload is valid "error" : "str", (string, optional) Validation error message (if invalid) "schema" : "str", (string, optional) Schema identifier (if valid) "external_chain" : "str" (string, optional) External chain (if valid) }

Source: services/core-node/bcore/src/rpc/cosign.cpp:2307

C++ symbol: cosign_validate_cross_chain_payload

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"cosign.validate_cross_chain_payload","params":["\"<contract_payload>\""]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli cosign.validate_cross_chain_payload "{...payload_json...}"

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "cosign.validate_cross_chain_payload",
        "params": ["\"<contract_payload>\""],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "cosign.validate_cross_chain_payload",
    params: ["\"<contract_payload>\""],
  }),
});
console.log(await res.json());