/build/rpc / cosign / session

cosign.status

cosign.status "session_id" Get runtime status of a cosign session. Arguments: 1. session_id (string, required) Session ID Result: { (json object) "state" : "str", (string) Session state: open|closing|closed|error "peer_verified" : true|false, (boolean) Whether peer BIP-322 attestation succeeded "messages_sent" : n, (numeric) Messages sent count "messages_received" : n, (numeric) Messages received count "age_sec" : n, (numeric) Session age in seconds "ttl_sec" : n, (numeric) Configured TTL "transport" : "str" (string) Active transport } Examples: > bitcoin-cli cosign.status "abc123..."

Signature

cosign.status(session_id: string) → any

Code samples

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

bitcoin-cli cosign.status "abc123..."

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

Parameters

Name	Type	Req.	Description
session_id	`string`	yes	Session ID

Result

Type: any

{ (json object) "state" : "str", (string) Session state: open|closing|closed|error "peer_verified" : true|false, (boolean) Whether peer BIP-322 attestation succeeded "messages_sent" : n, (numeric) Messages sent count "messages_received" : n, (numeric) Messages received count "age_sec" : n, (numeric) Session age in seconds "ttl_sec" : n, (numeric) Configured TTL "transport" : "str" (string) Active transport }

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

C++ symbol: cosign_status

Code samples

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

bitcoin-cli cosign.status "abc123..."

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