Constructors
Constructor
new GenClient(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:183 Creates a client wrapping an existing RPC transport with optional config overrides.rpcClient,config?):GenClient
Parameters
rpcClient
GenRpcClient
config?
GenClientConfigInit | GenClientConfig
Returns
GenClient
Methods
newHttp()
Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:194 Creates an HTTP-backed client with the SDK’s default JSON-RPC headers.staticnewHttp(url,options?):GenClient
Parameters
url
string
options?
GenClientHttpOptions = {}
Returns
GenClient
newHttpWithoutDefaultHeaders()
Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:201 Creates an HTTP client without adding the SDK’s default JSON-RPC headers.staticnewHttpWithoutDefaultHeaders(url,options?):GenClient
Parameters
url
string
options?
GenClientHttpOptions = {}
Returns
GenClient
rpc()
rpc(): GenRpcClient
Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:241
Returns the underlying generated JSON-RPC client.
Returns
GenRpcClient
config()
config(): GenClientConfig
Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:248
Returns the resolved client configuration used for headers and polling.
Returns
GenClientConfig
getFreshValidUntilBlock()
getFreshValidUntilBlock():Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:266 Fetches a freshPromise<bigint>
validUntilBlock from the current finalized block index
plus the SDK’s short validity buffer. Retries on transient “latest
finalized block index is not cached yet” JSON-RPC errors.
Returns
Promise<bigint>
buildSignableActivation()
buildSignableActivation(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:308 Builds an unsigned activation with optional per-submission header options. WhensignerPublicKey,payload,options?):Promise<SignableGenExternalActivation>
validUntilBlock is not supplied in options, the client fetches
the current finalized block and adds the SDK’s short validity buffer.
Parameters
signerPublicKey
GenPublicKey
payload
ActivationPayload
options?
ActivationOptionsInit
Returns
Promise<SignableGenExternalActivation>
submitActivation()
submitActivation(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:327 Submits a pre-signed activation and returns its activation ID.activation):Promise<ActivationId>
Parameters
activation
GenExternalActivation
Returns
Promise<ActivationId>
signAndSubmitActivation()
signAndSubmitActivation(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:339 Signs an activation with the provided signer and submits it.signer,payload,options?):Promise<ActivationId>
Parameters
signer
EddsaSigner
payload
ActivationPayload
options?
ActivationOptionsInit
Returns
Promise<ActivationId>
waitForTraceCompletion()
waitForTraceCompletion(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:357 Collects the full activation trace by BFS traversal of continuations.activationId):Promise<ActivationTrace>
Parameters
activationId
ActivationId
Returns
Promise<ActivationTrace>
wait()
wait(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:367 Waits for the activation trace and resolves the terminal result event.activationId):Promise<TraceOutcome>
Parameters
activationId
ActivationId
Returns
Promise<TraceOutcome>
submitActivationAndWait()
submitActivationAndWait(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:374 Submits a pre-signed activation and waits for the terminal result event.activation):Promise<TraceOutcome>
Parameters
activation
GenExternalActivation
Returns
Promise<TraceOutcome>
signAndSubmitActivationAndWait()
signAndSubmitActivationAndWait(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:381 Signs, submits, and waits for the terminal result event.signer,payload,options?):Promise<TraceOutcome>
Parameters
signer
EddsaSigner
payload
ActivationPayload
options?
ActivationOptionsInit
Returns
Promise<TraceOutcome>
createAccount()
createAccount(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:394 Submits the built-in account creation flow using the faucet signer.account):Promise<ActivationId>
Parameters
account
GvmAccount
Returns
Promise<ActivationId>
faucet()
faucet(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:404 Submits the built-in faucet transfer flow using the faucet signer.account,amount,options?):Promise<ActivationId>
Parameters
account
GvmAccount
amount
bigint
options?
FaucetTransferOptionsInit = {}
Returns
Promise<ActivationId>
view()
view(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:419 Executes a read-only activation and returns the raw response bytes.payload):Promise<Uint8Array<ArrayBufferLike>>
Parameters
payload
ViewPayload
Returns
Promise<Uint8Array<ArrayBufferLike>>
simulateActivation()
simulateActivation(Defined in: metacomputer/gen-framework/client-and-test-utils/client-sdk-ts/packages/client-sdk/src/client.ts:432 Simulates an activation without submitting it to the chain.payload,signerPublicKey,blockIndex?,options?):Promise<SimulateActivationResponse>
Parameters
payload
ActivationPayload
signerPublicKey
GenPublicKey
blockIndex?
string | number | bigint
options?
ActivationOptionsInit
Returns
Promise<SimulateActivationResponse>