ParticipatingService
Constructors
new ParticipatingService()
new ParticipatingService(
httpRequest):ParticipatingService
Parameters
• httpRequest: BaseHttpRequest
Returns
Defined in
services.gen.ts:2217
Properties
httpRequest
readonlyhttpRequest:BaseHttpRequest
Defined in
services.gen.ts:2217
Methods
addParticipationKey()
addParticipationKey(
data):CancelablePromise<AddParticipationKeyResponse>
Add a participation key to the node
Parameters
• data: AddParticipationKeyData
The data for the request.
Returns
CancelablePromise<AddParticipationKeyResponse>
unknown Participation ID of the submission
Throws
ApiError
Defined in
services.gen.ts:2278
appendKeys()
appendKeys(
data):CancelablePromise<ParticipationKey>
Append state proof keys to a participation key Given a participation ID, append state proof keys to a particular set of participation keys
Parameters
• data: AppendKeysData
The data for the request.
Returns
CancelablePromise<ParticipationKey>
ParticipationKey A detailed description of a participation ID
Throws
ApiError
Defined in
services.gen.ts:2386
deleteParticipationKeyById()
deleteParticipationKeyById(
data):CancelablePromise<unknown>
Delete a given participation key by ID Delete a given participation key by ID
Parameters
• data: DeleteParticipationKeyByIdData
The data for the request.
Returns
CancelablePromise<unknown>
unknown Participation key got deleted by ID
Throws
ApiError
Defined in
services.gen.ts:2335
generateParticipationKeys()
generateParticipationKeys(
data):CancelablePromise<string>
Generate and install participation keys to the node.
Parameters
• data: GenerateParticipationKeysData
The data for the request.
Returns
CancelablePromise<string>
string An empty JSON object is returned if the generation process was started. Currently no status is available.
Throws
ApiError
Defined in
services.gen.ts:2305
getParticipationKeyById()
getParticipationKeyById(
data):CancelablePromise<ParticipationKey>
Get participation key info given a participation ID Given a participation ID, return information about that participation key
Parameters
• data: GetParticipationKeyByIdData
The data for the request.
Returns
CancelablePromise<ParticipationKey>
ParticipationKey A detailed description of a participation ID
Throws
ApiError
Defined in
services.gen.ts:2360
getParticipationKeys()
getParticipationKeys():
CancelablePromise<GetParticipationKeysResponse>
Return a list of participation keys Return a list of participation keys
Returns
CancelablePromise<GetParticipationKeysResponse>
ParticipationKey A list of participation keys
Throws
ApiError
Defined in
services.gen.ts:2257
getPendingTransactions()
getPendingTransactions(
data):CancelablePromise<GetPendingTransactionsResponse>
Get a list of unconfirmed transactions currently in the transaction pool. Get the list of pending transactions, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.
Parameters
• data: GetPendingTransactionsData = {}
The data for the request.
Returns
CancelablePromise<GetPendingTransactionsResponse>
unknown A potentially truncated list of transactions currently in the node’s transaction pool. You can compute whether or not the list is truncated if the number of elements in the top-transactions array is fewer than total-transactions.
Throws
ApiError
Defined in
services.gen.ts:2438
getPendingTransactionsByAddress()
getPendingTransactionsByAddress(
data):CancelablePromise<GetPendingTransactionsByAddressResponse>
Get a list of unconfirmed transactions currently in the transaction pool by address. Get the list of pending transactions by address, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.
Parameters
• data: GetPendingTransactionsByAddressData
The data for the request.
Returns
CancelablePromise<GetPendingTransactionsByAddressResponse>
unknown A potentially truncated list of transactions currently in the node’s transaction pool. You can compute whether or not the list is truncated if the number of elements in the top-transactions array is fewer than total-transactions.
Throws
ApiError
Defined in
services.gen.ts:2230
pendingTransactionInformation()
pendingTransactionInformation(
data):CancelablePromise<PendingTransactionResponse>
Get a specific pending transaction. Given a transaction ID of a recently submitted transaction, it returns information about it. There are several cases when this might succeed:
- transaction committed (committed round > 0)
- transaction still in the pool (committed round = 0, pool error = "")
- transaction removed from pool due to error (committed round = 0, pool error != "") Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
Parameters
• data: PendingTransactionInformationData
The data for the request.
Returns
CancelablePromise<PendingTransactionResponse>
PendingTransactionResponse Given a transaction ID of a recently submitted transaction, it returns information about it. There are several cases when this might succeed:
- transaction committed (committed round > 0)
- transaction still in the pool (committed round = 0, pool error = "")
- transaction removed from pool due to error (committed round = 0, pool error != "")
Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
Throws
ApiError
Defined in
services.gen.ts:2474
rawTransaction()
rawTransaction(
data):CancelablePromise<RawTransactionResponse>
Broadcasts a raw transaction or transaction group to the network.
Parameters
• data: RawTransactionData
The data for the request.
Returns
CancelablePromise<RawTransactionResponse>
unknown Transaction ID of the submission.
Throws
ApiError
Defined in
services.gen.ts:2412