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

Add RPC for "omni_sendtomany" and "omni_createpayload_sendtomany" #1248

Merged
merged 2 commits into from
Mar 24, 2022
Merged

Add RPC for "omni_sendtomany" and "omni_createpayload_sendtomany" #1248

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aac0313
Move RPC doc "omni_sendall" higher
dexX7 Dec 18, 2021
0f2e50b
Add RPC doc for "omni_sendtomany" and "omni_createpayload_sendtomany"
dexX7 Dec 18, 2021
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
109 changes: 81 additions & 28 deletions src/omnicore/doc/rpc-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ All available commands can be listed with `"help"`, and information about a spec

- [Transaction creation](#transaction-creation)
- [omni_send](#omni_send)
- [omni_sendall](#omni_sendall)
- [omni_sendtomany](#omni_sendtomany)
- [omni_sendnewdexorder](#omni_sendnewdexorder)
- [omni_sendupdatedexorder](#omni_sendupdatedexorder)
- [omni_sendcanceldexorder](#omni_sendcanceldexorder)
Expand All @@ -31,7 +33,6 @@ All available commands can be listed with `"help"`, and information about a spec
- [omni_sendcanceltradesbypair](#omni_sendcanceltradesbypair)
- [omni_sendcancelalltrades](#omni_sendcancelalltrades)
- [omni_sendchangeissuer](#omni_sendchangeissuer)
- [omni_sendall](#omni_sendall)
- [omni_sendenablefreezing](#omni_sendenablefreezing)
- [omni_senddisablefreezing](#omni_senddisablefreezing)
- [omni_sendfreeze](#omni_sendfreeze)
Expand Down Expand Up @@ -91,6 +92,7 @@ All available commands can be listed with `"help"`, and information about a spec
- [omni_createrawtx_change](#omni_createrawtx_change)
- [omni_createpayload_simplesend](#omni_createpayload_simplesend)
- [omni_createpayload_sendall](#omni_createpayload_sendall)
- [omni_createpayload_sendtomany](#omni_createpayload_sendtomany)
- [omni_createpayload_dexsell](#omni_createpayload_dexsell)
- [omni_createpayload_dexaccept](#omni_createpayload_dexaccept)
- [omni_createpayload_sto](#omni_createpayload_sto)
Expand Down Expand Up @@ -160,6 +162,58 @@ $ omnicore-cli "omni_send" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "37FaKponF7zqoML

---

### omni_sendall

Transfers all available tokens in the given ecosystem to the recipient.

**Arguments:**

| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `fromaddress` | string | required | the address to send from |
| `toaddress ` | string | required | the address of the receiver |
| `ecosystem` | number | required | the ecosystem of the tokens to send (`1` for main ecosystem, `2` for test ecosystem) |
| `redeemaddress` | string | optional | an address that can spend the transaction dust (sender by default) |
| `referenceamount` | string | optional | a bitcoin amount that is sent to the receiver (minimal by default) |

**Result:**
```js
"hash" // (string) the hex-encoded transaction hash
```

**Example:**

```bash
$ omnicore-cli "omni_sendall" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 2
```

---

### omni_sendtomany

Create and broadcast a send-to-many transaction, which allows to transfer tokens from one source to multiple receivers.

**Arguments:**

| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `fromaddress` | string | required | the address to send from |
| `propertyid` | number | required | the identifier of the tokens to send |
| `mapping` | array | required | an array with the receiving address "address" and the "amount" to send |

**Result:**
```js
"hash" // (string) the hex-encoded transaction hash
```

**Example:**

```bash
$ omnicore-cli "omni_sendtomany" 1 '[{"address": "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa", "amount": "10.5"}, {"address": "3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH", "amount": "0.5"}]'
```

---

### omni_senddexsell

Place, update or cancel a sell offer on the distributed token/BTC exchange.
Expand Down Expand Up @@ -670,33 +724,6 @@ $ omnicore-cli "omni_sendchangeissuer" \

---

### omni_sendall

Transfers all available tokens in the given ecosystem to the recipient.

**Arguments:**

| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `fromaddress` | string | required | the address to send from |
| `toaddress ` | string | required | the address of the receiver |
| `ecosystem` | number | required | the ecosystem of the tokens to send (`1` for main ecosystem, `2` for test ecosystem) |
| `redeemaddress` | string | optional | an address that can spend the transaction dust (sender by default) |
| `referenceamount` | string | optional | a bitcoin amount that is sent to the receiver (minimal by default) |

**Result:**
```js
"hash" // (string) the hex-encoded transaction hash
```

**Example:**

```bash
$ omnicore-cli "omni_sendall" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 2
```

---

### omni_sendenablefreezing

Enables address freezing for a centrally managed property.
Expand Down Expand Up @@ -2650,6 +2677,32 @@ $ omnicore-cli "omni_createpayload_sendall" 2

---

### omni_createpayload_sendtomany

Create the payload for a send-to-many transaction.

Note: if the server is not synchronized, amounts are considered as divisible, even if the token may have indivisible units!

**Arguments:**

| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `propertyid` | number | required | the identifier of the tokens to send |
| `mapping` | array | required | an array with output index "output" starting at 0 and the "amount" to send |

**Result:**
```js
"payload" // (string) the hex-encoded payload
```

**Example:**

```bash
$ omnicore-cli "omni_createpayload_sendtomany" 1 '[{"output": 2, "amount": "10.5"}, {"output": 3, "amount": "0.5"}, {"output": 5, "amount": "15.0"}]'
```

---

### omni_createpayload_dexsell

Create a payload to place, update or cancel a sell offer on the traditional distributed OMNI/BTC exchange.
Expand Down