Class LedgerApi

Hierarchy

BaseAPI
- LedgerApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

ledgerConfigGet

ledgerConfigGet(): Promise<LedgerConfigList>
Fetch the multiple ledger configuration currently in use

Returns Promise<LedgerConfigList>
- Defined in client/apis/LedgerApi.ts:101

ledgerConfigGetRaw

ledgerConfigGetRaw(): Promise<ApiResponse<LedgerConfigList>>
Fetch the multiple ledger configuration currently in use

Returns Promise<ApiResponse<LedgerConfigList>>
- Defined in client/apis/LedgerApi.ts:81

ledgerDidEndpointGet

ledgerDidEndpointGet(requestParameters): Promise<GetDIDEndpointResponse>
Get the endpoint for a DID from the ledger.
Parameters
- requestParameters: LedgerDidEndpointGetRequest
Returns Promise<GetDIDEndpointResponse>
- Defined in client/apis/LedgerApi.ts:146

ledgerDidEndpointGetRaw

ledgerDidEndpointGetRaw(requestParameters): Promise<ApiResponse<GetDIDEndpointResponse>>
Get the endpoint for a DID from the ledger.
Parameters
- requestParameters: LedgerDidEndpointGetRequest
Returns Promise<ApiResponse<GetDIDEndpointResponse>>
- Defined in client/apis/LedgerApi.ts:109

ledgerDidVerkeyGet

ledgerDidVerkeyGet(requestParameters): Promise<GetDIDVerkeyResponse>
Get the verkey for a DID from the ledger.
Parameters
- requestParameters: LedgerDidVerkeyGetRequest
Returns Promise<GetDIDVerkeyResponse>
- Defined in client/apis/LedgerApi.ts:189

ledgerDidVerkeyGetRaw

ledgerDidVerkeyGetRaw(requestParameters): Promise<ApiResponse<GetDIDVerkeyResponse>>
Get the verkey for a DID from the ledger.
Parameters
- requestParameters: LedgerDidVerkeyGetRequest
Returns Promise<ApiResponse<GetDIDVerkeyResponse>>
- Defined in client/apis/LedgerApi.ts:156

ledgerGetNymRoleGet

ledgerGetNymRoleGet(requestParameters): Promise<GetNymRoleResponse>
Get the role from the NYM registration of a public DID.
Parameters
- requestParameters: LedgerGetNymRoleGetRequest
Returns Promise<GetNymRoleResponse>
- Defined in client/apis/LedgerApi.ts:232

ledgerGetNymRoleGetRaw

ledgerGetNymRoleGetRaw(requestParameters): Promise<ApiResponse<GetNymRoleResponse>>
Get the role from the NYM registration of a public DID.
Parameters
- requestParameters: LedgerGetNymRoleGetRequest
Returns Promise<ApiResponse<GetNymRoleResponse>>
- Defined in client/apis/LedgerApi.ts:199

ledgerGetWriteLedgerGet

ledgerGetWriteLedgerGet(): Promise<WriteLedger>
Fetch the current write ledger

Returns Promise<WriteLedger>
- Defined in client/apis/LedgerApi.ts:264

ledgerGetWriteLedgerGetRaw

ledgerGetWriteLedgerGetRaw(): Promise<ApiResponse<WriteLedger>>
Fetch the current write ledger

Returns Promise<ApiResponse<WriteLedger>>
- Defined in client/apis/LedgerApi.ts:242

ledgerGetWriteLedgersGet

ledgerGetWriteLedgersGet(): Promise<ConfigurableWriteLedgers>
Fetch list of available write ledgers

Returns Promise<ConfigurableWriteLedgers>
- Defined in client/apis/LedgerApi.ts:294

ledgerGetWriteLedgersGetRaw

ledgerGetWriteLedgersGetRaw(): Promise<ApiResponse<ConfigurableWriteLedgers>>
Fetch list of available write ledgers

Returns Promise<ApiResponse<ConfigurableWriteLedgers>>
- Defined in client/apis/LedgerApi.ts:272

ledgerLedgerIdSetWriteLedgerPut

ledgerLedgerIdSetWriteLedgerPut(requestParameters): Promise<WriteLedger>
Set write ledger
Parameters
- requestParameters: LedgerLedgerIdSetWriteLedgerPutRequest
Returns Promise<WriteLedger>
- Defined in client/apis/LedgerApi.ts:337

ledgerLedgerIdSetWriteLedgerPutRaw

ledgerLedgerIdSetWriteLedgerPutRaw(requestParameters): Promise<ApiResponse<WriteLedger>>
Set write ledger
Parameters
- requestParameters: LedgerLedgerIdSetWriteLedgerPutRequest
Returns Promise<ApiResponse<WriteLedger>>
- Defined in client/apis/LedgerApi.ts:302

ledgerRegisterNymPost

ledgerRegisterNymPost(requestParameters): Promise<TxnOrRegisterLedgerNymResponse>
Send a NYM registration to the ledger.
Parameters
- requestParameters: LedgerRegisterNymPostRequest
Returns Promise<TxnOrRegisterLedgerNymResponse>
- Defined in client/apis/LedgerApi.ts:413

ledgerRegisterNymPostRaw

ledgerRegisterNymPostRaw(requestParameters): Promise<ApiResponse<TxnOrRegisterLedgerNymResponse>>
Send a NYM registration to the ledger.
Parameters
- requestParameters: LedgerRegisterNymPostRequest
Returns Promise<ApiResponse<TxnOrRegisterLedgerNymResponse>>
- Defined in client/apis/LedgerApi.ts:349

ledgerRotatePublicDidKeypairPatch

ledgerRotatePublicDidKeypairPatch(): Promise<object>
Rotate key pair for public DID.

Returns Promise<object>
- Defined in client/apis/LedgerApi.ts:443

ledgerRotatePublicDidKeypairPatchRaw

ledgerRotatePublicDidKeypairPatchRaw(): Promise<ApiResponse<object>>
Rotate key pair for public DID.

Returns Promise<ApiResponse<object>>
- Defined in client/apis/LedgerApi.ts:423

ledgerTaaAcceptPost

ledgerTaaAcceptPost(requestParameters): Promise<object>
Accept the transaction author agreement
Parameters
- requestParameters: LedgerTaaAcceptPostRequest
Returns Promise<object>
- Defined in client/apis/LedgerApi.ts:474

ledgerTaaAcceptPostRaw

ledgerTaaAcceptPostRaw(requestParameters): Promise<ApiResponse<object>>
Accept the transaction author agreement
Parameters
- requestParameters: LedgerTaaAcceptPostRequest
Returns Promise<ApiResponse<object>>
- Defined in client/apis/LedgerApi.ts:451

ledgerTaaGet

ledgerTaaGet(): Promise<TAAResult>
Fetch the current transaction author agreement, if any

Returns Promise<TAAResult>
- Defined in client/apis/LedgerApi.ts:504

ledgerTaaGetRaw

ledgerTaaGetRaw(): Promise<ApiResponse<TAAResult>>
Fetch the current transaction author agreement, if any

Returns Promise<ApiResponse<TAAResult>>
- Defined in client/apis/LedgerApi.ts:484

`Protected` request

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

withMiddleware

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

withPostMiddleware

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

withPreMiddleware

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

Generated using TypeDoc