Skip to content

@gala-chain/client ∙ API

API > RestApiClient

Class: RestApiClient

Contents

Extends

  • ChainClient

Constructors

new RestApiClient(builder, restApiUrl, contractConfig, orgMsp)

new RestApiClient(builder, restApiUrl, contractConfig, orgMsp): RestApiClient

Parameters

▪ builder: Promise\<ChainClientBuilder>

▪ restApiUrl: string

▪ contractConfig: ContractConfig

▪ orgMsp: string

Overrides

ChainClient.constructor

Source

chain-client/src/rest-api/RestApiClient.ts:61

Properties

builder

readonly builder: Promise\<ChainClientBuilder>

Inherited from

ChainClient.builder

Source

chain-api/src/client/generic/ChainClient.ts:27

contractConfig

readonly contractConfig: ContractConfig

Inherited from

ChainClient.contractConfig

Source

chain-api/src/client/generic/ChainClient.ts:29

orgMsp

readonly orgMsp: string

Inherited from

ChainClient.orgMsp

Source

chain-api/src/client/generic/ChainClient.ts:30

restApiUrl

private readonly restApiUrl: Promise\<string>

Source

chain-client/src/rest-api/RestApiClient.ts:59

userId

readonly userId: string

Inherited from

ChainClient.userId

Source

chain-api/src/client/generic/ChainClient.ts:28

Methods

disconnect()

disconnect(): Promise\<void>

Overrides

ChainClient.disconnect

Source

chain-client/src/rest-api/RestApiClient.ts:76

evaluateTransaction()

evaluateTransaction\<T>(method, dtoOrResp?, resp?): Promise\<GalaChainResponse\<T>>

Type parameters

▪ T

Parameters

▪ method: string

▪ dtoOrResp?: ChainCallDTO | ClassType\<Inferred\<T>>

▪ resp?: ClassType\<Inferred\<T>>

Overrides

ChainClient.evaluateTransaction

Source

chain-client/src/rest-api/RestApiClient.ts:91

extendAPI()

extendAPI\<T>(apiHandlerFn): RestApiClient & T

Type parameters

▪ T extends object

Parameters

▪ apiHandlerFn: (_) => T

Inherited from

ChainClient.extendAPI

Source

chain-api/src/client/generic/ChainClient.ts:64

forUser()

forUser(userId): ChainClient

Parameters

▪ userId: string

Overrides

ChainClient.forUser

Source

chain-client/src/rest-api/RestApiClient.ts:116

isReady()

isReady(): Promise\<true>

Source

chain-client/src/rest-api/RestApiClient.ts:71

post()

post\<T>(path, dtoOrResp?, resp?): Promise\<GalaChainResponse\<T>>

Type parameters

▪ T

Parameters

▪ path: string

▪ dtoOrResp?: ChainCallDTO | ClassType\<Inferred\<T>>

▪ resp?: ClassType\<Inferred\<T>>

Source

chain-client/src/rest-api/RestApiClient.ts:101

submitTransaction()

submitTransaction\<T>(method, dtoOrResp?, resp?): Promise\<GalaChainResponse\<T>>

Type parameters

▪ T

Parameters

▪ method: string

▪ dtoOrResp?: ChainCallDTO | ClassType\<Inferred\<T>>

▪ resp?: ClassType\<Inferred\<T>>

Overrides

ChainClient.submitTransaction

Source

chain-client/src/rest-api/RestApiClient.ts:81

getContractApis()

static getContractApis(credentials, restApiUrl, restApiConfig): Promise\<SetContractApiParams[]>

Parameters

▪ credentials: RestApiAdminCredentials

▪ restApiUrl: string

▪ restApiConfig: RestApiConfig

Source

chain-client/src/rest-api/RestApiClient.ts:121