/build/rpc / cosign / session

cosign.send

cosign.send "session_id" {} ( "idempotency_key" ) Send a JSON payload to the peer via the cosign session. Arguments: 1. session_id (string, required) Session ID 2. payload (json object, required) JSON payload to send { } 3. idempotency_key (string, optional) Optional idempotency token Result: { (json object) "ok" : true|false, (boolean) Success indicator "seq" : n (numeric) Message sequence number } Examples: > bitcoin-cli cosign.send "abc123..." '{"type":"offer","data":...}'

Signature

cosign.send(session_id: string, payload: object, idempotency_key?: string) → any

Code samples

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

bitcoin-cli cosign.send "abc123..." '{"type":"offer","data":...}'

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "cosign.send",
        "params": ["\"<session_id>\"", {}, "\"<idempotency_key>\""],
    },
    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.send",
    params: ["\"<session_id>\"",{},"\"<idempotency_key>\""],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
session_id	`string`	yes	Session ID
payload	`object`	yes	JSON payload to send { }
idempotency_key	`string`	—	Optional idempotency token

Result

Type: any

{ (json object) "ok" : true|false, (boolean) Success indicator "seq" : n (numeric) Message sequence number }

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

C++ symbol: cosign_send

Code samples

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

bitcoin-cli cosign.send "abc123..." '{"type":"offer","data":...}'

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "cosign.send",
        "params": ["\"<session_id>\"", {}, "\"<idempotency_key>\""],
    },
    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.send",
    params: ["\"<session_id>\"",{},"\"<idempotency_key>\""],
  }),
});
console.log(await res.json());