Skip to content

Commit 81557f7

Browse files
Merge branch 'devin/1756395382-update-stacks-rpc-docs' of https://git-manager.devin.ai/proxy/github.com/reown-com/reown-docs into devin/1756395382-update-stacks-rpc-docs
2 parents aa5209d + 4a9ae21 commit 81557f7

File tree

1 file changed

+23
-25
lines changed

1 file changed

+23
-25
lines changed

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

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Transfer STX.
5757
"jsonrpc": "2.0",
5858
"method": "stx_transferStx",
5959
"params": {
60+
"sender": "SP3F7GQ48JY59521DZEE6KABHBF4Q33PEYJ823ZXQ",
6061
"recipient": "SP3F7GQ48JY59521DZEE6KABHBF4Q33PEYJ823ZXQ",
6162
"amount": "100000000000",
6263
"memo": "",
@@ -69,10 +70,11 @@ Transfer STX.
6970

7071
| Parameter | Required? | Data Type | Description |
7172
|-----------|------|-----------|-------------|
73+
| `sender` | Required | `string` | The stacks address of sender (required for multi-account scenarios) |
7274
| `recipient` | Required | `string` | Stacks address |
7375
| `amount` | Required | `string` | micro-STX (uSTX) |
7476
| `memo` | Optional | `string` | Memo string to be included with the transfer transaction |
75-
| `network` | Optional | `string` | "mainnet" \| "testnet" \| "devnet" |
77+
| `network` | Optional | `string` | "mainnet" \| "testnet" \| "devnet" (note: redundant since chainId is provided) |
7678

7779
#### Response
7880

@@ -142,9 +144,11 @@ Sign arbitrary message; supports structured (SIP-018).
142144
"jsonrpc": "2.0",
143145
"method": "stx_signMessage",
144146
"params": {
147+
"address": "SP3F7GQ48JY59521DZEE6KABHBF4Q33PEYJ823ZXQ",
145148
"message": "message",
146149
"messageType": "utf8",
147-
"network": "mainnet"
150+
"network": "mainnet",
151+
"domain": "example.com"
148152
}
149153
}
150154
```
@@ -153,10 +157,11 @@ Sign arbitrary message; supports structured (SIP-018).
153157

154158
| Parameter | Required? | Data Type | Description |
155159
|-----------|------|-----------|-------------|
156-
| `message` | Required | `string` | message to be signed |
157-
| `messageType` | Optional | `string` | "utf8" \| "structured" (default utf8) |
158-
| `domain` | Optional | `any` | required if structured |
159-
| `network` | Optional | `string` | "mainnet" \| "testnet" \| "devnet" |
160+
| `address` | Required | `string` | The stacks address of sender |
161+
| `message` | Required | `string` | Utf-8 string representing the message to be signed by the wallet |
162+
| `messageType` | Optional | `string` | Type of message for signing: `utf8` for basic string or `structured` for structured data |
163+
| `network` | Optional | `string` | Network for signing: `mainnet`, `testnet`, `signet`, `devnet` (note: redundant since chainId is provided) |
164+
| `domain` | Optional | `string` | Domain tuple per SIP-018 (for structured messages only) |
160165

161166
#### Response
162167

@@ -212,7 +217,7 @@ Domain-bound structured signing (SIP-018).
212217

213218
### stx_callContract
214219

215-
Build, sign, and optionally broadcast a contract call.
220+
Wrapper method for `stx_signTransaction` that calls a Stacks contract.
216221

217222
#### Request
218223

@@ -222,14 +227,9 @@ Build, sign, and optionally broadcast a contract call.
222227
"jsonrpc": "2.0",
223228
"method": "stx_callContract",
224229
"params": {
225-
"contract": "SP000000000000000000002Q6VF78.pox",
226-
"functionName": "stack-stx",
227-
"functionArgs": ["u1000000", "0x…"],
228-
"network": "mainnet",
229-
"fee": "1000",
230-
"nonce": "1",
231-
"anchorMode": "any",
232-
"broadcast": true
230+
"contract": "SP3F7GQ48JY59521DZEE6KABHBF4Q33PEYJ823ZXQ.my-contract",
231+
"functionName": "get-balance",
232+
"functionArgs": []
233233
}
234234
}
235235
```
@@ -238,14 +238,9 @@ Build, sign, and optionally broadcast a contract call.
238238

239239
| Parameter | Required? | Data Type | Description |
240240
|-----------|------|-----------|-------------|
241-
| `contract` | Required | `string` | contract identifier |
242-
| `functionName` | Required | `string` | function name to call |
243-
| `functionArgs` | Required | `string[]` | function arguments |
244-
| `network` | Optional | `string` | "mainnet" \| "testnet" \| "devnet" |
245-
| `fee` | Optional | `string` | transaction fee |
246-
| `nonce` | Optional | `string` | transaction nonce |
247-
| `anchorMode` | Optional | `string` | "any" \| "onChainOnly" \| "offChainOnly" |
248-
| `broadcast` | Optional | `boolean` | whether to broadcast the transaction |
241+
| `contract` | Required | `string` | Fully qualified contract identifier, including Stacks address and contract name |
242+
| `functionName` | Required | `string` | Name of the function to call |
243+
| `functionArgs` | Required | `string[]` | Arguments to pass to the contract function, encoded as strings |
249244

250245
#### Response
251246

@@ -254,8 +249,11 @@ Build, sign, and optionally broadcast a contract call.
254249
"jsonrpc": "2.0",
255250
"id": 1,
256251
"result": {
257-
"txid": "0x…",
258-
"transaction": "0x…"
252+
"txid": "stack_tx_id",
253+
"transaction": "raw_tx_hex"
259254
}
260255
}
261256
```
257+
258+
- `txid` - is used to identify the transaction on the explorer
259+
- `transaction` - hex-encoded raw transaction

0 commit comments

Comments
 (0)