Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update API_REFERENCE.md #9

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update API_REFERENCE.md #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc9dc62
Update API_REFERENCE.md
abdulhaseeb4239 Feb 8, 2023
c201d94
Merge branch 'master' into docs-update
yknl Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 45 additions & 9 deletions docs/API_REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,20 +50,20 @@ Custom nonce to set for the transaction. Default value is the next nonce for the

Version of parameter format.

`sponsored` _optional_ - boolean\
\
to create a sponsored transaction
`sponsored` _optional_ - boolean

Create a sponsored transaction

### Example:

```javascript
const result = await client.request({
chainId: "stacks:1",
chainId: "stacks:1",
topic: session.topic, // Get this from the session approval
request: {
method: "stacks_contractCall",
params: {
pubkey: address,
pubkey: address,
postConditions,
contractAddress: "SP1H1733V5MZ3SZ9XRW9FKYGEZT0JDGEB8Y634C7R",
contractName: "my_contract_name",
Expand Down Expand Up @@ -131,7 +131,7 @@ const result = await client.request({
request: {
method: "stacks_stxTransfer",
params: {
pubkey: address,
pubkey: address,
recipient: "SP3F7GQ48JY59521DZEE6KABHBF4Q33PEYJ823ZXQ",
amount: BigInt(1000),
},
Expand Down Expand Up @@ -287,16 +287,16 @@ const codeBody = `
;; hello-world
(define-read-only (echo-number (val int)) (ok val))
(define-public (say-hi) (ok "hello world"))
`
`;

const result = await client.request({
chainId: chain,
topic: session.topic,
request: {
method: "stacks_contractDeploy",
params: {
pubkey: address,
contractName: "my_contract_name_1",
pubkey: address,
contractName: "my_contract_name_1",
codeBody: codeBody,
postConditionMode: PostConditionMode.Allow,
},
Expand All @@ -305,3 +305,39 @@ const result = await client.request({

const txId = result.txId;
```

## BTC Transfer

### Method:

`bitcoin_btcTransfer`

Request a bitcoin transfer transaction with multiple recipients support

### Parameters:

**`pubkey`** _required_ - `string`

The stacks address of sender.

**`recipients`** _required_ - `Array<Recipients>`

Array of recipients containing BTC address and amount in sats

### Example:

```javascript
const result = await client.request({
chainId: chain,
topic: session.topic,
request: {
method: "bitcoin_btcTransfer",
params: {
pubkey: address, //XXX: This one is required
recipients,
},
},
});

const txId = result.txId;
```