@gala-chain/client • Readme | API

---

@gala-chain/client / RestApiClient

Class: RestApiClient

Extends

• ChainClient

Constructors

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

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

Parameters

• builder: Promise\<ChainClientBuilder>

• restApiUrl: string

• contractConfig: ContractConfig

• credentials: RestApiAdminCredentials

• orgMsp: string

Returns

RestApiClient

Overrides

ChainClient.constructor

Source

rest-api/RestApiClient.ts:51

Properties

builder

readonly builder: Promise\<ChainClientBuilder>

Inherited from

ChainClient.builder

Source

generic/ChainClient.ts:28

---

contractConfig

readonly contractConfig: ContractConfig

Inherited from

ChainClient.contractConfig

Source

generic/ChainClient.ts:30

---

credentials

private readonly credentials: RestApiAdminCredentials

Source

rest-api/RestApiClient.ts:55

---

orgMsp

readonly orgMsp: string

Inherited from

ChainClient.orgMsp

Source

generic/ChainClient.ts:31

---

restApiUrl

private readonly restApiUrl: Promise\<string>

Source

rest-api/RestApiClient.ts:49

---

userId

readonly userId: string

Inherited from

ChainClient.userId

Source

generic/ChainClient.ts:29

Methods

disconnect()

disconnect(): Promise\<void>

Returns

Promise\<void>

Overrides

ChainClient.disconnect

Source

rest-api/RestApiClient.ts:67

---

evaluateTransaction()

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

Type parameters

• T

Parameters

• method: string

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

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

Returns

Promise\<GalaChainResponse\<T>>

Overrides

ChainClient.evaluateTransaction

Source

rest-api/RestApiClient.ts:82

---

extendAPI()

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

Type parameters

• T extends object

Parameters

• apiHandlerFn

Returns

RestApiClient & T

Inherited from

ChainClient.extendAPI

Source

generic/ChainClient.ts:65

---

forUser()

forUser(userId): ChainClient

Parameters

• userId: string

Returns

ChainClient

Overrides

ChainClient.forUser

Source

rest-api/RestApiClient.ts:116

---

isReady()

isReady(): Promise\<true>

Returns

Promise\<true>

Source

rest-api/RestApiClient.ts:62

---

post()

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

Type parameters

• T

Parameters

• path: string

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

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

Returns

Promise\<GalaChainResponse\<T>>

Source

rest-api/RestApiClient.ts:92

---

submitTransaction()

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

Type parameters

• T

Parameters

• method: string

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

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

Returns

Promise\<GalaChainResponse\<T>>

Overrides

ChainClient.submitTransaction

Source

rest-api/RestApiClient.ts:72

---

getContractApis()

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

Parameters

• credentials: RestApiAdminCredentials

• restApiUrl: string

• restApiConfig: RestApiConfig

Returns

Promise\<SetContractApiParams[]>

Source

rest-api/RestApiClient.ts:121