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.

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

Remove removed/virtual ops from documentation #386

Merged
merged 3 commits into from
Sep 26, 2024
Merged
Changes from all commits
Commits
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
65 changes: 0 additions & 65 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1784,13 +1784,6 @@ steem.broadcast.accountWitnessVote(wif, account, witness, approve, function(err,
});
```
- - - - - - - - - - - - - - - - - -
### Challenge Authority
```js
steem.broadcast.challengeAuthority(wif, challenger, challenged, requireOwner, function(err, result) {
console.log(err, result);
});
```
- - - - - - - - - - - - - - - - - -
### Change Recovery Account
```js
steem.broadcast.changeRecoveryAccount(wif, accountToRecover, newRecoveryAccount, extensions, function(err, result) {
Expand Down Expand Up @@ -1819,27 +1812,13 @@ steem.broadcast.commentPayout(wif, author, permlink, payout, function(err, resul
});
```
- - - - - - - - - - - - - - - - - -
### Comment Reward
```js
steem.broadcast.commentReward(wif, author, permlink, sbdPayout, vestingPayout, function(err, result) {
console.log(err, result);
});
```
- - - - - - - - - - - - - - - - - -
### Convert
```js
steem.broadcast.convert(wif, owner, requestid, amount, function(err, result) {
console.log(err, result);
});
```
- - - - - - - - - - - - - - - - - -
### Curate Reward
```js
steem.broadcast.curateReward(wif, curator, reward, commentAuthor, commentPermlink, function(err, result) {
console.log(err, result);
});
```
- - - - - - - - - - - - - - - - - -
### Custom
```js
steem.broadcast.custom(wif, requiredAuths, id, data, function(err, result) {
Expand Down Expand Up @@ -1915,13 +1894,6 @@ steem.broadcast.feedPublish(wif, publisher, exchangeRate, function(err, result)
});
```
- - - - - - - - - - - - - - - - - -
### Pow2
```js
steem.broadcast.pow2(wif, work, newOwnerKey, props, function(err, result) {
console.log(err, result);
});
```
- - - - - - - - - - - - - - - - - -
### Fill Convert Request
```js
steem.broadcast.fillConvertRequest(wif, owner, requestid, amountIn, amountOut, function(err, result) {
Expand Down Expand Up @@ -2037,43 +2009,6 @@ steem.broadcast.limitOrderCreate2(wif, owner, orderid, amountToSell, exchangeRat
console.log(err, result);
});
```

|Parameter|Description|Datatype|Notes|
|---|---|---|---|
|wif|Active private key|String||
|owner|Account name|String|No leading @ symbol|
|orderid|User defined order identifier|Integer|Used to cancel orders|
|amountToSell|Amount to sell|String|"X.XXX ASSET" must have 3 decimal places. e.g. "25.100 SBD"|
|exchangeRate|The exchange rate|Integer|`amountToSell` is multiplied by the `exchangeRate` to have the same effect as `minToReceive`|
|fillOrKill|Fill order from current order book or kill the order|Boolean|`false` places the order into the Order Book until either canceled, filled, or the expiration time is reached|
|expiration|Time when order expires|Integer|Unit milliseconds. Zero is UNIX epoch|
|function()|Your callback|function||


See also: [getOrderBook](#get-order-book), [getOpenOrders](#get-open-orders), [limitOrderCancel](#limit-order-cancel), [limitOrderCreate](#limit-order-create2)


- - - - - - - - - - - - - - - - - -
### Liquidity Reward
```js
steem.broadcast.liquidityReward(wif, owner, payout, function(err, result) {
console.log(err, result);
});
```
- - - - - - - - - - - - - - - - - -
### Pow
```js
steem.broadcast.pow(wif, worker, input, signature, work, function(err, result) {
console.log(err, result);
});
```
- - - - - - - - - - - - - - - - - -
### Prove Authority
```js
steem.broadcast.proveAuthority(wif, challenged, requireOwner, function(err, result) {
console.log(err, result);
});
```
- - - - - - - - - - - - - - - - - -
### Recover Account
```js
Expand Down
Loading