Skip to content

Start forging API #1

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

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

Start forging API #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6791dcc
Start forging API
mrv777 Aug 2, 2018
4ca3b0b
Quotation Corrections
mrv777 Aug 2, 2018
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
41 changes: 21 additions & 20 deletions source/includes/forging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,19 @@ The API calls below allow you to
> The request:

```shell
curl "http://localhost:27876/nxt?requestType="
curl -k -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "secretPhrase=INSERT PASSPHRASE HERE&period=1440&recipient=ARDOR-8MVA-XCVR-3JC9-2C7C3" "http://localhost:27876/nxt?requestType=leaseBalance"
```

```javascript
// The ardor-blockchain npm package is still on deployement stage
var ardor = require('ardor-blockchain');

var data = {

secretPhrase=INSERT PASSPHRASE HERE,
period: "1440",
recipient: "ARDOR-8MVA-XCVR-3JC9-2C7C3",
};
ardor.sendRequest("", data, function (response) {
ardor.sendRequest("leaseBalance", data, function (response) {
ardor.logConsole(JSON.stringify(response));
});
```
Expand All @@ -33,30 +35,33 @@ ardor.sendRequest("", data, function (response) {

Call Description

`GET http://localhost:27876/nxt?requestType=`
`POST http://localhost:27876/nxt?requestType=leaseBalance&period=<Period>&recipient=<Recipient>`

Parameter | Type | Description
--------- | ---- | -----------
<%= getParameter('', '', '') %>
<%= getParameter('', '', '') %>
<%= getParameter('', '', '') %>
<%= getParameter('secretPhrase', 'required', 'The secret passphrase of the account') %>
<%= getParameter('feeNQT', 'optional', 'Fee (in NQT) for the transaction. Auto calculated if left blank') %>
<%= getParameter('deadline', 'optional', 'Deadline (in minutes) for the transaction to be confirmed, 32767 minutes maximum and 1440 is the default of parent chain, 15 for child chains') %>
<%= getParameter('period', 'required', 'The lease period (in number of blocks, 1440 minimum)') %>
<%= getParameter('recipient', 'required', '') %>
<%= getParameter('recipientPublicKey', 'optional, enhances security of a new account', '') %>


### startForging
> The request:

```shell
curl "http://localhost:27876/nxt?requestType="
curl -k -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "secretPhrase=INSERT PASSPHRASE HERE "http://localhost:27876/nxt?requestType=startForging"
```

```javascript
// The ardor-blockchain npm package is still on deployement stage
var ardor = require('ardor-blockchain');

var data = {

secretPhrase: "INSERT PASSPHRASE HERE",
};
ardor.sendRequest("", data, function (response) {
ardor.sendRequest("startForging", data, function (response) {
ardor.logConsole(JSON.stringify(response));
});
```
Expand All @@ -70,28 +75,26 @@ ardor.sendRequest("", data, function (response) {

Call Description

`GET http://localhost:27876/nxt?requestType=`
`POST http://localhost:27876/nxt?requestType=startForging`

Parameter | Type | Description
--------- | ---- | -----------
<%= getParameter('', '', '') %>
<%= getParameter('', '', '') %>
<%= getParameter('', '', '') %>
<%= getParameter('secretPhrase', 'required', 'The secret passphrase of the account') %>


### stopForging
> The request:

```shell
curl "http://localhost:27876/nxt?requestType="
curl -k -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "secretPhrase=INSERT PASSPHRASE HERE" "http://localhost:27876/nxt?requestType=stopForging"
```

```javascript
// The ardor-blockchain npm package is still on deployement stage
var ardor = require('ardor-blockchain');

var data = {

secretPhrase: "INSERT PASSPHRASE HERE",
};
ardor.sendRequest("", data, function (response) {
ardor.logConsole(JSON.stringify(response));
Expand All @@ -107,13 +110,11 @@ ardor.sendRequest("", data, function (response) {

Call Description

`GET http://localhost:27876/nxt?requestType=`
`POST http://localhost:27876/nxt?requestType=stopForging`

Parameter | Type | Description
--------- | ---- | -----------
<%= getParameter('', '', '') %>
<%= getParameter('', '', '') %>
<%= getParameter('', '', '') %>
<%= getParameter('secretPhrase', 'required', 'The secret passphrase of the account') %>


### startBundler
Expand Down