GenRpcClient

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:42

​

Constructors

​

Constructor

new GenRpcClient(transport): GenRpcClient

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:43

​

Parameters

transport

JsonRpcTransport

​

Returns

GenRpcClient

​

Methods

​

getAbiByContractCodeId()

getAbiByContractCodeId(request): Promise<GetAbiByContractCodeIdResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:46 Returns contract ABIs by contract code ID.

​

Parameters

request

GetAbiByContractCodeIdRequest

​

Returns

Promise<GetAbiByContractCodeIdResponse>

---

​

getAbiByContractId()

getAbiByContractId(request): Promise<GetAbiByContractIdResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:53 Returns contract ABIs by contract ID.

​

Parameters

request

GetAbiByContractIdRequest

​

Returns

Promise<GetAbiByContractIdResponse>

---

​

getAccount()

getAccount(request): Promise<GetAccountResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:60 Returns account details by address.

​

Parameters

request

GetAccountRequest

​

Returns

Promise<GetAccountResponse>

---

​

getActivation()

getActivation(request): Promise<GetActivationResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:65 Returns activation details by id. Returns JSON-RPC NOT_FOUND if the activation does not exist.

​

Parameters

request

GetActivationRequest

​

Returns

Promise<GetActivationResponse>

---

​

getBalance()

getBalance(request): Promise<Amount>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:72 Returns the routed fungible balance for an account.

​

Parameters

request

GetBalanceRequest

​

Returns

Promise<Amount>

---

​

getBalances()

getBalances(request): Promise<GetBalancesResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:77 Returns all configured fungible balances for an account.

​

Parameters

request

GetBalancesRequest

​

Returns

Promise<GetBalancesResponse>

---

​

getBlock()

getBlock(request): Promise<GetBlockResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:82 Returns an aggregated closed block for a given block index.

​

Parameters

request

GetBlockRequest

​

Returns

Promise<GetBlockResponse>

---

​

getComponent()

getComponent(request): Promise<GetComponentResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:87 Returns component metadata and ABI.

​

Parameters

request

GetComponentRequest

​

Returns

Promise<GetComponentResponse>

---

​

getContract()

getContract(request): Promise<GetContractResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:94 Returns contract metadata and ABI.

​

Parameters

request

GetContractRequest

​

Returns

Promise<GetContractResponse>

---

​

getCurrentBlockIndex()

getCurrentBlockIndex(request): Promise<GetCurrentBlockIndexResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:99 Returns the latest finalized block index known to this RPC unit.

​

Parameters

request

GetCurrentBlockIndexRequest

​

Returns

Promise<GetCurrentBlockIndexResponse>

---

​

getEntityRoot()

getEntityRoot(request): Promise<GetEntityRootResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:106 Returns root metadata for an entity.

​

Parameters

request

GetEntityRootRequest

​

Returns

Promise<GetEntityRootResponse>

---

​

getStorageAt()

getStorageAt(request): Promise<Base64Bytes | null>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:113 Returns the raw storage value for a component at a given key.

​

Parameters

request

GetStorageAtRequest

​

Returns

Promise<Base64Bytes | null>

---

​

getTrace()

getTrace(request): Promise<GetTraceResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:120 Returns trace details by id.

​

Parameters

request

GetTraceRequest

​

Returns

Promise<GetTraceResponse>

---

​

getVersion()

getVersion(request): Promise<GetVersionResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:125 Returns the artifact release version and developer-owned RPC protocol version.

​

Parameters

request

GetVersionRequest

​

Returns

Promise<GetVersionResponse>

---

​

simulateActivation()

simulateActivation(request): Promise<SimulateActivationResponse>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:130 Simulates an activation without submitting it to the network. The activation is executed locally and all continuations are followed BFS-style. State queries are resolved against the specified block height (if provided).

​

Parameters

request

SimulateActivationRequest

​

Returns

Promise<SimulateActivationResponse>

---

​

submitActivation()

submitActivation(request): Promise<ActivationId>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:137 Sends a signed activation to the network.

​

Parameters

request

SubmitActivationRequest

​

Returns

Promise<ActivationId>

---

​

view()

view(request): Promise<ViewResult>

Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/rpc-client/client.ts:144 Executes a read-only activation payload. No state changes occur.

​

Parameters

request

ViewRequest

​

Returns

Promise<ViewResult>