Merge pull request #607 from reown-com/devin/1756395382-update-stacks-rpc-docs

Update Stacks RPC documentation with 6 new methods

Author: rohit-710

advanced/multichain/rpc-reference/stacks-rpc.mdx

@@ -6,11 +6,51 @@ description: Stacks JSON-RPC Methods
 
 These are the methods that wallets should implement to handle Stacks transfers and messages via WalletConnect.
 
-## stx_transferStx
+## Core Methods (common)
 
-Simple STX transfer, request a transfer of STX tokens. Wallet signs and executes the transaction.
+### stx_getAddresses
 
-### Request
+Retrieve active account addresses; primarily Stacks-focused.
+
+#### Request
+
+```json
+{
+  "id": 1,
+  "jsonrpc": "2.0",
+  "method": "stx_getAddresses",
+  "params": {}
+}
+```
+
+#### Response
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": {
+    "addresses": [
+      {
+        "symbol": "STX",
+        "address": "SP…"
+      }
+    ]
+  }
+}
+```
+
+**Notes:**
+- Use this first to select the wallet's active address.
+- Filter on `symbol: "STX"` or by address prefix (SP for mainnet, ST for testnet).
+
+## Stacks Methods
+
+### stx_transferStx
+
+Transfer STX.
+
+#### Request
 
 ```json
 {
@@ -21,41 +61,83 @@ Simple STX transfer, request a transfer of STX tokens. Wallet signs and executes
     "sender": "SP3F7GQ48JY59521DZEE6KABHBF4Q33PEYJ823ZXQ",
     "recipient": "SP3F7GQ48JY59521DZEE6KABHBF4Q33PEYJ823ZXQ",
     "amount": "100000000000",
-    "memo": ""
+    "memo": "",
+    "network": "mainnet"
   }
 }
 ```
 
-### Parameters
+#### Parameters
 
 | Parameter | Required? | Data Type | Description |
 |-----------|------|-----------|-------------|
-| `sender` | Required | `string` | The stacks address of sender |
-| `recipient` | Required | `string` | The STX address of the recipient |
-| `amount` | Required | `number \| string` | Amount of STX tokens to transfer in microstacks (BigInt constructor compatible) |
+| `sender` | Required | `string` | The stacks address of sender (required for multi-account scenarios) |
+| `recipient` | Required | `string` | Stacks address |
+| `amount` | Required | `string` | micro-STX (uSTX) |
 | `memo` | Optional | `string` | Memo string to be included with the transfer transaction |
+| `network` | Optional | `string` | "mainnet" \| "testnet" \| "devnet" |
 
-### Response
+#### Response
 
 ```json
 {
   "jsonrpc": "2.0",
   "id": 1,
   "result": {
-    "txid": "stack_tx_id",
-    "transaction": "raw_tx_hex"
+    "txid": "1234567890abcdef1234567890abcdef12345678",
+    "transaction": "0x…"
   }
 }
 ```
 
-- `txid` - is used to identify the transaction on the explorer
-- `transaction` - hex-encoded raw transaction
+### stx_signTransaction
 
-## stx_signMessage
+Sign a Stacks transaction. Optional broadcast.
 
-For signing a message with wallet users private key.
+#### Request
 
-### Request
+```json
+{
+  "id": 1,
+  "jsonrpc": "2.0",
+  "method": "stx_signTransaction",
+  "params": {
+    "transaction": "0x…",
+    "broadcast": false,
+    "network": "mainnet"
+  }
+}
+```
+
+#### Parameters
+
+| Parameter | Required? | Data Type | Description |
+|-----------|------|-----------|-------------|
+| `transaction` | Required | `string` | hex transaction |
+| `broadcast` | Optional | `boolean` | default false |
+| `network` | Optional | `string` | "mainnet" \| "testnet" \| "devnet" |
+
+#### Response
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": {
+    "signature": "0x…",
+    "transaction": "0x…",
+    "txid": "1234567890abcdef1234567890abcdef12345678"
+  }
+}
+```
+
+**Note:** `txid` is present if broadcast=true
+
+### stx_signMessage
+
+Sign arbitrary message; supports structured (SIP-018).
+
+#### Request
 
 ```json
 {
@@ -64,67 +146,119 @@ For signing a message with wallet users private key.
   "method": "stx_signMessage",
   "params": {
     "address": "SP3F7GQ48JY59521DZEE6KABHBF4Q33PEYJ823ZXQ",
-    "message": "message"
+    "message": "message",
+    "messageType": "utf8",
+    "network": "mainnet",
+    "domain": "example.com"
   }
 }
 ```
 
-### Parameters
+#### Parameters
 
 | Parameter | Required? | Data Type | Description |
 |-----------|------|-----------|-------------|
 | `address` | Required | `string` | The stacks address of sender |
 | `message` | Required | `string` | Utf-8 string representing the message to be signed by the wallet |
+| `messageType` | Optional | `string` | Type of message for signing: `utf8` for basic string or `structured` for structured data |
+| `network` | Optional | `string` | Network for signing: `mainnet`, `testnet`, `signet`, `devnet` (note: redundant since chainId is provided) |
+| `domain` | Optional | `string` | Domain tuple per SIP-018 (for structured messages only) |
 
-### Response
+#### Response
 
 ```json
 {
   "jsonrpc": "2.0",
   "id": 1,
   "result": {
-    "signature": "0x1234..."
+    "signature": "0x…"
   }
 }
 ```
 
-- `signature` - The signature of the message
+### stx_signStructuredMessage
+
+Domain-bound structured signing (SIP-018).
+
+#### Request
+
+```json
+{
+  "id": 1,
+  "jsonrpc": "2.0",
+  "method": "stx_signStructuredMessage",
+  "params": {
+    "message": "message",
+    "domain": "domain"
+  }
+}
+```
+
+#### Parameters
+
+| Parameter | Required? | Data Type | Description |
+|-----------|------|-----------|-------------|
+| `message` | Required | `string \| object` | message to be signed |
+| `domain` | Required | `string \| object` | domain for structured signing |
 
+#### Response
 
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": {
+    "signature": "0x…",
+    "publicKey": "0x04…"
+  }
+}
+```
 
+**Note:** `publicKey` is optional
 
-## stx_getAddresses
+### stx_callContract
 
-For requesting the wallet addresses
+Wrapper method for `stx_signTransaction` that calls a Stacks contract.
 
-### Request
+#### Request
 
 ```json
 {
   "id": 1,
   "jsonrpc": "2.0",
-  "method": "stx_getAddresses",
+  "method": "stx_callContract",
+  "params": {
+    "contract": "SP3F7GQ48JY59521DZEE6KABHBF4Q33PEYJ823ZXQ.my-contract",
+    "functionName": "get-balance",
+    "functionArgs": []
+  }
 }
 ```
 
-### Response
+#### Parameters
+
+| Parameter | Required? | Data Type | Description |
+|-----------|------|-----------|-------------|
+| `contract` | Required | `string` | Fully qualified contract identifier, including Stacks address and contract name |
+| `functionName` | Required | `string` | Name of the function to call |
+| `functionArgs` | Required | `string[]` | Arguments to pass to the contract function, encoded as strings |
+
+#### Response
+
 ```json
 {
   "jsonrpc": "2.0",
   "id": 1,
   "result": {
-    "accounts": [
-      { 
-        "address": "SP23....",
-        "publicKey": "ab12031..."
-      }
-    ]
+    "txid": "stack_tx_id",
+    "transaction": "raw_tx_hex"
   }
 }
 ```
 
-- `accounts`: The connected accounts with their address and publicKey
+- `txid` - is used to identify the transaction on the explorer
+- `transaction` - hex-encoded raw transaction
 
+## Session Properties
 
-### Session Properties
-In a connection request, it is recommended to serialize the response to `getAddresses` in `session.sessionProperties.stacks_getAddresses`. This allows dapps to consume an active session without requiring a context switch to re-request all addresses and associated public keys from the wallet.
+In a connection request, it is recommended to serialize the response to `stx_getAddresses` in `session.sessionProperties.stacks_getAddresses`. This allows dapps to consume an active session without requiring a context switch to re-request all addresses and associated public keys from the wallet.