Skip to content

Commit

Permalink
Update documentation for raw transaction related API
Browse files Browse the repository at this point in the history
  • Loading branch information
@dexX7
dexX7 committed Oct 28, 2015
1 parent ff2cf9e commit 7cdc952
Showing 1 changed file with 204 additions and 24 deletions.
228 changes: 204 additions & 24 deletions src/omnicore/doc/rpc-api.md
View file
Expand Up @@ -1251,6 +1251,42 @@ $ omnicore-cli "omni_gettradehistoryforaddress" "1MCHESTptvd2LnNp7wmr2sGTpRomteA

---

### omni_getactivations

Returns pending and completed feature activations.

**Result:**
```js
{
"pendingactivations": [ // (array of JSON objects) a list of pending feature activations
{
"featureid" : n, // (number) the id of the feature
"featurename" : "xxxxxxxx", // (string) the name of the feature
"activationblock" : n, // (number) the block the feature will be activated
"minimumversion" : n // (number) the minimum client version needed to support this feature
},
...
]
"completedactivations": [ // (array of JSON objects) a list of completed feature activations
{
"featureid" : n, // (number) the id of the feature
"featurename" : "xxxxxxxx", // (string) the name of the feature
"activationblock" : n, // (number) the block the feature will be activated
"minimumversion" : n // (number) the minimum client version needed to support this feature
},
...
]
}
```

**Example:**

```bash
$ omnicore-cli "omni_getactivations"
```

---

## Raw transactions

The RPCs for raw transactions can be used to decode or create raw Omni transactions.
Expand All @@ -1265,7 +1301,7 @@ If the inputs of the transaction are not in the chain, then they must be provide

| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `txhex` | string | required | the raw transaction to decode |
| `rawtx` | string | required | the raw transaction to decode |
| `prevtxs` | string | optional | a JSON array of transaction inputs (default: none) |

The format of `prevtxs` is as following:
Expand Down Expand Up @@ -1310,38 +1346,182 @@ $ omnicore-cli "omni_decodetransaction" "010000000163af14ce6d477e1c793507e32a5b7

---

### omni_getactivations
### omni_createrawtx_opreturn

Returns pending and completed feature activations.
Adds a payload with class C (op-return) encoding to the transaction.

If no raw transaction is provided, a new transaction is created.

If the data encoding fails, then the transaction is not modified.

**Arguments:**

| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `rawtx` | string | required | the raw transaction to extend (can be `null`) |
| `payload` | string | required | the hex-encoded payload to add |

**Result:**
```js
{
"pendingactivations": [ // (array of JSON objects) a list of pending feature activations
{
"featureid" : n, // (number) the id of the feature
"featurename" : "xxxxxxxx", // (string) the name of the feature
"activationblock" : n, // (number) the block the feature will be activated
"minimumversion" : n // (number) the minimum client version needed to support this feature
},
...
]
"completedactivations": [ // (array of JSON objects) a list of completed feature activations
{
"featureid" : n, // (number) the id of the feature
"featurename" : "xxxxxxxx", // (string) the name of the feature
"activationblock" : n, // (number) the block the feature will be activated
"minimumversion" : n // (number) the minimum client version needed to support this feature
},
...
]
}
"rawtx" // (string) the hex-encoded modified raw transaction
```

**Example:**

```bash
$ omnicore-cli "omni_getactivations"
$ omnicore-cli "omni_createrawtx_opreturn" "01000000000000000000" "00000000000000020000000006dac2c0"
```

---

### omni_createrawtx_multisig

Adds a payload with class B (bare-multisig) encoding to the transaction.

If no raw transaction is provided, a new transaction is created.

If the data encoding fails, then the transaction is not modified.

**Arguments:**

| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `rawtx` | string | required | the raw transaction to extend (can be `null`) |
| `payload` | string | required | the hex-encoded payload to add |
| `seed` | string | required | the seed for obfuscation |
| `payload` | string | required | a public key or address for dust redemption |

**Result:**
```js
"rawtx" // (string) the hex-encoded modified raw transaction
```

**Example:**

```bash
$ omnicore-cli "omni_createrawtx_multisig" \
"0100000001a7a9402ecd77f3c9f745793c9ec805bfa2e14b89877581c734c774864247e6f50400000000ffffffff01aa0a00000 \
00000001976a9146d18edfe073d53f84dd491dae1379f8fb0dfe5d488ac00000000" \
"00000000000000020000000000989680"
"1LifmeXYHeUe2qdKWBGVwfbUCMMrwYtoMm" \
"0252ce4bdd3ce38b4ebbc5a6e1343608230da508ff12d23d85b58c964204c4cef3"
```

---

### omni_createrawtx_input

Adds a transaction input to the transaction.

If no raw transaction is provided, a new transaction is created.

**Arguments:**

| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `rawtx` | string | required | the raw transaction to extend (can be `null`) |
| `txid` | string | required | the hash of the input transaction |
| `n` | number | required | the index of the transaction output used as input |

**Result:**
```js
"rawtx" // (string) the hex-encoded modified raw transaction
```

**Example:**

```bash
$ omnicore-cli "omni_createrawtx_input" \
"01000000000000000000" "b006729017df05eda586df9ad3f8ccfee5be340aadf88155b784d1fc0e8342ee" 0
```

---

### omni_createrawtx_reference

Adds a reference output to the transaction.

If no raw transaction is provided, a new transaction is created.

The output value is set to at least the dust threshold.

**Arguments:**

| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `rawtx` | string | required | the raw transaction to extend (can be `null`) |
| `destination` | string | required | the reference address or destination |
| `amount` | number | optional | the optional reference amount (minimal by default) |

**Result:**
```js
"rawtx" // (string) the hex-encoded modified raw transaction
```

**Example:**

```bash
$ omnicore-cli "omni_createrawtx_reference" \
"0100000001a7a9402ecd77f3c9f745793c9ec805bfa2e14b89877581c734c774864247e6f50400000000ffffffff03aa0a00000
00000001976a9146d18edfe073d53f84dd491dae1379f8fb0dfe5d488ac5c0d0000000000004751210252ce4bdd3ce38b4ebbc5a
6e1343608230da508ff12d23d85b58c964204c4cef3210294cc195fc096f87d0f813a337ae7e5f961b1c8a18f1f8604a909b3a51
21f065b52aeaa0a0000000000001976a914946cb2e08075bcbaf157e47bcb67eb2b2339d24288ac00000000" \
"1CE8bBr1dYZRMnpmyYsFEoexa1YoPz2mfB" \
0.005
```

---

### omni_createrawtx_change

Adds a change output to the transaction.

The provided inputs are not added to the transaction, but only used to determine the change. It is assumed that the inputs were previously added, for example via `"createrawtransaction"`.

Optionally a position can be provided, where the change output should be inserted, starting with `0`. If the number of outputs is smaller than the position, then the change output is added to the end. Change outputs should be inserted before reference outputs, and as per default, the change output is added to the`first position.

If the change amount would be considered as dust, then no change output is added.

**Arguments:**

| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `rawtx` | string | required | the raw transaction to extend |
| `prevtxs` | string | required | a JSON array of transaction inputs |
| `destination` | string | required | the destination for the change |
| `fee` | number | required | the desired transaction fees |
| `position` | number | optional | the position of the change output (default: first position) |

The format of `prevtxs` is as following:

```js
[
{
"txid" : "hash", // (string, required) the transaction hash
"vout" : n, // (number, required) the output number
"scriptPubKey" : "hex", // (string, required) the output script
"value" : n.nnnnnnnn // (number, required) the output value
}
,...
]
```

**Result:**
```js
"rawtx" // (string) the hex-encoded modified raw transaction
```

**Example:**

```bash
$ omnicore-cli "omni_createrawtx_change" \
"0100000001b15ee60431ef57ec682790dec5a3c0d83a0c360633ea8308fbf6d5fc10a779670400000000ffffffff025c0d00000 \
000000047512102f3e471222bb57a7d416c82bf81c627bfcd2bdc47f36e763ae69935bba4601ece21021580b888ff56feb27f17f \
08802ebed26258c23697d6a462d43fc13b565fda2dd52aeaa0a0000000000001976a914946cb2e08075bcbaf157e47bcb67eb2b2 \
339d24288ac00000000" \
"[{\"txid\":\"6779a710fcd5f6fb0883ea3306360c3ad8c0a3c5de902768ec57ef3104e65eb1\",\"vout\":4, \
\"scriptPubKey\":\"76a9147b25205fd98d462880a3e5b0541235831ae959e588ac\",\"value\":0.00068257}]" \
"1CE8bBr1dYZRMnpmyYsFEoexa1YoPz2mfB" 0.000035 1
```

---
Expand Down

0 comments on commit 7cdc952

Please sign in to comment.