Class MicroblocksApi

Hierarchy

BaseAPI
- MicroblocksApi

Implements

MicroblocksApiInterface

Index

Constructors

constructor

new MicroblocksApi(configuration?: Configuration): MicroblocksApi
Parameters
- configuration: Configuration = ...
Returns MicroblocksApi
Inherited from BaseAPI.constructor
- Defined in src/generated/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

getMicroblockByHash

getMicroblockByHash(requestParameters: GetMicroblockByHashRequest, initOverrides?: RequestInit): Promise<Microblock>
Retrieves a specific microblock by hash Get microblock
Parameters
- requestParameters: GetMicroblockByHashRequest
- Optional initOverrides: RequestInit
Returns Promise<Microblock>
Implementation of MicroblocksApiInterface.getMicroblockByHash
- Defined in src/generated/apis/MicroblocksApi.ts:127

getMicroblockByHashRaw

getMicroblockByHashRaw(requestParameters: GetMicroblockByHashRequest, initOverrides?: RequestInit): Promise<ApiResponse<Microblock>>
Retrieves a specific microblock by hash Get microblock
Parameters
- requestParameters: GetMicroblockByHashRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Microblock>>
Implementation of MicroblocksApiInterface.getMicroblockByHashRaw
- Defined in src/generated/apis/MicroblocksApi.ts:104

getMicroblockList

getMicroblockList(requestParameters: GetMicroblockListRequest, initOverrides?: RequestInit): Promise<MicroblockListResponse>
Retrieves a list of microblocks. If you need to actively monitor new microblocks, we highly recommend subscribing to WebSockets or Socket.io for real-time updates. Get recent microblocks
Parameters
- requestParameters: GetMicroblockListRequest
- Optional initOverrides: RequestInit
Returns Promise<MicroblockListResponse>
Implementation of MicroblocksApiInterface.getMicroblockList
- Defined in src/generated/apis/MicroblocksApi.ts:163

getMicroblockListRaw

getMicroblockListRaw(requestParameters: GetMicroblockListRequest, initOverrides?: RequestInit): Promise<ApiResponse<MicroblockListResponse>>
Retrieves a list of microblocks. If you need to actively monitor new microblocks, we highly recommend subscribing to WebSockets or Socket.io for real-time updates. Get recent microblocks
Parameters
- requestParameters: GetMicroblockListRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<MicroblockListResponse>>
Implementation of MicroblocksApiInterface.getMicroblockListRaw
- Defined in src/generated/apis/MicroblocksApi.ts:136

getUnanchoredTxs

getUnanchoredTxs(initOverrides?: RequestInit): Promise<UnanchoredTransactionListResponse>
Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block Get the list of current transactions that belong to unanchored microblocks
Parameters
- Optional initOverrides: RequestInit
Returns Promise<UnanchoredTransactionListResponse>
Implementation of MicroblocksApiInterface.getUnanchoredTxs
- Defined in src/generated/apis/MicroblocksApi.ts:191

getUnanchoredTxsRaw

getUnanchoredTxsRaw(initOverrides?: RequestInit): Promise<ApiResponse<UnanchoredTransactionListResponse>>
Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block Get the list of current transactions that belong to unanchored microblocks
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<UnanchoredTransactionListResponse>>
Implementation of MicroblocksApiInterface.getUnanchoredTxsRaw
- Defined in src/generated/apis/MicroblocksApi.ts:172

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/generated/runtime.ts:47

withMiddleware

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

withPostMiddleware

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

withPreMiddleware

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

Class MicroblocksApi

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns MicroblocksApi

Properties

Protected configuration

Methods

getMicroblockByHash

Parameters

requestParameters: GetMicroblockByHashRequest

Optional initOverrides: RequestInit

Returns Promise<Microblock>

getMicroblockByHashRaw

Parameters

requestParameters: GetMicroblockByHashRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<Microblock>>

getMicroblockList

Parameters

requestParameters: GetMicroblockListRequest

Optional initOverrides: RequestInit

Returns Promise<MicroblockListResponse>

getMicroblockListRaw

Parameters

requestParameters: GetMicroblockListRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<MicroblockListResponse>>

getUnanchoredTxs

Parameters

Optional initOverrides: RequestInit

Returns Promise<UnanchoredTransactionListResponse>

getUnanchoredTxsRaw

Parameters

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<UnanchoredTransactionListResponse>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit

Returns Promise<Response>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

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

Returns T

withPreMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

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

Returns T

Settings

Member Visibility

Theme

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]