@proto-kit/common • Docs
Documentation / @proto-kit/common / ProvableMethodExecutionContext
Class: ProvableMethodExecutionContext
Execution context used to wrap runtime module methods, allowing them to post relevant information (such as execution status) into the context without any unnecessary ‘prop drilling’.
Extended by
Constructors
new ProvableMethodExecutionContext()
new ProvableMethodExecutionContext():
ProvableMethodExecutionContext
Returns
ProvableMethodExecutionContext
Properties
id
id:
string
Defined in
packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:54
methods
methods:
string[] =[]
Defined in
packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:56
result
result:
ProvableMethodExecutionResult
Defined in
packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:58
Accessors
isFinished
Get Signature
get isFinished():
boolean
Returns
boolean
Defined in
packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:107
isTopLevel
Get Signature
get isTopLevel():
boolean
Returns
boolean
Defined in
packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:103
Methods
afterMethod()
afterMethod():
void
Removes the latest method from the execution context stack, keeping track of the amount of ‘unfinished’ methods. Allowing for the context to distinguish between top-level and nested method calls.
Returns
void
Defined in
packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:99
beforeMethod()
beforeMethod(
moduleName,methodName,args):void
Adds a method to the method execution stack, reseting the execution context in a case a new top-level (non nested) method call is made.
Parameters
• moduleName: string
• methodName: string
Name of the method being captured in the context
• args: ArgumentTypes
Returns
void
Defined in
packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:79
clear()
clear():
void
Manually clears/resets the execution context
Returns
void
Defined in
packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:124
current()
current():
object
Returns
object
- Current execution context state
isFinished
isFinished:
boolean
result
result:
ProvableMethodExecutionResult
Defined in
packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:114
setProver()
setProver(
prover):void
Adds a method prover to the current execution context, which can be collected and ran asynchronously at a later point in time.
Parameters
• prover
Returns
void
Defined in
packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:69