Producer API (1.0.0)

Download OpenAPI specification:Download

URL: https://wire.network License: MIT

pause

Pause producer node

Authorizations:

None

Request Body schema: application/json

object

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"result": "ok"
}

resume

Resume producer node

Authorizations:

None

Request Body schema: application/json

object

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"result": "ok"
}

paused

Retreives paused status for producer node

Authorizations:

None

Request Body schema: application/json

object

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{ }

Response samples

200

Content type

application/json

true

get_runtime_options

Retreives run time options for producer node

Authorizations:

None

Request Body schema: application/json

object

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"max_transaction_time": 200,
"max_irreversible_block_age": -1,
"produce_time_offset_us": -100000,
"last_block_time_offset_us": -200000,
"max_scheduled_transaction_time_per_block_ms": 100,
"incoming_defer_ratio": "1.00000000000000000",
"greylist_limit": 1000
}

update_runtime_options

Update run time options for producer node

Authorizations:

None

Request Body schema: application/json

required

object

Defines the run time options to set for the producer

max_transaction_time	integer Max transaction time
max_irreversible_block_age	integer Max irreversible block age
produce_time_offset_us	integer Time offset
last_block_time_offset_us	integer Last block time offset
max_scheduled_transaction_time_per_block_ms	integer Max scheduled transaction time per block in ms
subjective_cpu_leeway_us	integer Subjective CPU leeway
incoming_defer_ratio	integer Incoming defer ration

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{"options": {"max_transaction_time": 100,
"max_irreversible_block_age": -1,
"produce_time_offset_us": -100000,
"last_block_time_offset_us": -200000,
"max_scheduled_transaction_time_per_block_ms": 100,
"subjective_cpu_leeway_us": 10,
"incoming_defer_ratio": 1
}
}

Response samples

200

Content type

application/json

{"result": "ok"
}

get_greylist

Retreives the greylist for producer node

Authorizations:

None

Request Body schema: application/json

object

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"accounts": [ ]
}

add_greylist_accounts

Adds accounts to grey list for producer node

Authorizations:

None

Request Body schema: application/json

required

object

	Array of NamePrivileged (string) or NameBasic (string) or NameBid (string) or NameCatchAll (string) (Name) List of account names to add
Array Any of string (NamePrivileged) ^(sysio[\.][a-z1-5]{1,6})([a-j]{1})?$ String representation of privileged name type

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{"accounts": ["alice",
"bob"
]
}

Response samples

200

Content type

application/json

null

remove_greylist_accounts

Removes accounts from greylist for producer node.At least one account is required.

Authorizations:

None

Request Body schema: application/json

required

object

	Array of NamePrivileged (string) or NameBasic (string) or NameBid (string) or NameCatchAll (string) (Name) List of account names to remove
Array Any of string (NamePrivileged) ^(sysio[\.][a-z1-5]{1,6})([a-j]{1})?$ String representation of privileged name type

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{"accounts": ["alice"
]
}

Response samples

200

Content type

application/json

{"result": "ok"
}

get_whitelist_blacklist

Retrieves the whitelist and blacklist for producer node. A JSON object containing whitelist and blacklist information.

Authorizations:

None

Request Body schema: application/json

object

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"actor_whitelist": ["bob"
],
"actor_blacklist": [ ],
"contract_whitelist": [ ],
"contract_blacklist": [ ],
"action_blacklist": [ ],
"key_blacklist": [ ]
}

set_whitelist_blacklist

Sets the white list and black list for producer node

Authorizations:

None

Request Body schema: application/json

required

object

Defines the actor whitelist and blacklist, the contract whitelist and blacklist, the action blacklist and key blacklist

	Array of NamePrivileged (string) or NameBasic (string) or NameBid (string) or NameCatchAll (string) (Name)
	Array of NamePrivileged (string) or NameBasic (string) or NameBid (string) or NameCatchAll (string) (Name)
	Array of NamePrivileged (string) or NameBasic (string) or NameBid (string) or NameCatchAll (string) (Name)
	Array of NamePrivileged (string) or NameBasic (string) or NameBid (string) or NameCatchAll (string) (Name)
	Array of NamePrivileged (string) or NameBasic (string) or NameBid (string) or NameCatchAll (string) (Name) [ items[^([a-z1-9]{1}[a-z1-9_]{0,30}[a-z1-9]{1})$] ]
key_blacklist	Array of strings (KeyType) Items Enum: "uint64" "double"

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{"actor_whitelist": ["bob"
],
"actor_blacklist": [ ],
"contract_whitelist": [ ],
"contract_blacklist": [ ],
"action_blacklist": [ ],
"key_blacklist": [ ]
}

Response samples

200

Content type

application/json

{"result": "ok"
}

create_snapshot

Creates a snapshot for producer node

Authorizations:

None

Responses

Request samples

cURL
Node.js
Python

curl -X POST "http://localhost:8887/v1/producer/create_snapshot" \
  -H "Content-Type: application/json"

Response samples

200

Content type

application/json

null

schedule_snapshot

Submits a request to automatically generate snapshots according to a schedule specified with given parameters. If request body is empty, schedules immediate snapshot generation. Returns error when unable to accept schedule.

Authorizations:

None

Request Body schema: application/json

block_spacing	integer Generate snapshot every block_spacing blocks
start_block_num	integer Block number at which schedule starts
end_block_num	integer Block number at which schedule ends
snapshot_description	string Description of the snapshot

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{"block_spacing": 0,
"start_block_num": 5102,
"end_block_num": 15102,
"snapshot_description": "Daily snapshot"
}

Response samples

201
400

Content type

application/json

{"snapshot_request_id": 0,
"block_spacing": 0,
"start_block_num": 5102,
"end_block_num": 15102,
"snapshot_description": "Daily snapshot"
}

unschedule_snapshot

Removes snapshot request identified by id. Returns error if the referenced snapshot request does not exist.

Authorizations:

None

Request Body schema: application/json
required

snapshot_request_id

integer

The unique ID of the snapshot request to remove.

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{"snapshot_request_id": 0
}

Response samples

201
400

Content type

application/json

{"snapshot_request_id": 0,
"block_spacing": 0,
"start_block_num": 5102,
"end_block_num": 15102,
"snapshot_description": "Daily snapshot"
}

get_snapshot_requests

Returns a list of scheduled snapshots.

Authorizations:

None

Responses

Request samples

cURL
Node.js
Python

curl -X POST "http://localhost:8887/v1/producer/get_snapshot_requests" \
  -H "Content-Type: application/json"

Response samples

201
400

Content type

application/json

{"snapshot_requests": [{"snapshot_request_id": 0,
"block_spacing": 0,
"start_block_num": 5102,
"end_block_num": 15102,
"snapshot_description": "Daily snapshot",
"pending_snapshots": [{"head_block_id": "string",
"head_block_num": 5102,
"head_block_time": "2020-11-16T00:00:00.000",
"version": 6,
"snapshot_name": "/home/me/nodes/node-name/snapshots/snapshot-0000999f99999f9f999f99f99ff9999f999f9fff99ff99ffff9f9f9fff9f9999.bin"
}
]
}
]
}

get_integrity_hash

Retreives the integrity hash for producer node

Authorizations:

None

Request Body schema: application/json

object

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{ }

Response samples

201
400

Content type

application/json

{"head_block_id": "0005857b77cc98941c6caa90fa8a083d2b1f4416ac015a107e04ed06774cce94",
"integrity_hash": "ac2a27f3b40ff252c2450341d2e4f8dbc1f83949103b83d8569c4292b265b224"
}

schedule_protocol_feature_activations

Schedule protocol feature activation for producer node

Authorizations:

None

Request Body schema: application/json

required

object

protocol_features_to_activate

Array of strings (Sha256) [^[0-9A-Fa-f]{64}$]

List of protocol features to activate

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{"schedule": {"protocol_features_to_activate": ["ABCDEF123456..."
]
}
}

Response samples

200

Content type

application/json

null

get_supported_protocol_features

Retreives supported protocol features for producer node

Authorizations:

None

Request Body schema: application/json

required

object

Defines filters based on which to return the supported protocol features

exclude_disabled	boolean Exclude disabled protocol features
exclude_unactivatable	boolean Exclude unactivatable protocol features

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{"params": {"exclude_disabled": false,
"exclude_unactivatable": false
}
}

Response samples

200

Content type

application/json

["string"
]

get_account_ram_corrections

Retrieves accounts with ram corrections.

Authorizations:

None

Request Body schema: application/json

lower_bound	integer lowest account key
upper_bound	integer highest account key
limit	integer Default: 10 number of rows to scan
reverse	boolean Default: false direction of search

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{"lower_bound": 0,
"upper_bound": 0,
"limit": 10,
"reverse": false
}

Response samples

201
400

Content type

application/json

{"rows": ["string"
],
"more": ["string"
]
}

get_unapplied_transactions

Get Unapplied Transactions.

Authorizations:

None

Request Body schema: application/json

limit	integer Default: 100 limit number of transactions to return
lower_bound	string (Sha256) ^[0-9A-Fa-f]{64}$
time_limit_ms	integer Default: "http-max-response-time-ms"

Responses

Request samples

Payload
cURL
Node.js
Python

Content type

application/json

{"limit": 100,
"lower_bound": "string",
"time_limit_ms": 10
}

Response samples

200
400

Content type

application/json

{"size": 12428,
"incoming_size": 4475,
"trxs": [{"trx_id": "string",
"expiration": "2022-09-17T16:30:16",
"trx_type": "aborted",
"first_auth": "jkbsg.wam",
"first_receiver": "m.federation",
"first_action": "mine",
"total_actions": 1,
"billed_cpu_time_us": 504,
"size": 934
}
],
"more": "string"
}

Producer API (1.0.0)

pause

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

resume

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

paused

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

get_runtime_options

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

update_runtime_options

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

get_greylist

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

add_greylist_accounts

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

remove_greylist_accounts

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

get_whitelist_blacklist

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

set_whitelist_blacklist

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

create_snapshot

Authorizations:

Responses

Request samples

Response samples

schedule_snapshot

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

unschedule_snapshot

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

get_snapshot_requests

Authorizations:

Request Body schema: application/json
required