Interface IPrivateApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: Algorand.V2.Algod

Assembly: Algorand.dll

Syntax

public interface IPrivateApi : IApiAccessor

Methods

| Improve this Doc View Source

AbortCatchup(String)

Aborts a catchpoint catchup.

Declaration

CatchpointAbortResponse AbortCatchup(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
CatchpointAbortResponse	CatchpointAbortResponse

Remarks

Given a catchpoint, it aborts catching up to this catchpoint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

AbortCatchupAsync(String)

Aborts a catchpoint catchup.

Declaration

Task<CatchpointAbortResponse> AbortCatchupAsync(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
System.Threading.Tasks.Task<CatchpointAbortResponse>	Task of CatchpointAbortResponse

Remarks

Given a catchpoint, it aborts catching up to this catchpoint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

AbortCatchupAsyncWithHttpInfo(String)

Aborts a catchpoint catchup.

Declaration

Task<ApiResponse<CatchpointAbortResponse>> AbortCatchupAsyncWithHttpInfo(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
System.Threading.Tasks.Task<ApiResponse<CatchpointAbortResponse>>	Task of ApiResponse (CatchpointAbortResponse)

Remarks

Given a catchpoint, it aborts catching up to this catchpoint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

AbortCatchupWithHttpInfo(String)

Aborts a catchpoint catchup.

Declaration

ApiResponse<CatchpointAbortResponse> AbortCatchupWithHttpInfo(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
ApiResponse<CatchpointAbortResponse>	ApiResponse of CatchpointAbortResponse

Remarks

Given a catchpoint, it aborts catching up to this catchpoint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

RegisterParticipationKeys(String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>)

Declaration

PostTransactionsResponse RegisterParticipationKeys(string address, long? fee = default(long? ), long? keyDilution = default(long? ), long? roundLastValid = default(long? ), bool? noWait = default(bool? ))

Parameters

Type	Name	Description
System.String	address	The `account-id` to update, or `all` to update all accounts.
System.Nullable<System.Int64>	fee	The fee to use when submitting key registration transactions. Defaults to the suggested fee. (optional, default to 1000)
System.Nullable<System.Int64>	keyDilution	value to use for two-level participation key. (optional)
System.Nullable<System.Int64>	roundLastValid	The last round for which the generated participation keys will be valid. (optional)
System.Nullable<System.Boolean>	noWait	Don't wait for transaction to commit before returning response. (optional)

Returns

Type	Description
PostTransactionsResponse	PostTransactionsResponse

Remarks

Generate (or renew) and register participation keys on the node for a given account address.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

RegisterParticipationKeysAsync(String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>)

Declaration

Task<PostTransactionsResponse> RegisterParticipationKeysAsync(string address, long? fee = default(long? ), long? keyDilution = default(long? ), long? roundLastValid = default(long? ), bool? noWait = default(bool? ))

Parameters

Type	Name	Description
System.String	address	The `account-id` to update, or `all` to update all accounts.
System.Nullable<System.Int64>	fee	The fee to use when submitting key registration transactions. Defaults to the suggested fee. (optional, default to 1000)
System.Nullable<System.Int64>	keyDilution	value to use for two-level participation key. (optional)
System.Nullable<System.Int64>	roundLastValid	The last round for which the generated participation keys will be valid. (optional)
System.Nullable<System.Boolean>	noWait	Don't wait for transaction to commit before returning response. (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PostTransactionsResponse>	Task of PostTransactionsResponse

Remarks

Generate (or renew) and register participation keys on the node for a given account address.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

RegisterParticipationKeysAsyncWithHttpInfo(String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>)

Declaration

Task<ApiResponse<PostTransactionsResponse>> RegisterParticipationKeysAsyncWithHttpInfo(string address, long? fee = default(long? ), long? keyDilution = default(long? ), long? roundLastValid = default(long? ), bool? noWait = default(bool? ))

Parameters

Type	Name	Description
System.String	address	The `account-id` to update, or `all` to update all accounts.
System.Nullable<System.Int64>	fee	The fee to use when submitting key registration transactions. Defaults to the suggested fee. (optional, default to 1000)
System.Nullable<System.Int64>	keyDilution	value to use for two-level participation key. (optional)
System.Nullable<System.Int64>	roundLastValid	The last round for which the generated participation keys will be valid. (optional)
System.Nullable<System.Boolean>	noWait	Don't wait for transaction to commit before returning response. (optional)

Returns

Type	Description
System.Threading.Tasks.Task<ApiResponse<PostTransactionsResponse>>	Task of ApiResponse (PostTransactionsResponse)

Remarks

Generate (or renew) and register participation keys on the node for a given account address.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

RegisterParticipationKeysWithHttpInfo(String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>)

Declaration

ApiResponse<PostTransactionsResponse> RegisterParticipationKeysWithHttpInfo(string address, long? fee = default(long? ), long? keyDilution = default(long? ), long? roundLastValid = default(long? ), bool? noWait = default(bool? ))

Parameters

Type	Name	Description
System.String	address	The `account-id` to update, or `all` to update all accounts.
System.Nullable<System.Int64>	fee	The fee to use when submitting key registration transactions. Defaults to the suggested fee. (optional, default to 1000)
System.Nullable<System.Int64>	keyDilution	value to use for two-level participation key. (optional)
System.Nullable<System.Int64>	roundLastValid	The last round for which the generated participation keys will be valid. (optional)
System.Nullable<System.Boolean>	noWait	Don't wait for transaction to commit before returning response. (optional)

Returns

Type	Description
ApiResponse<PostTransactionsResponse>	ApiResponse of PostTransactionsResponse

Remarks

Generate (or renew) and register participation keys on the node for a given account address.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ShutdownNode(Nullable<Int32>)

Declaration

object ShutdownNode(int? timeout = default(int? ))

Parameters

Type	Name	Description
System.Nullable<System.Int32>	timeout	(optional, default to 0)

Returns

Type	Description
System.Object	Object

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ShutdownNodeAsync(Nullable<Int32>)

Declaration

Task<object> ShutdownNodeAsync(int? timeout = default(int? ))

Parameters

Type	Name	Description
System.Nullable<System.Int32>	timeout	(optional, default to 0)

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>	Task of Object

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ShutdownNodeAsyncWithHttpInfo(Nullable<Int32>)

Declaration

Task<ApiResponse<object>> ShutdownNodeAsyncWithHttpInfo(int? timeout = default(int? ))

Parameters

Type	Name	Description
System.Nullable<System.Int32>	timeout	(optional, default to 0)

Returns

Type	Description
System.Threading.Tasks.Task<ApiResponse<System.Object>>	Task of ApiResponse (Object)

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ShutdownNodeWithHttpInfo(Nullable<Int32>)

Declaration

ApiResponse<object> ShutdownNodeWithHttpInfo(int? timeout = default(int? ))

Parameters

Type	Name	Description
System.Nullable<System.Int32>	timeout	(optional, default to 0)

Returns

Type	Description
ApiResponse<System.Object>	ApiResponse of Object

Remarks

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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

StartCatchup(String)

Starts a catchpoint catchup.

Declaration

CatchpointStartResponse StartCatchup(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
CatchpointStartResponse	CatchpointStartResponse

Remarks

Given a catchpoint, it starts catching up to this catchpoint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

StartCatchupAsync(String)

Starts a catchpoint catchup.

Declaration

Task<CatchpointStartResponse> StartCatchupAsync(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
System.Threading.Tasks.Task<CatchpointStartResponse>	Task of CatchpointStartResponse

Remarks

Given a catchpoint, it starts catching up to this catchpoint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

StartCatchupAsyncWithHttpInfo(String)

Starts a catchpoint catchup.

Declaration

Task<ApiResponse<CatchpointStartResponse>> StartCatchupAsyncWithHttpInfo(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
System.Threading.Tasks.Task<ApiResponse<CatchpointStartResponse>>	Task of ApiResponse (CatchpointStartResponse)

Remarks

Given a catchpoint, it starts catching up to this catchpoint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

StartCatchupWithHttpInfo(String)

Starts a catchpoint catchup.

Declaration

ApiResponse<CatchpointStartResponse> StartCatchupWithHttpInfo(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
ApiResponse<CatchpointStartResponse>	ApiResponse of CatchpointStartResponse

Remarks

Given a catchpoint, it starts catching up to this catchpoint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call