Class LedgerApi

Hierarchy

BaseAPI
- LedgerApi

Constructors

constructor

new LedgerApi(configuration?: Configuration): LedgerApi

Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24
Parameters
- configuration: Configuration = ...
Returns LedgerApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

ledgerDidEndpointGet

ledgerDidEndpointGet(requestParameters: LedgerDidEndpointGetRequest): Promise<GetDIDEndpointResponse>

- Defined in client/apis/LedgerApi.ts:111
Get the endpoint for a DID from the ledger.

Parameters
- requestParameters: LedgerDidEndpointGetRequest
Returns Promise<GetDIDEndpointResponse>

ledgerDidEndpointGetRaw

ledgerDidEndpointGetRaw(requestParameters: LedgerDidEndpointGetRequest): Promise<ApiResponse<GetDIDEndpointResponse>>

- Defined in client/apis/LedgerApi.ts:74
Get the endpoint for a DID from the ledger.

Parameters
- requestParameters: LedgerDidEndpointGetRequest
Returns Promise<ApiResponse<GetDIDEndpointResponse>>

ledgerDidVerkeyGet

ledgerDidVerkeyGet(requestParameters: LedgerDidVerkeyGetRequest): Promise<GetDIDVerkeyResponse>

- Defined in client/apis/LedgerApi.ts:154
Get the verkey for a DID from the ledger.

Parameters
- requestParameters: LedgerDidVerkeyGetRequest
Returns Promise<GetDIDVerkeyResponse>

ledgerDidVerkeyGetRaw

ledgerDidVerkeyGetRaw(requestParameters: LedgerDidVerkeyGetRequest): Promise<ApiResponse<GetDIDVerkeyResponse>>

- Defined in client/apis/LedgerApi.ts:121
Get the verkey for a DID from the ledger.

Parameters
- requestParameters: LedgerDidVerkeyGetRequest
Returns Promise<ApiResponse<GetDIDVerkeyResponse>>

ledgerGetNymRoleGet

ledgerGetNymRoleGet(requestParameters: LedgerGetNymRoleGetRequest): Promise<GetNymRoleResponse>

- Defined in client/apis/LedgerApi.ts:197
Get the role from the NYM registration of a public DID.

Parameters
- requestParameters: LedgerGetNymRoleGetRequest
Returns Promise<GetNymRoleResponse>

ledgerGetNymRoleGetRaw

ledgerGetNymRoleGetRaw(requestParameters: LedgerGetNymRoleGetRequest): Promise<ApiResponse<GetNymRoleResponse>>

- Defined in client/apis/LedgerApi.ts:164
Get the role from the NYM registration of a public DID.

Parameters
- requestParameters: LedgerGetNymRoleGetRequest
Returns Promise<ApiResponse<GetNymRoleResponse>>

ledgerMultipleConfigGet

ledgerMultipleConfigGet(): Promise<LedgerConfigList>

- Defined in client/apis/LedgerApi.ts:229
Fetch the multiple ledger configuration currently in use

Returns Promise<LedgerConfigList>

ledgerMultipleConfigGetRaw

ledgerMultipleConfigGetRaw(): Promise<ApiResponse<LedgerConfigList>>

- Defined in client/apis/LedgerApi.ts:207
Fetch the multiple ledger configuration currently in use

Returns Promise<ApiResponse<LedgerConfigList>>

ledgerMultipleGetWriteLedgerGet

ledgerMultipleGetWriteLedgerGet(): Promise<WriteLedgerRequest>

- Defined in client/apis/LedgerApi.ts:259
Fetch the current write ledger

Returns Promise<WriteLedgerRequest>

ledgerMultipleGetWriteLedgerGetRaw

ledgerMultipleGetWriteLedgerGetRaw(): Promise<ApiResponse<WriteLedgerRequest>>

- Defined in client/apis/LedgerApi.ts:237
Fetch the current write ledger

Returns Promise<ApiResponse<WriteLedgerRequest>>

ledgerRegisterNymPost

ledgerRegisterNymPost(requestParameters: LedgerRegisterNymPostRequest): Promise<TxnOrRegisterLedgerNymResponse>

- Defined in client/apis/LedgerApi.ts:331
Send a NYM registration to the ledger.

Parameters
- requestParameters: LedgerRegisterNymPostRequest
Returns Promise<TxnOrRegisterLedgerNymResponse>

ledgerRegisterNymPostRaw

ledgerRegisterNymPostRaw(requestParameters: LedgerRegisterNymPostRequest): Promise<ApiResponse<TxnOrRegisterLedgerNymResponse>>

- Defined in client/apis/LedgerApi.ts:267
Send a NYM registration to the ledger.

Parameters
- requestParameters: LedgerRegisterNymPostRequest
Returns Promise<ApiResponse<TxnOrRegisterLedgerNymResponse>>

ledgerRotatePublicDidKeypairPatch

ledgerRotatePublicDidKeypairPatch(): Promise<object>

- Defined in client/apis/LedgerApi.ts:361
Rotate key pair for public DID.

Returns Promise<object>

ledgerRotatePublicDidKeypairPatchRaw

ledgerRotatePublicDidKeypairPatchRaw(): Promise<ApiResponse<object>>

- Defined in client/apis/LedgerApi.ts:341
Rotate key pair for public DID.

Returns Promise<ApiResponse<object>>

ledgerTaaAcceptPost

ledgerTaaAcceptPost(requestParameters: LedgerTaaAcceptPostRequest): Promise<object>

- Defined in client/apis/LedgerApi.ts:392
Accept the transaction author agreement

Parameters
- requestParameters: LedgerTaaAcceptPostRequest
Returns Promise<object>

ledgerTaaAcceptPostRaw

ledgerTaaAcceptPostRaw(requestParameters: LedgerTaaAcceptPostRequest): Promise<ApiResponse<object>>

- Defined in client/apis/LedgerApi.ts:369
Accept the transaction author agreement

Parameters
- requestParameters: LedgerTaaAcceptPostRequest
Returns Promise<ApiResponse<object>>

ledgerTaaGet

ledgerTaaGet(): Promise<TAAResult>

- Defined in client/apis/LedgerApi.ts:422
Fetch the current transaction author agreement, if any

Returns Promise<TAAResult>

ledgerTaaGetRaw

ledgerTaaGetRaw(): Promise<ApiResponse<TAAResult>>

- Defined in client/apis/LedgerApi.ts:402
Fetch the current transaction author agreement, if any

Returns Promise<ApiResponse<TAAResult>>

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from BaseAPI.request
- Defined in client/runtime.ts:50
Parameters
- context: RequestOpts
Returns Promise<Response>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from BaseAPI.withMiddleware
- Defined in client/runtime.ts:28
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]): T

Inherited from BaseAPI.withPostMiddleware
- Defined in client/runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]): T

Inherited from BaseAPI.withPreMiddleware
- Defined in client/runtime.ts:34
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]
Returns T

Generated using TypeDoc