/build/rpc / cosign / session

cosign.join

cosign.join "invite_link" ( "context" ) Join an existing cosign session via invite link or code. Arguments: 1. invite_link (string, required) Magic link or 5-word code 2. context (string, optional) Optional context label Result: { (json object) "session_id" : "hex", (string) Joined session ID "sas" : "str", (string) 5-word SAS for verification "sas_numeric" : "str", (string) 6-digit numeric SAS "transport" : "str", (string, optional) Transport selected by bridge (websocket or tor) "relay_url" : "str" (string, optional) Relay URL used for websocket transport } Examples: > bitcoin-cli cosign.join "cosign:?r=abc...&t=ws#c=apple-banana-cherry-delta-echo" > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "cosign.join", "params": ["cosign:?r=abc...#c=..."]}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

cosign.join(invite_link: string, context?: string) → any

Code samples

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

bitcoin-cli cosign.join "cosign:?r=abc...&t=ws#c=apple-banana-cherry-delta-echo"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "cosign.join", "params": ["cosign:?r=abc...#c=..."]}' -H 'content-type: application/json' http://127.0.0.1:8332/

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

Parameters

Name	Type	Req.	Description
invite_link	`string`	yes	Magic link or 5-word code
context	`string`	—	Optional context label

Result

Type: any

{ (json object) "session_id" : "hex", (string) Joined session ID "sas" : "str", (string) 5-word SAS for verification "sas_numeric" : "str", (string) 6-digit numeric SAS "transport" : "str", (string, optional) Transport selected by bridge (websocket or tor) "relay_url" : "str" (string, optional) Relay URL used for websocket transport }

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

C++ symbol: cosign_join

Code samples

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

bitcoin-cli cosign.join "cosign:?r=abc...&t=ws#c=apple-banana-cherry-delta-echo"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "cosign.join", "params": ["cosign:?r=abc...#c=..."]}' -H 'content-type: application/json' http://127.0.0.1:8332/

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