PrivateService
Constructors
new PrivateService()
new PrivateService(
httpRequest):PrivateService
Parameters
• httpRequest: BaseHttpRequest
Returns
Defined in
services.gen.ts:8
Properties
httpRequest
readonlyhttpRequest:BaseHttpRequest
Defined in
services.gen.ts:8
Methods
abortCatchup()
abortCatchup(
data):CancelablePromise<AbortCatchupResponse>
Aborts a catchpoint catchup. Given a catchpoint, it aborts catching up to this catchpoint
Parameters
• data: AbortCatchupData
The data for the request.
Returns
CancelablePromise<AbortCatchupResponse>
unknown
Throws
ApiError
Defined in
services.gen.ts:42
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:115
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:223
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:172
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:142
getDebugSettingsProf()
getDebugSettingsProf():
CancelablePromise<DebugSettingsProf>
Retrieves the current settings for blocking and mutex profiles
Returns
CancelablePromise<DebugSettingsProf>
DebugSettingsProf DebugPprof is the response to the /debug/extra/pprof endpoint
Throws
ApiError
Defined in
services.gen.ts:15
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:197
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:94
putDebugSettingsProf()
putDebugSettingsProf():
CancelablePromise<DebugSettingsProf>
Enables blocking and mutex profiles, and returns the old settings
Returns
CancelablePromise<DebugSettingsProf>
DebugSettingsProf DebugPprof is the response to the /debug/extra/pprof endpoint
Throws
ApiError
Defined in
services.gen.ts:27
shutdownNode()
shutdownNode(
data):CancelablePromise<ShutdownNodeResponse>
Special management endpoint to shutdown the node. Optionally provide a timeout parameter to indicate that the node should begin shutting down after a number of seconds.
Parameters
• data: ShutdownNodeData = {}
The data for the request.
Returns
CancelablePromise<ShutdownNodeResponse>
unknown
Throws
ApiError
Defined in
services.gen.ts:249
startCatchup()
startCatchup(
data):CancelablePromise<StartCatchupResponse>
Starts a catchpoint catchup. Given a catchpoint, it starts catching up to this catchpoint
Parameters
• data: StartCatchupData
The data for the request.
Returns
CancelablePromise<StartCatchupResponse>
unknown
unknown
Throws
ApiError
Defined in
services.gen.ts:68